文档编纂摘要
一、 什么是文档
文档是指某种数据媒体和其中所记录的数据。在软件工程中，文档常常用来表示对活动、需求、过程或是结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。
二、 为什么要写文档
在软件生产过程中，总是产生和使用大量的信息。软件文档在产品的开发过程中起着重要的作用。
（1） 提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。
（2） 管理人员可吧这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。
（3） 提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、减少返工、并且可在开发早期发现错误和不一致性，以便于及时加以纠 正。
（4） 作为开发人员在一定阶段的国祚成果和结束标志。
（5） 记录开发过程中有关信息，以便于协调以后的软件开发、使用和维护。
（6） 提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解、是软件卡法活动更科学、更有成效。
（7） 便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。
（8） 从某种意义上来说，文档是软件开发规范的体现和指南。
（9） 按照规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发过程。
（10） 总之，在使用工程化得原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。
三、 软件开发相关文档的写法
（1） 可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评论为了合理地答道开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。
（2） 项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
（3） 软件需求说明书：对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件所编写的，也是实施开发工作的基础。
（4） 数据要求说明书：该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。
（5） 概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。
（6） 详细设计说明书：着重描述每一模块时怎么实现的，包括实现算法、逻辑流程等。
（7） 数据库设计说明书：该说明书是对于设计中的数据库的所有标识，逻辑结构、运行设计和物理结构做成集体的设计规定，知道程序员的建库工作。
（8） 用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解，为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。
（9） 测试计划：为做好集成测试和验收测试，需为如何组织测试制定实施计划。计划应该包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
（10） 测试分析报告：测试工作完成以后 ，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。
（11） 开发进度月报：该月报系统软件人员按月向主管部门提交的项目进展情况报告，报告应该包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
（12） 项目开发总结报告：软件项目完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作作出评价，总结出经验和教训。
（13） 软件维护手册：主要包括软件说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明、便于软件的维护。
四、 编写文档的要求：
（1）针对性：文档编制以前应分清楚读者对象。按不同的类型、不同层析的读者，决定怎么适应他们的需要。
（2）精确性：文档的行文应当十分确切，不能出现多义性的描述。同一课题几个文档的内容应当是协调一致，没有矛盾的。
（3）清晰性：文档编写应力求简明，如有可能，配以适当的图标，以增强其清晰性。
（4）完整性：任何一个文档都应是完整的、独立的，它应自成体系。不要在文档中出现转引其他文档内容的情况。
（5）灵活性：各个不同软件项目，其估摸和复杂程度有着许多实际差别，不能一律看待。应根据具体的软件开发项目，决定编制的文档种类。当所开发的软件系统非常大师，一种文档可以分成几卷编写。