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