跳转到内容
搜索文档

步骤/任务/程序

最后更新 查看 MarkdownAgent 设置

定义

面向行动的流程,概述要采取的步骤以及执行这些步骤的顺序。

适用于

操作指南教程

结构

单步骤程序:当程序仅由一个步骤组成时,将该步骤加入到引导句中。

编号程序中的子步骤:在编号程序中,子步骤应使用小写字母,子步骤的子步骤(次级子步骤)使用小写罗马数字。

  • 当步骤有子步骤时,将该步骤视为引导句。在适当的地方,在步骤末尾加上冒号或句号。

多操作程序:每个操作使用一个步骤。不过,您可以将多个微小操作合并为一个步骤。

同一任务的多个程序:如果完成一项任务有多种方法,请选择一种对所有用户都无障碍的程序进行记录。如果所有程序都需要记录,请使用不同的标题、页面或标签页来区分它们,以便读者清楚地知道这是完成同一任务的另一种方法。

以下指南可以帮助您选择要记录的程序:

  • 选择允许读者仅使用键盘即可完成所有步骤的程序。
  • 选择最短的程序。
  • 选择使用大多数受众熟悉的编程语言的程序。

重复性程序:使用简洁的程序,避免重复,并防止大量加粗的 UI 元素让用户应接不暇。

项目符号与编号列表

后续要求(Post requisites):目前不使用。如果您觉得需要一个后续要求部分,请考虑将该任务作为程序的最后一步,或将内容移至“后续步骤”中。

编写程序的指南

如果用户第一步必须登录到仪表板,请将登录和导航合并到第一步中。此外,请写“log in to”(三个单词)而不是“log into”。

如果用户在某一步骤后必须按 Enter 键,请将该说明作为该步骤的一部分包含进去。

如果用户需要开启或关闭某项设置,请使用“turn <FEATURE_NAME> on/off”(开启/关闭 <FEATURE_NAME>)——或者对于名称较长的功能使用“turn on/off <FEATURE_NAME>”——而不是“enable/disable”。

在陈述操作之前先陈述操作的目的。

按照读者需要遵循的顺序编写。在陈述操作之前先陈述操作的位置。如果有一组程序与多个标题相关联,请在每个程序的第一步中重新说明操作的位置,即使该位置与前一个程序中的相同。

不要使用“please”(请)。

其他信息

使用完整的句子。

使用平行结构。

使用第二人称命令式。请参考《风格指南》,获取何时使用特定动词(click、select、choose 等)的指导。

对于可选步骤,将 (Optional)(可选)作为步骤的第一个词。

  • 例如:(Optional) Type an arbitrary string, to be delivered to the target address with each notification delivered over this channel.

请勿包含键盘快捷键。

请勿使用方向性语言来引导读者,例如“以上”、“以下”或“右侧”。这类语言对无障碍性或本地化没有好处。如果某个 UI 元素很难找到,请提供屏幕截图。

明智地使用类似于“The <screen/page/card> displays.”(显示 <屏幕/页面/卡片>)的句子。

这篇文档对您有帮助吗?