3.1 句式要求
技术文档中的句式应简洁、清晰、准确。
R-030
推荐
使用主动语态
技术文档应优先使用主动语态,使表述更加直接和清晰。被动语态仅在强调动作承受者或动作执行者未知时使用。
正确
系统将自动保存您的更改。
错误
您的更改将被系统自动保存。
主动语态更加直接,读者可以更快地理解谁在执行操作。
R-031
推荐
每句话只表达一个意思
避免在一个句子中包含多层含义或多个操作步骤。长句应拆分为多个短句。建议每个句子不超过 40 个字。
正确
单击「设置」按钮。在弹出的对话框中,输入服务器地址。单击「确定」保存设置。
错误
单击「设置」按钮后在弹出的对话框中输入服务器地址然后单击「确定」保存设置。
将操作步骤拆分为独立的句子,每句描述一个动作,更便于读者理解和跟随。
技巧
如果一个段落超过了 5 句话,考虑是否可以将其拆分为多个段落或使用列表来组织信息。