2.2 产品名称
规范产品名称在技术文档中的书写方式。
R-010
必须
产品名称首次出现时使用全称
产品名称在文档中首次出现时,必须使用完整的官方名称。后续出现可以使用缩写,但需在首次出现时注明缩写形式。
正确
中国技术传播共同体(CTCA)致力于推动行业标准化。随后可直接使用 CTCA。
错误
CTCA 致力于推动行业标准化。(首次出现即使用缩写)
首次使用全称并括号注明缩写,有助于读者理解上下文。
技巧
如果文档篇幅较长(超过 20 页),建议在每个主要章节开头重新引入一次产品全称。
R-011
必须
产品名称不可随意翻译
外文产品名称应保留原文,不要自行翻译。如果需要中文说明,应在产品名后括号加注。例如:使用「Kubernetes」而非「库伯内特斯」。