软件工程文档总结
完成了最后一篇技术文章。
就如何撰写技术性文件我已经有了基本的认识。
在验收document的时候,师傅们告诉我们,最初编写document的目的就是让你了解如何撰写document及其规范要求。
明白了这些就可以了。
不过需要注意的是，在某些document中涉及图表的部分需要具备基本的知识储备。
可行性研究报告文件——是在进行一项投资活动之前,经过全面调查研究分析,识别项目可行性和不可行性因素,评估成功的可能性程度以及经济效益与社会效益等多方面指标,提交给决策者和主管机关作为审批前的重要参考资料。
目的：用最小的代价在尽可能短的时间内确定问题是否能够解决。
在软件项目管理过程中,制定项目计划是一个核心环节,它是软件开发工作的起始环节.项目的整体目标在于为项目经理提供一个可操作性的框架,使其能够合理预测软件项目所需的人力资源、资金投入以及开发周期,并对整个开发过程实施有效的进度控制.
软件需求说明书——旨在确保用户与软件开发者对初始规范达成一致理解，并以此为基础开展整个开发过程。该说明书应涵盖硬件要求、功能规范、性能指标以及详细的数据管理规定，并明确输入输出范围和数据格式要求；同时需包含接口规范描述以保证系统各组件之间的协调工作；此外还需要规定清晰的警示内容以提醒关键操作注意事项；保密安全标准要求必须明确；文档编写规范和格式标准也要严格遵循；最后还需满足相关法律法规的要求。
目的：为了促进用户与开发人员之间的沟通与理解而设计；该系统能够体现用户问题的结构特征；可作为软件开发工作的基础环节及参考依据；同时可作为测试与验收的重要标准。
概要设计说明书也可称作系统设计说明书其主要目标是阐述程序系统的整体设计方案涵盖以下主要内容包括程序系统的基本处理流程程序系统的组织架构模块划分功能分配接口设计运行方案安全措施数据结构规划以及错误处理机制等内容为后续详细开发工作提供理论依据
详细设计说明书——又可称软体设计说明书，在编写时旨在阐述一个软件系统中各层次的软体模块或功能单元的设计考量。
数据库设计说明书——数据库设计说明书是对设计中的各个标识项及其逻辑结构和物理结构进行详细规划和规范。
数据要求说明书其主要作用在于确定系统软件中各项功能及非功能性需求所需的信息，并据此信息作为依据来规划数据库结构。
测试计划——涵盖要进行的各项测试活动的范围、步骤以及所需资源和时间安排的文档；是对整个信息系统应用软件进行集成测试并完成最终确认阶段的过程。
基于测试分析形成的报告，在整体的软件开发流程中占据着关键地位。它不仅记录各项测试结果及相关数据，并且通过深入分析揭示其背后的功能特性与其存在的问题；针对系统软件的功能特性与其存在的问题进行深入剖析；从而帮助开发人员减少重新开发所需的时间以及节省投入的成本
项目开发总结报告为我们提供了宝贵的经验教训，在未来的工作中将更好地推动项目的制定方案与执行规划工作。我们可以通过丰富的参考资料库来优化流程并提升整体效能，在项目推进过程中为企业的持续发展奠定基础。
该手册旨在向用户提供一系列功能及其规范的使用方法。
用户的指南书——是对该软件的功能特性及其界面设计进行全面介绍的文档，请您参考此指南以掌握其基本操作方法。
项目进展报告——项目负责人将按照既定的项目计划对实际执行情况进行综合分析与评估，并归纳经验以提出改进措施。
项目进展报告——项目负责人将按照既定的项目计划对实际执行情况进行综合分析与评估，并归纳经验以提出改进措施。
| 文档名称 | 编写阶段 | 编写人员 | 预期读者 | 关键点 |
|---|---|---|---|---|
| 可行性研究报告 | 制定计划 | 分析人员、项目组长 | 开发人员、项目负责人、决策者 | 系统流程图、数据字典 |
| 项目开发计划 | 需求分析-设计 | 项目组长 | 开发人员、项目负责人、决策者 | 甘特图 |
| 软件需求说明书 | 需求分析-设计 | 分析人员、项目组长 | 用户、开发人员 | 用例图、简单的数据描述 |
| 概要设计说明书 | 设计 | 项目组长 | 项目组长、开发人员 | 流程图、E-R图 |
| 详细设计说明书 | 设计 | 项目组长 | 项目负责人、开发人员 | 流程图、E-R图 |
| 数据库设计说明书 | 设计 | 数据库设计人员 | 开发人员、。编码人员 | E-R图、关系模型 |
| 数据要求说明书 | 需求分析—设计—编码 | 开发人员 | 编码人员、开发人员、 | 数据库视图等 |
| 测试计划 | 设计-编码 | 开发人员 | 测试人员 | 测试用例 |
| 测试分析报告 | 测试 | 测试人员 | 开发人员，测试人员 | 无 |
| 项目开发总结报告 | 测试 | 项目组长 | 项目组长，决策者 | 流程图 |
| 操作手册 | 编码 | 开发人员 | 用户 | 软件结构、IPO图 |
| 用户手册 | 需求分析-设计-编码 | 开发人员 | 用户 | 数据结构图、IPO图 |
| 开发进度月报 | 当今开发阶段 | 项目组长 | 项目组长 | 甘特图 |
【总结】
这次文档编写的核心内容在于掌握各个文档之间的编写阶段、参与人员分工情况以及预期受众特征等关键要素所在，在对文档编写的规范有一定了解的基础上为后续依据具体文档进行程序开发奠定了基础