你知道研发的文档有多少种吗？

这篇继续讲文档能力。

文档能力是研发人员必备技能，有时候涉及到的文字沟通，比如邮件沟通等，都需要文档加以辅助说明，那么这时就需要好好设计文档的内容了。有些同学文档内容写的很随意，一眼看上去不知道在讲什么。这时就要用到文档的结构了。你设计的结构要通俗易懂，条理清晰。

但是不同的文档，结构也是不一样的，从整体上区分，分为：

 

编码规范

上次我们已经展开聊了，主要就是写代码时与团队之间的一些规章制度，这样可以方便团队之间的沟通，减少沟通成本。

 

日报周报

几乎每天都会接触到，主要是汇报当日工作进度或当周工作进度，写明你的进度和目标之间的差距和问题，是否脱离了计划等等。

 

技术分享

一般是每周一次，可以写一本书的读后感，也可以基于某个技术做详细分析，或者是某个难点问题有解决方案避免大家采坑，你想到的任何有用的东西都可以分享。

 

调研方案

一般是对于新技术新项目的调研过程说明，主要是解决该方案中的未知问题，最好是能找到解决方案，如果找不到的话，需要说明原因。但同时要提出整个业务流程的完整叙述。

 

技术方案

这个是重中之重，几乎每次开发项目都会用到，主要叙述整个项目模块分解的流程和开发计划，也就是说，你是如何一步一步实现这个功能的，是你大脑里思路的图文呈现，很多人在这一步都省略掉了，直接进入开发，你会发现开发的过程中遇到了很多问题，其实这就是没有技术方案的原因。

 

上线规范

一般是上线前会用到，上线之前必须按照上线规范的流程，进行严格执行，确保上线流程符合规范。这是保证上线不出问题的保证性文档，即使这个过程出错了，你也知道是哪一步出错了，这对于后期定位问题起到了关键性的作用。上线规范最好是项目启动前就要定下来。

 

对接联调规范

一般用于模块间联调，或系统集成时期，需要不同团队或组直接进行协商，对如何才能高效的对接联调进行规范。

 

版本管理规范

这个也是研发过程的重中之重，如果没有这个规范，代码的版本管理将会乱掉。比如组内采用哪种分支流程，合并之后出现冲突如何解决等等，需要在文档中说明

 

工程质量规范

这个规范主要说的比较宽泛，一般是几个规范的集合，再加上一些特殊的要求，形成的一个集成化的规范，主要用于组长以上级别的人员查看，引导组员进行相关的操作。组员也要查看和遵守，同时熟悉整个流程是如何运作的。

 

缺陷案例学习文档

这个一般是线上项目进入内测阶段以后会使用的文档，主要说明项目运行期间遇到的严重问题，导致公司的利益受到严重损失的，一般级别是需要跟绩效挂钩的，将这些缺陷记录下来，开会统一进行缺陷案例学习，是研发团队很重要的一个工作。

 

需求文档

需求文档一般是由产品经理发出的，但是产品经理在制作需求文档时，有些细节部分经常会漏掉，这就需要研发同学要有发现问题的能力，同时要提出某些小的功能应该如何设计，给产品经理提供一些决策意见供采纳。甚至有些时候，比如后台的研发类需求功能，是由研发人员发起的需求，这时研发人员也是要写需求文档的。也是属于必备技能之一了。

以上是我们研发过程中会常接触的文档类型，还有很多其他类型文档，后面想起来再继续补充。我将会用一些篇幅来展开介绍上面提到的文档类型。请大家继续关注！

这次先分享到这里，希望对大家有帮助。