【软工】文档总结

    软件开发一般包括需求分析、设计、实现、测试等过程，开发过程中伴随着对开发文档的编制。下面从几个方面介绍一下文档

一、为什么要写文档

    理解才会产生兴趣，有兴趣才会写出有价值的文档，才不会成为负担，不会感觉累

    1、为自己写

    如同给代码写注释一样，文档首先是为作者自己而写，可以帮助作者理清关系、启发思路、加深认识、提醒回顾和备忘。从这个角度讲，写文档和写代码一样，都是软件开发必须的工作。写好文档是工作认真负责的体现，是个人职业素养的“品牌”。文如其人，工作如生活，持这种工作水准的软件工程师受人尊敬

    2、为相关开发方而写

    完备清晰的文档是成功开发的关键，同时文档还是与伙伴交流的界面。软件开发是一个持续的活动，生命周期较长，运行维护、修订、升级是一个长期的过程，如果没有一些文档的辅助会给新加入的成员带来困难

    3、为组织而写

    软件开发的结果是组织的资产，这些资产也包括开发文档

    4、为客户而写

    客户是我们的衣食父母，他们需要了解和评价产品的质量，文档审查是评价的重要手段

二、文档的作用

    1、可行性研究报告

    预期读者：系统管理员，开发人员、用户和维护人员

    作用：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。

    2、项目开发计划

    预期读者：开发人员、分析人员、管理人员

    作用：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考

    3、软件需求说明书

    预期读者：开发人员、管理人员、分析人员、用户

    作用：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础

    4、概要设计说明书

    预期读者：设计人员、开发人员、分析人员

    作用：是概要设计阶段的工作成果，应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

    5、详细设计说明书

    预期读者：开发人员、测试人员、维护人员

    作用：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

    6、数据库设计说明书

    预期读者：数据库设计师、数据库管理员

    作用：提供了数据库设计的可视性以及软件支持所需的信息，应用于系统开发前期，为了让参与本项目的项目的人员了解本系统的数据库设计思路、数据库整体架构及各种详细信息，也为了以后的各个项目可以参与借鉴该项目的经验，将数据分析的结果进一步整理，对本系统数据库的所有标识、逻辑结构和物理结构作用作出具体的设计规定和分析说明，形成最终的计算机模型，以便开发人员建立物理数据库。

    7、数据库要求说明书

    预期读者：数据库设计人员、系统测试人员

    作用：应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷做好准备。

    8、测试计划

    预期读者：系统编程人员和系统测试人员

    作用：为做好组装测试和确认测试，需为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

    9、测试分析报告

    预期读者：用户、测试人员、开发人员、项目管理人员

    作用：测试工作完成以后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论意见。

    10、项目开发总结报告

    预期读者：上级管理人员

    作用：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力等。此外还需对开发工作做出评价，总结出经验和教训。

    11、操作手册

    预期读者：用户

    作用：为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

    12、用户手册

    预期读者：购买此软件的用户

    作用：详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

    13、开发进度月报

    预期读者：开发人员、管理人员

    作用：是软件人员按月向管理部门提交的项目进展情况报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。