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