记第一次写项目文档--脑子一片空白

baker_fu

    以下部分是一个java工程师的自述。

    我在软件公司工作一年了，在公司开发项目时，项目经理分给我的模块也不难，所以项目中也就没有遇到什么难点。项目中也有一些特殊的功能，我没有开发过，我的同事负责的，后来我也看过他们写的模块和功能。我觉得这些功能或模块交给我开发，也挺难的。但我自己经历的，我觉得比较难的，是我第一次写项目文档的经历。

    按照传统的软件项目生命周期模型，软件项目按照如下阶段进行：

1. 需求分析
2. 概要设计
3. 详细设计
4. 编码
5. 测试
6. 上线

    在各个阶段，要求完成相应的文档编写，需求分析阶段完成《需求规格说明书》，概要设计阶段完成《概要设计说明书》，详细设计阶段完成《详细设计说明书》。

    项目按照这个开发模型进行，各阶段的文档也要认真编写，下一个阶段会参考上一个阶段的文档。

    但我经历的第一个项目没有按这个流程进行。可能是因为项目不大，而且工期很紧。在项目经理完成《需求规格说明书》，甲方签署了《需求确认书》后，我和两个同事就开始开发了。我们没有编写概要设计说明书和详细设计说明书，可能项目经理，已经在心里有了这些设计文档，但没有word版的。项目经理把设计思路传达给我们的方式，就是开会讨论，把开会讨论的结果写在笔记本上，然后继续开发。

    在项目经理的掌控下，我们的项目最终在3个月后，完成了。我本以为，我的第一次参与的开发项目就这样结束了，经理早上开会通知大家，每个人要把自己负责的模块写出《概要设计说明书》、《详细设计说明书》。

    开发项目功能，完成业务逻辑，这些我都可以完成，可是写项目文档，我可不会写。感觉像写作文一样，从小就抵触写作业，编词凑字数，太痛苦了。

    项目经理发来了《概要设计说明书模板》和《详细设计说明书模板》。模板都是公司规定好的，我按照实际开发的功能，像填写表格一样，把响应的模块和功能加入到文档中。三天后，我自信满满地把文档发给经理。经理对我的文档提出以下问题，要求我再完善一下文档。

1. 《概要设计说明书》漏掉了一些功能。比如项目中开发了A功能，文档中，没有说明A功能。
2. 《概要设计说明书》组件描述太简单。一句话描述完了，对于一些细节和注意事项，没有提及。
3. 《概要设计说明书》缺少一些使用UML画的组件图。
4. 《详细设计说明书》对于类方法的描述不够详细，要在类方法的描述中体现1、2、3、……这样的步骤，业务逻辑，参数，返回值
5. 《详细设计说明书》缺少一些使用UML画的类图、流程图、状态图等。

    经过经理的指导，我反复修改项目文档后，我对项目的认识又提升到一个新的高度。我把项目看的更细了，当我再进入下一个项目组，进行开发时，我对项目需求的理解也就会考虑更加周全。

    最后给大家描述一下《概要设计说明书》和《详细设计说明书》都写哪些内容.

    《概要设计说明书》

1. 项目背景（项目经理编写）
2. 项目范围（项目经理编写）
3. 方案设计范围（项目经理编写）
4. 系统设计前提、系统设计原则、系统设计方法（项目经理编写）
5. 系统架构设计（项目经理编写）
6. 系统组件设计：业务组件关系图、组件说明

    《详细设计说明书》

1. 包的说明
2. 组件类关系图
3. 组件类描述：Controller描述、Entity描述、Service描述、Dao描述
4. 实体状态图
5. 组件时序图
6. 页面功能设计
7. 页面错误提示信息描述

最后补充一下,项目的数据库设计写在《数据库模型文档》中。

18748174093

1