文档写作规范 | 团队建设

大纲

文档泛滥体现在：同一主题创建多个文档、同一题目创建多个文档、甚至同一内容补充更新时也创建了多个文档，经常出现的现象就是一个功能点每个人都只写了自己所涉及到的一方面，项目文件夹内的文档太多反而不方便查询信息。

单方面的思考为什么会出现这类情况：

文档写作深度不足体现在：不理解 markdown 存在的意义，笔记中会出现各种颜色、种类的字体；甚至基本的 markdown 语法错误随处可见；文档主题表达的完整性；迭代更新的后续动力。

markdown 是纯文本写作，拷贝内容至印象笔记中时请忽略样式，ctl/command + shift + v, 需要样式时请使用 markdown 语法表达。

所有文档共同具有的特性：

统一文档标题格式：主题名称 - 文档标题

已经在使用的主题名称：

可以根据需要自定义主题名称，符合标题格式即可。有更佳的标题格式欢迎交流讨论。

文档之所以会泛滥，就是不懂得迭代更新文档。

做好迭代更新就要坚持对主题名称及文档主旨，相同的主题及主旨已存在，自然就应该去更新已存在的文档；

什么时候去更新已存在的文档，什么时候去创建新的主题文档，这个火候没有明确定义，可以清晰的表述出自己的理解就可以。

盲目、随意的创建文档要点名批评，希望新的一年，文档数量不用太多，多关注内容深度。

功能稳定后，技术文档、培训文档主题表述清晰，有助于客户、新同事理解产品的特性，都会吸纳到在线 gitbook 中；

文档的数量与质量已经成为考核团队成员的评判依据之一，避免性格内向的同事被忽略或低估了他们的工作成果。