针对编写的一系列技术文档,应提供相应的术语表和缩略语表作为附录资料,方便读者查阅。
同时,根据技术文档发布平台的不同,应在阅读文档的醒目处提示读者有关文档的侵权说明、商标说明等信息。
参考资料
Google Developer Documentation Style Guide
Requirements for Chinese Text Layout 中文排版需求
正确使用 Tab 和空格:
数字:
- 《出版物上数字用法》GB/T 15835—2011
- 《出版物上数字用法的规定》GB/T 15835—1995
标点符号:
- 《标点符号用法》GB/T 15834—2011
- 《夹用英文的中文文本的标点符号用法(草案)》
- 易混标点符号:一字线(—)、短横线(-)、浪纹线(~)
列表:
引号:
为什么在知乎上表引用时,用直角引号(「」)而不是弯引号(“”)?
顿号:
语言文字:
《常见语言文字错误防范手册》. 周奇主编. 北京: 中国标准出版社, 2010.