软件技术文档标准
作为一个部门经理，在人事部的协助下，我开始制定技术文档标准，在Post not found: 软件及文档开发规范 软件及文档开发规范 一文中，我简单的介绍了博客的编写规范，这里再次的细化一下。
技术文档作为开发文档之外的另外一种重要的交流形式，简洁易懂、条理清晰、文笔通畅，方便交流，是最重要的。
【1】.软件设计和开发规范(国标) 这里有百度网盘链接，有多个文件。
【2】.第 7 部分：软件开发过程规范 下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。
1.文档格式
文档以markdown格式编写，语法应符合markdown语法，文档的后缀为.md，并加入版本管理。
2.文档命名
技术文章的命名应有特定的含义，一般为本篇文章的主题，让人一眼看出文章内容为宜。一篇文章中，有多个主题，则需要进行汇总和总结。
3.图片存放
一篇文章如果有图片，需在文章同级目录下新建文章同名的文件夹，其内放和此文章有关的图片。错误示范：
这里的文档文件名丝毫没有意义和主题，我推荐是以主题的名字命名文档，而不是用日期的方式，比如：”git软件操作指南.md”，这种文章一般人都知道在写些什么，多篇主题，就分割为多篇文章。而且文章相关的图片都放在了一个文件夹下，如果文章数特别大的情况下，图片变得非常的难以管理。
md文章，附带一个同名文件夹的方式也是借鉴了hexo生成静态博客网站的做法。比如我存放文档的文件夹名叫bibichuan_document,该文件夹下有个多篇md文件，也有多个和md文件同名的文件夹，其中存放的是该md文件相关的图片。hexo中使用:hexo new psot “文章名” 在生成文章的时候，就是生成了一篇 <文章名.md> 以及同名文件夹，放在同一目录下。markdown中嵌入图片时，以相对目录的形式嵌入。
4.内容标题
技术文档的编写要条理清楚，章节分类要合理。
5.参考文章
解决任何一个问题，或者编写任何一个文章，都不可能是完全独立自主的创造，或多或少的都会借鉴别人的思想或者方法，所以在编写文章的时候就一定要写参考文章。参考文章的格式，使用markdown嵌入网址的形式。
1 |
|
这样在阅读起来就类似于：
在网站上就可以通过参考文章进入相应的页面，而且简洁。编写参考文章，可以是在文章的最后，也可以是在每一个大标题下，或者小标题下，只要能区分开就好了。
编写一篇好的，排版清晰的，能让人一下子读的懂的文章，也是一种能力。
6.文档质量控制
文档要有一定的质量，不得完全从网上复制粘贴原有内容，形成自己的文档，要经过自己的思考和加工，并提出自己的见解。文章的类型主要分为以下几种：
(1) 学习类文章
此类文章主要是学习笔记的形式提供，此类文章大多参考网上的教程和方法，做一个简单的记录，此时只需记录参考文章及简单的描述学习内容即可，不得完全粘贴和复制原有内容，多个相关的学习内容可以汇总到一起，比如git学习笔记、echart学习笔记。
(2) 探索类文章
此类文章没有现有模板可循，主要记录课题的研究过程，可分别列举现有的技术和课题相关的文章方法或思路，对现有的解决方案进行提炼和总结，列出其优缺点，最后总结和提炼处自己对课题的看法和思路。
(3) 问题类文章
此类文章作为问题解决的过程记录，应该详细记录问题解决的步骤。比如解决一个别人没有遇到的问题，需要将自己尝试的过程一步一步的记录下来，必要时附上问题出现的截图以及最后解决之后的截图。
