5.1.1 手册更新规范
<p>[TOC]</p>
<pre><code> 功能介绍：
每篇文档开头必须有类似本样式的文章介绍，目的了为了能简单概述一下此功能的作用与应用。
例如：本分是介绍了手册更新的规范，使功能介绍看起来美观并且用户方便查阅学习；
例如介绍新员工入职：新员工入职模块是进行新员工入职操作以及查询新员工入职的明细模块，企业有新员工入职，就需要进入到此模块进行员工的添加。</code></pre>
<h3>1.标题命名规范</h3>
<p>  每个标题目录命名必须增加对应的序列号，以保证在未来手册逐步的更新中，能清晰对应并且定位对应目录；比如我写的手册更新规范属于《5.1更新规范》之下，所以我的命名为《5.1.1 手册更新规范》，表示为5.1目录下的第一篇文章。</p>
<center>[](http://qiniuyun.wangylblog.com/小书匠/1595932282625.png)</center>
<h3>2.内容描述规范</h3>
<h4>2.1 增加目录</h4>
<p>  每份说明在创建之初，需要增加目录，方便所有查询文档的人员可以直接定位到想看的具体位置，最开头点击TOC即可。</p>
<h4>2.2 增加标题</h4>
<p>  每份说明都必须有标题顺序和序列，为了符合美观，标题最大号为H3，然后依次类推往后区分，标题的展示必须要美观，清晰。
  例如我的《2.内容规范描述》为H3标题，《2.2 增加标题》为H4标题，这样就形成类似上方的展示内容，使文档看起来更清晰。</p>
<center>[](http://qiniuyun.wangylblog.com/小书匠/1595932410994.png)</center>
<h4>2.3 功能介绍</h4>
<p>  每篇文章功能都必须增加功能描述，例如本文上方。功能描述的主要目的是介绍此功能或者问题的概括，使使用大概能了解到本文主要是讲解什么内容。</p>
<h4>2.4 段落清晰</h4>
<p>  每个段落开始都需要隔开两个空格，文章看起来更优美；（当然在进行长篇文字描述的时候，增加段落不方便，可以忽略）</p>
<h4>2.5 善用工具</h4>
<p>  每篇文档的布局是最复杂的，但是我们也追求的为简约，所以无法过度花哨，只要清晰简约即可，可以了解学习一下（本文的工具）：<a href="https://sspai.com/post/25137">https://sspai.com/post/25137</a></p>
<h3>3.文档署名</h3>
<p>  拟定说明文档不乏味，能让更多的人认识你，体现个人价值，展示实力与才华，每篇文章末尾都增加署名，并且写一句自己很喜欢的话语，可以是真名，可以是昵称，给文章增加一些趣味性；如文本末尾。</p>
<h4>4.图片上传</h4>
<p>  为了保证上传图片的清晰度与指令问题，图片进行外链，也就是七牛云中，为了操作方便，借用别的工具完成，连接：<a href="http://markdown.xiaoshujiang.com/" title="小书匠">小书匠</a>。图片复制到对应的文档中，小书匠会自动生成外链图片，如下图</p>
<center>[](http://qiniuyun.wangylblog.com/小书匠/1595931922108.png)</center>
<p>  然后在编辑器中点击添加图片，把链接放入即可。切记，HTTP:// 需要保留。</p>
<hr />
<table>
<thead>
<tr>
<th style="text-align: center;">修订日期</th>
<th style="text-align: center;">修订版本</th>
<th style="text-align: center;">修订内容</th>
<th style="text-align: center;">更新人员</th>
<th style="text-align: center;">一句话</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">2020-7-22</td>
<td style="text-align: center;">v1.0</td>
<td style="text-align: center;">初版</td>
<td style="text-align: center;">王小布</td>
<td style="text-align: center;">也许不久，一个牛逼客户售后文档问世</td>
</tr>
<tr>
<td style="text-align: center;">2020-7-28</td>
<td style="text-align: center;">v1.1</td>
<td style="text-align: center;">增加图片上传标准</td>
<td style="text-align: center;">王小布</td>
<td style="text-align: center;">假如我们拥有的东西只能给我们造成烦恼，那么我们拥有它的意义就值得怀疑。</td>
</tr>
</tbody>
</table>