软工文档总结

软工文档总结

         经过两个星期左右的努力，文档终于写完了。一开始，写文档的时候，感觉就是无从下手，没有思路，虽然，文档的模板里面已经写清楚，我们要写什么，问题已经给了我们，我们只需要逐条回答即可，但一开始，还是无法动手。老师说过，不能因为你不会而不去做，你不能先怕了，你只有动手去做了，才能知道哪里会，那里不会，总而言之，只有你去做，才能把问题解决，才有问题去解决。下面，就是我对文档的理解和总结。

文档：是软件开发使用和维护中的必备资料。

文档是指与软件系统及其软件工程过程有关联的文本实体。文档的类型包括软件需求文档，设计文档，测试文档，用户手册等。其中的需求文档，设计文档和测试文档一般是在软件开发过程中由开发者写就的，而用户手册等非过程类文档是由专门的非技术类写作人员写就的。

文档能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导、帮助、解惑的作用，尤其在维护工作中，文档是不可或缺的资料。

软件文档：

文档是一种对软件系统的书面描述；

文档应当精确地描述软件系统；

软件文档是软件工程师之间用作沟通交流的一种方式；

文档的呈现方式有很种，可以是传统的书面文字形式或图表形式，也可是动态的网页形式。

软工文档按照作用分为三类：开发文档，管理文档，用户文档。

软工文档共有13个文档，它们各自的作用和预期读者，下面来说：

（1）      可行性研究报告：

作用：可行性研究报告是从事一种经济活动（投资）之前，双方要从经济、技术、生产、供销直到社会各种环境、法律等各种因素进行具体调查、研究、分析，确定有利和不利的因素、项目是否可行，估计成功率大小、经济效益和社会效果程度，为决策者和主管机关审批的上报文件。可行性研究报告的基本内容就是报告的正文部分所要体现的内容。它是结论和建议赖以产生的基础，要求运用大量的数据资料论证拟建项目是否可行。当项目的可行性研究完成了所有系统的分析之后，应对整个可行性研究提出综合分析评价，指出优缺点和建议。

预期读者: 系统管理人员、开发人员和维护人员。

（2）      项目开发计划:

作用：项目计划是一个软件项目进入系统实施的启动阶段，主要进行的工作包括：确定详细的项目实施范围、定义递交的工作成果、评估实施过程中主要的风险、制定项目实施的时间计划、成本和预算计划、人力资源计划等。项目计划的目标是为项目负责人提供一个框架，使之能合理地估算软件项目开发所需的资源、经费和开发进度，并控制软件项目开发过程按此计划进行。

预期读者：系统分析员和开发人员

（3）      软件需求说明书：

作用：软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解， 使之成为整个开发工作的基础。包含硬件、功能、性能、输入输出、接口界面、警示信息、保密安全、数据与数据库、文档和法规的要求。

预期读者： 用户、项目管理人员、文档编写人员、需求分析人员

（4）      概要设计说明书：

作用：概要设计说明书是说明对程序 系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。在需求分析基础上得到的物理模型确定一个合理的软件系统的体系结构。包括合理地划分组成系统的模块、模块间的调用关系及其模块间的接口，并且为软件系统提供所用的数据结构或者数据库结构。

预期读者：项目设计和项目编码人员

 

（5）      详细设计说明书：

作用：详细设计说明书又可称程序设计说明书。它是说明一个软件系统各个层次中的每一个程序 ，每个模块或子程序的设计考虑。在概要设计说明书的基础上对不同的模块功能进行明确的系统结构定位，如：功能、性能、输入输出、算法、流程逻辑、接口、存储、注释、限制、测试等。

预期读者：程序开发人员和程序测试人员

 

（6）      数据库设计说明书：

作用：是对于设计中的数据库的所有标识．逻辑结构和物理结构做出具体的设计规定。

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

 

（7）      数据要求说明书：

作用：是为了提供关于处理数据的描述和数据采集要求的技术信息。

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

 

（8）      测试计划：

作用：测试计划描述了要进行的测试活动的范围、方法、资源和进度的文档；是对整个信息系统应用软件组装测试和确认测试。它确定测试项、被测特性、测试任务、谁执行任务、各种可能的风险。测试计划可以有效预防计划的风险，保障计划的顺利实施。它为测试各项活动制定一个现实可行的、综合的计划，包括每项测试活动的对象、范围、方法、进度和预期结果；为项目实施建立一个组织模型，并定义测试项目中每个角色的责任和工作内容；识别出测试活动中各种风险，并消除可能存在的风险，降低由不可能消除的风险所带来的损失。

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

 

（9）      测试分析报告：

作用：测试分析报告是在测试分析的基础上，对测试的结果以及测试的数据等加以记录和分析总结。它也是测试过程中的一个重要环节，同时，它也是对软件性能的一个总的分析和认可及对不足之处的说明。它有利于今后软件开发者阅读原程序，根据测试提供的数据和结果，分析原代码，掌握各函数的功能和局限性。

预期读者：软件开发人员

 

（10）  项目开发总结报告：

作用：要是总结本软件的开发经验和总结所学到的知识，以及对一个系统的软件设计的总体感悟，并将软件设计过程中遇到的问题加以阐述和说明。

预期读者：软件的开发人员

 

（11）  操作手册：

作用：提供了产品具有哪些功能，以及如何正确地、有效地来使用这些功能。说明了使用方法和步骤，便于使用者使用。

预期读者：用户

 

（12）  用户手册：

作用：是详细描述软件的功能、性能和用户界面，使用户了解到如何使用该软件。它要求手册的完整性，手册的描述与软件实际功能的一致性，手册的易理解性，手册提供学习操作的实例。

预期读者：用户

 

（13）  开发进度月报：

作用：是及时向有关管理部门汇报项目开发的进展和情况，以便及时发现和处理开发过程中出现的问题。

预期读者：软件的开发人员

总结：文档指导着软件开发的过程，有了文档我们才能系统的，完善的对软件进行开发和维护等，文档贯穿于整个软件工程。