美文网首页
文档写作规范

文档写作规范

作者: 四喜汤圆 | 来源:发表于2019-03-27 21:25 被阅读0次

没有规矩不成方圆,同样,写作没有规范容易产生混乱。约定好形式上的规范后,才能更加肆意地进行内容创作。

一、标题

  • 一级标题:为题目
  • 二级标题
  • 三级标题
  • 一般不用四级标题
# 一级标题

## 二级标题

### 三级标题
**(1)A**

**(2)B**

**(3)C**

二、文本

(1)全角中文字符与半角英文字符之间,应有一个半角空格。

错误:本文介绍如何快速启动Windows系统。

正确:本文介绍如何快速启动 Windows 系统。

(2)全角中文字符与半角阿拉伯数字之间,有没有半角空格都可,但必须保证风格统一,不能两种风格混杂。

正确:2011年5月15日,我订购了5台笔记本电脑与10台平板电脑。

正确:2011 年 5 月 15 日,我订购了 5 台笔记本电脑与 10 台平板电脑。
半角的百分号,视同阿拉伯数字。

正确:今年我国经济增长率是6.5%。

正确:今年我国经济增长率是 6.5%。

(3)英文单位若不翻译,单位前的阿拉伯数字与单位间不留空格。

错误:一部容量为 16 GB 的智能手机

正确:一部容量为 16GB 的智能手机

(4)半角英文字符和半角阿拉伯数字,与全角标点符号之间不留空格。

错误:他的电脑是 MacBook Air 。

正确:他的电脑是 MacBook Air。

三、文档结构

主要分为前言核心内容总结

四、文件名命名

(1)不得含有空格
文档的文件名不得含有空格。

(2)不得包含中文
文件名必须使用半角字符,不得使用全角字符。这也意味着,中文不能用于文件名。

错误: 名词解释.md

正确: glossary.md

(3)只用小写字母
文件名建议只使用小写字母,不使用大写字母。

错误:TroubleShooting.md

正确:troubleshooting.md 

为了醒目,某些说明文件的文件名,可以使用大写字母,比如README、LICENSE

(4)文件名中包含多个单词时,用 - 分割
文件名包含多个单词时,单词之间建议使用半角的连词线(-)分隔

不佳:advanced_usage.md

正确:advanced-usage.md

五、总结

参考阮一峰老师的写作规范

相关文章

  • 文档写作规范

    没有规矩不成方圆,同样,写作没有规范容易产生混乱。约定好形式上的规范后,才能更加肆意地进行内容创作。 一、标题 一...

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

    第100期:阮一峰:中文技术文档的写作规范 深度讨论 阮一峰:中文技术文档的写作规范 代码写得好,技术文档也非常重...

  • 开发文档写作规范

    中文文案排版指北 中文技术文档的写作规范

  • 【文档】中文技术文档的写作规范

    JERRY 中文技术文档的写作规范https://gitee.com/JERRY-Z-J-R/document-s...

  • 文档写作规范 | 团队建设

    大纲 回顾 17 年,文档写作泛滥、深度不足 重申文档写作的必要性 文档标题格式 文档迭代更新 文档上线 回顾 1...

  • 中文技术文档写作规范

    本文转载自阮一峰 标题 正文 段落 数值 标点符号 文档体系 参考链接

  • 技术文档写作规范(Markdown)

    1.标题 1.1层级 标题分为四级。 一级标题:文章的标题 二级标题:文章主要部分的大标题 三级标题:二级标题下面...

  • PRD文档入门指引

    引子 这篇入门指引适合与不是特别了解PRD文档写作规范和写作要求的初级(或中级?)产品经理以及其他需要写PRD文档...

  • PRD文档模板

    结合自己的一些经验和网上一些文档模板,做的一个PRD文档模板。规范自己以后文档写作。 ...

  • 中文技术文档的写作规范

    本文来自: ruanyf/document-style-guide 中文技术文档的写作规范。 标题 层级 标题分为...

网友评论

      本文标题:文档写作规范

      本文链接:https://www.haomeiwen.com/subject/wclovqtx.html