标点符合
标点符号原则(1)中文语句的标点符号,均应该采取全角符号,这样可以与全角文字保持视觉的一致。
(2)如果整句为英文,则该句使用英文/半角标点。
(3)句号、问号、叹号、逗号、顿号、分号和冒号不得出现在一行之首。
(4)点号(句号、逗号、顿号、分号、冒号)不得出现在标题的末尾,而标号(引号、括号、破折号、省略号、书名号、着重号、间隔号、叹号、问号)可以。
句号(1)中文语句的结尾处应该用全角句号(。)。
(2)句子末尾用括号加注时,句号应在括号之外。
123错误:关于文件的输出,请参照第 1.3 节(见第 26 页。)正确:关于文件的输出,请参照第 1.3 节(见第 26 页)。
逗号(1)逗号(,)表示句子内部的一般性停顿。
(2)注意避免“一逗到底”,即整个段落除了结尾,全部停顿都使用逗号。
顿号(1)句子内部的并列词,应该用全角顿号(、) 分隔,而不用逗号,即使并列词是英语也是如此。
123错误:我最欣赏的科技公司有 Google, Facebook, 腾讯, 阿里和百度等。正确:我最欣赏的科技公司有 Google、Facebook、腾讯、阿里和百度等。
(2)英文句 ...
文档体系
文档体系结构软件手册是一部完整的书,建议采用下面的结构。
简介(Introduction): [必备] [文件] 提供对产品和文档本身的总体的、扼要的说明
快速上手(Getting Started):[可选] [文件] 如何最快速地使用产品
入门篇(Basics): [必备] [目录] 又称“使用篇”,提供初级的使用教程
环境准备(Prerequisite):[必备] [文件] 软件使用需要满足的前置条件
安装(Installation):[可选] [文件] 软件的安装方法
设置(Configuration):[必备] [文件] 软件的设置
进阶篇(Advanced):[可选] [目录] 又称“开发篇”,提供中高级的开发教程
API(Reference):[可选] [目录|文件] 软件 API 的逐一介绍
FAQ:[可选] [文件] 常见问题解答
附录(Appendix):[可选] [目录] 不属于教程本身、但对阅读教程有帮助的内容
Glossary:[可选] [文件] 名词解释
Recipes:[可选] [文件] 最佳实践
Troubleshooting:[可选] [文件] 故 ...
其他参考链接
其他参考链接
产品手册中文写作规范, by 华为
写作规范和格式规范, by DaoCloud
技术写作技巧在日汉翻译中的应用, by 刘方
简体中文规范指南, by lengoo
文档风格指南, by LeanCloud
豌豆荚文案风格指南, by 豌豆荚
中文文案排版指北, by sparanoid
中文排版需求, by W3C
为什么文件名要小写?, by 阮一峰
Google Developer Documentation Style Guide, by Google
出版物上数字用法的规定(国家标准GBT15835-2011)
GB 3100-1993 国际单位制及其应用