中文技术文档写作规范（汇总整理版）

前言：规范文档的好处，其一增加文档易读性，其二体现个人专业性

只使用一二三级标题，三级标题下面的并列性内容使用列表展示
二级标题前使用行分隔符表示分隔
段落之间使用一个空行隔开
一句话或者以逗号分隔的句子，长度尽量保持在 20 个字以内，20～29 个字的句子，可以接受
禁止文字口语化
尽量使用肯定句表达，不使用否定句表达（例如：没有、不能、不可以）
不使用“被”
技术名词大小写拼写正确，比如正确的拼写：Java、JavaScript、MySQL
第一次出现英文词汇时，在括号中给出中文标注【例如：IOC（International Olympic Committee，国际奥林匹克委员会）】
引号里面还要用引号时，外面一层用双引号，里面一层用单引号
句子末尾用括号加注释时，句号应在括号后面（例如）。
中文字符和英文、数字之间保持一个空格，其他符号无需空格
数字和英文单位之间保留一个空格（如 10 kg）
对于四位以上的数值，应添加千分号（如 1,200,000 元）
数值范围（例如日期、时间或数字）应该使用波浪连接号（～）或一字号（—），波浪连接号前后两个值都建议加上单位（如 10 kg~20 kg 或者中文格式 -20 °C 至 -10 °C）
使用外部图片时，必须在图片下方标明来源（例如：图片来源 CSDN | PANDA）
引用第三方内容时，应在文末标明，并链接至原文
文件名尽量只使用英文小写，不得使用大写字母，除非是某些说明文件，比如 README.md

参考链接

中文技术文档的写作规范 | 阮一峰

中文技术文档写作规范（汇总整理版）相关推荐

中文技术文档写作规范【转载】
标题层级标题分为四级. 一级标题:文章的标题二级标题:文章主要部分的大标题三级标题:二级标题下面一级的小标题四级标题:三级标题下面某一方面的小标题原则一级标题下,不能直接出现三级标题. ...
中文技术文档的规范-标点符号
标点符号原则 (1)中文语句的标点符号,均应该采取全角符号,这样可以与全角文字保持视觉的一致. (2)如果整句为英文,则该句使用英文/半角标点. (3)句号.问号.叹号.逗号.顿号.分号和冒号不得出 ...
技术文档写作风格指南
技术文档写作风格指南整理了一些技术文档的写作指南与大家分享,希望每一份优秀的代码都有一份比之更优秀的文档. 1.谷歌开发者文档风格指南官网: https://developers.google.c ...
【中文技术文档的写作规范_P03】如何书写标点符号和控制文档体系
通过本文,你将了解到中文技术文档中标点符号和文档体系的写法. 文章目录标点符号原则句号逗号顿号分号引号括号冒号省略号感叹号破折号连接号文档体系结构文件名标点符号原则 ...
Atitit usrQBK1600 技术文档的规范标准化解决方案
Atitit usrQBK1600 技术文档的规范标准化解决方案 1.1. Keyword关键词..展关键词,横向拓展比较,纵向抽象细化拓展知识点1 1.2. 标题必须有高大上词汇,参考文章排行榜,1 ...
技术文档写作的职业探讨
转自 http://blog.csdn.net/u014309159/article/details/44904425 原文链接:http://blog.tianya.cn/blogger/post_ ...
SAP HANA中文技术文档(跟matinal学HANA)
SAP HANA中文技术文档(跟matinal学HANA) 1. 点击进入:SAP XS HANA专栏 2. 点击进入:SAP UI5上传图片用XSJS存储在HANA中的方法 3. 点击进入: ...
技术文档写作基础-写作新手必看
文章目录 1 搞清楚主谓宾 2 不滥用代词.过渡词和标点符号 2.1 不滥用代词和过渡词 2.2 不滥用标点符号 3 多用强势动词,少用形容词和副词 3.1 强势动词和主动语句 3.2 少用形容词和副 ...
virtualbox中文技术文档_随笔--西门子STEP7中如何寻找技术文档
西门子STEP7软件支持的编程语言除了常用的LAD/FBD/STL,还有SCL/GRAPH等,应该说除了LAD/STL之外,SCL和GRAPH也是比较常用的,至少对我个人来说是这样,但是每种指令在不同 ...
中文技术文档的写作规范
文章目录一.标点符号原则句号逗号顿号分号引号括号冒号省略号感叹号破折号连接号二.数值半角数字千分号货币数值范围变化程度的表示法三.段落原则引用四.参考链接 ...

中文技术文档写作规范（汇总整理版）

参考链接

中文技术文档写作规范（汇总整理版）相关推荐

最新文章

热门文章