流程式内容帮助用户在使用 GitHub 时完成一项任务的整个过程。
我们创建流程式文章以及较长文章内的流程式部分。
如何撰写流程式文章
有关流程式内容模板,请参阅“模板”。
- 请遵循“样式指南”中关于流程式步骤的样式指南。
- 流程式内容可能会重复——寻找机会将相关内容组合到一篇较长的文章中。
- 将多个相关的流程组合到一篇文章中,除非有理由不这样做。
- 如果禁用设置或撤消任务需要相同的步骤且没有特殊含义,则无需编写单独的流程。
- 如果禁用设置或撤消任务需要不同的步骤或具有重要或特殊的含义,请创建一篇较长的文章来包含这两个流程。使用通用的标题。
- 告知读者流程的预期结果。
- 尽可能多地包含故障排除提示。
流程式内容的标题
- 文章中的流程式文章或流程式部分基于任务,并以动名词开头。
- 使用:“申请学生开发者套装”
- 使用主动语态和具体的动词(如有需要,可以进行头脑风暴或使用同义词词典)。
- 标题具体描述文章或标题中包含的任务,但又足够通用,可以反映所有内容。
- 文章标题长度:最多 80 个字符,如果可能,则为 60 个字符。