说明

说明#

目的

  • 提高中文文案的可读性

  • 统一文档风格,保证公司对外输出形象一致

  • 避免不同的文档作者对同一问题反复作出决策,降低与文档相关的沟通成本

适用范围

  • 为编写中文文档的作者提供规范指导或建议

  • 审校文档过程中争议问题的裁决

  • 也可供软件界面、帮助文档等资料开发人员参考

使用原则

建议初次阅读本指南时,先大致浏览目录章节结构,了解本指南涵盖的内容范围;之后就编写文档时碰到的实际问题,再回头查找相应规范。

用词说明

本指南使用的表示“要求”的全部关键词已在下表第二列列出,具体释义请参见 RFC2119 对相应词语做出的相关规定:

RFC2119 中定义的关键词

对应的中文关键词

释义说明

MUST/REQUIRED/SHALL

强制/必须/务必/只能

强制性规则,表示绝对要求这样做

MUST NOT/SHALL NOT

禁止/不能/不要

强制性规则,表示绝对禁止这样做

SHOULD/RECOMMENDED

应/应当/应该/建议/推荐

非强制性规则,表示一般情况下应该这样做,但在知悉全部后果的前提下,可以选择不这样做

SHOULD NOT/NOT RECOMMENDED

不应当/不应该/不建议/不推荐

非强制性规则,表示一般情况下不应该这样做,但在知悉全部后果的前提下,可以选择这样做

MAY/OPTIONAL

可以/可选

非强制性规则,表示这个要求是可选的,可以这样做,也可以不这样做

RFC (Request For Comments) 指关于互联网标准的正式文件,在这些文件的表述过程中,必须严格区分哪些是"建议" (suggestion),哪些是"要求" (requirement)。所以,RFC2119 专门对五个关键词的涵义作出了规定,分别表示"要求"的严格程度。