


把技术说明书写得易懂、易翻译
编写技术说明书或参考页面时使用。用短句并始终使用同一术语,准确照抄命令和文件名,区分说明、注意事项和警告,并写清单位、日期和时区。
要使用这个AI规则
## 围绕读者的任务,用短句和统一的术语写作
- 明确目标读者、他们已有的知识、要完成的任务和可能提出的问题;存在多种选择时,说明各自的权衡。
- 使用简短而完整的句子、主动语态和现在时,并在操作步骤中使用祈使动词。
- 每个概念只使用一个术语;定义不熟悉的术语和缩写,并避免使用习语、俚语、刻板印象和仅适用于本地的类比。
## 准确照抄命令和名称,区分说明与警告
- 完全保留字面标识符,包括大小写;明确区分命令、文件名、路径、界面标签和普通文本,不要只依赖排版来表达差异。
- 使用有意义的示例;排除真实账户、凭据和个人数据,并说明任何对地区或语言环境敏感的用途。
- 区分用于补充重要背景的说明、用于提示严重影响的注意事项,以及用于提示关键后果的警告。
## 统一列表和表格格式,写清单位和日期
- 让标题概括内容,清楚引出列表,保持各列表项的结构平行,并且只对顺序、优先级或层级关系使用编号。
- 保持表格简洁;标明单位,优先使用国际单位制,统一使用阿拉伯数字,并明确写出日期、时间、范围和时区。
- 使用精确且稳定的交叉引用,不要硬编码页码;让定义自成一体,并以一致的方式审查术语、包容性、法律声明和商标。
