标签：
我以前也觉得程序员敲代码很忙，没有时间去写这些文档，浪费时间，后来经过一段时间后，觉得这些文档真的太重要了，缺一不可，不能偷懒不写。原因一次在修改逻辑的业务的时候老是找不到对应的接口，虽然有写注释，但不详细，没搞清楚，花了一两天的时间才找到，数据库没有文档也是一件痛苦的事，不知道那些字段的对应哪些对象的属性，原谅我英文水平差。
因此，我总结一些常见的软件文档。
软件策划书-------立项的第一步，肯定要考虑清楚这个项目的整体规划，尽可能要想远一点，可以从这几个方面考虑，比如成本，技术，盈利（这方面很重要，无法盈利的项目做来干呢？）。
软件需求分析文档-------了解项目的需求，明确具体要实现的业务（一旦定下来就尽量不要去改动它，否则后果很严重），软件开发工程师要认真阅读，理解项目流程业务。建议要与项目经理，或者是产品经理，或者是策划人员开会讨论，评估一下软件项目可行性（这种需求是否合理，是否能够实现）。
软件开发文档-------详细撰写项目的架构，项目的模块化划分以及对应的对象，属性，方法（建议配上UML图，效果更好）。软件开发文档内容包括了前端技术（pc/mobile web，app，桌面应用），后端技术，数据库技术，服务器技术。
编码规范(只写一个) ------- 项目经理或者开发组组长规定编码规范，一般采取约定俗成的代码规范即可。（建议写能够一看就懂的命名）。
软件测试文档-------没有测试人员的话，就是软件开发工程师让来写单元测试以及集成测试的文档。（建议请让专业的软件测试人员来撰写）。
软件验收文档-------根据软件需求分析文档，逐一检验项目功能是否与需求文档保持一致。
用户使用手册-------实际上就写用户使用教程，这个比较简单，图文并茂的教程即可。
标签：
原文地址：http://www.cnblogs.com/Sroot/p/5702988.html
