任务

用户可以用您的项目做什么?

这是一个占位页面,将其替换为您自己的内容。

考虑您的项目的功能和用例,使用这些来选择您的核心任务,每个用例(启用 x、配置 y)应具有相应的任务页面或任务页面段落。当用户需要了解如何做一件特定的事情时,他们应该能够快速参考您的核心任务,而不必在更大的教程或示例中寻找说明。将您的任务页面视为一本专题手册,其中包含不同的过程,您的用户可以组合起来创建更充实的内容。

您可以为每个任务提供一个页面,也可以将相关任务分组在一个页面中,例如与特定功能相关的任务。除了将相关任务分组到单个页面中之外,您还可以将任务页面分组到嵌套文件夹中,并以索引页作为概述,如本示例网站所示。或者,如果您有一个小型文档集,例如没有教程或概念页面的 Docsy User Guide,请考虑在文档的顶层而不是任务部分添加特定于功能的页面。

每个任务应该告知用户

  • 此任务的先决条件(如果有)(如果所有页面的任务都相同,则可以在多任务页面的顶部指定。“所有这些任务都假设您了解……并且您已经…… .”)。
  • 这个任务要完成什么。
  • 任务说明。 如果涉及编辑文件、运行命令或编写代码,请提供代码格式的示例片段来向用户展示该怎么做! 如果有多个步骤,请以编号列表的形式提供它们。
  • 如果可以,链接到相关概念、教程或示例页面。

任务 1

任务1

任务2

任务2


最后修改 September 28, 2023: CNAME (6d58236)