菜单
开源
上次审阅:2024 年 6 月 7 日

任务主题

任务主题包含带编号的步骤,描述了如何实现某个结果。

任务结构

任务主题包含以下元素

  • 主题标题:撰写结合动词和宾语的任务主题标题。

  • 引言:提供一个引言,解释终端用户为何应关注该任务。

    任务主题的本节可能包含概念性材料。将概念信息限制在仅与当前任务相关的内容。

    如果您发现自己撰写了冗长的引言,请考虑创建一个概念主题,然后在任务引言中撰写该概念的较短形式。您可以从本引言链接到较长的概念主题。

  • 开始之前:(可选)添加指向需要在当前任务之前完成的任务的链接。链接有时可能与产品无关,例如“准备好这个东西”。

    此外,本节可以包含用户在开始任务之前应做出的决定或需要确认的权限。

    如果没有前提条件,请不要包含本节。

  • 步骤标题:步骤标题表示步骤即将开始。

  • 引导句:引导句介绍步骤。

    撰写引导句时,请遵循以下约定:要<任务名称>,请按照以下步骤操作:例如:要创建仪表盘,请按照以下步骤操作

    有关引导句的更多信息,请参阅 Google 开发者文档风格指南 中的 Procedures(步骤)

  • 步骤:通过带编号的步骤向用户提供指示。

    撰写步骤时,使其包含一个操作,或者可能包含两个相关的操作,例如 复制并粘贴值保存并退出程序。

    一个步骤必须指示读者执行特定的任务。

Annotated example of a task page's structure

撰写任务主题

要撰写任务,请按照以下步骤操作

  1. 确定要将任务文档添加到 Grafana Labs 产品文档的何处。

  2. 在父目录中创建一个遵循此命名约定的子目录

    • 目录名称应包含动词和宾语。
    • 使用小写字母。
    • 在单词之间添加连字符。
  3. 在任务目录中创建 index.md 文件。

  4. index 文件添加 front matter。

    有关 front matter 的更多信息,请参阅 Front matter

  5. 将内容添加到 任务模板 的副本中。

任务主题示例

请参阅以下主题以获取任务主题示例

任务模板

准备好写作时,请复制 任务模板 并添加您的内容。

何时将任务合并到单个主题中

在某些情况下,任务主题是独立的,不包含任何其他内容。其他时候,多个任务主题可以合并到一个 Markdown 文件中。将任务合并到单个主题中,可以减少目录中的条目数量,从而减少用户的滚动和点击。

注意

不建议在同一 Markdown 文件中随意组合内容。如果组合不当,可能会无意中向用户隐藏信息。

将多个主题合并为一个时,请遵循以下指南

  • 当您记录实现相同用户目标的多种方法时。

    分配 RBAC 角色主题中,用户可以使用用户界面或供应来分配角色。在这种情况下,无需创建两个任务主题文件。

  • 当任务很可能在大约同一时间完成时。

    如果用户很可能同时完成多个任务,他们可能会觉得在同一页面上提供所有任务文档很有用。

    数据源管理主题中,Admin 用户很可能在添加数据源后立即启用权限。

  • 当您记录 CRUD 操作时。

    创建、读取、更新和删除任务可以合并到一个主题中。管理组织主题包含查看、创建、编辑和删除组织等任务,所有这些都包含在管理的总主题标题下。

  • 当您记录用户工作流程时。

    当用户应从头开始,完成第一个任务,然后按顺序完成其余任务时,请合并任务。

    从 EKS 上的 AWS Marketplace 激活 Grafana Enterprise 许可中,引导用户完成激活许可所需的所有任务。