软件工程——文档篇

何为软件工程？就是客户和开发人员提前定好相关需求，并形成文字材料，开发人员通过这个需求来开发软件，为了软件能够更适用，并进行相关的维护测试等方面的一个过程。简单来说就是开发人员通过需求来执行需求的这么一个过程。文档在其中就起到了不可言喻的重要作用了！！它为不同的群体提供了交流，提供了“参考”

目录

​​可行性研究报告​​

​​项目开发计划​​

​​软件需求说明书​​

​​总体设计规格说明书​​

​​详细设计说明书​​

​​测试分析报告​​

​​操作手册​​

可行性研究报告

第一步：引言（编写目的、别境说明、定义、参考资料）

第二步：可行性研究前提（要求、目标、条件、假定、限制、方法、评价尺度）

第三步：处理流程和数据流程（工作负荷、费用开支、人员、设备、局限性）

第四步：所建议的系统（总体设计规格说明书、改进之处、影响）

第五步：可选择的其他系统方案

第六步：投资及效益分析（支出、收益、收益/投资比）

第七步：社会因素方面的可行性

第八步：结论

说明：概括性的说明系统的开发是否可行，对项目的可行性进行分析

项目开发计划

第一步：引言（编写目的、背景、定义、参考资料）

第二步：项目概述（工作内容、条件与限制、产品、运行环境、服务、验收标准）

第三步：实施计划（任务分解、进度、预算、关键问题）

第四步：人员组织及分工

第五步：交付期限

第六步：专题计划要点

说明：对整个项目各个阶段的规划说明

软件需求说明书

第一步：引言（编写目的、项目范围、定义、参考资料）

第二步：任务概述（产品概述、用户特点、条件与限制）

第三步：需求规定（对功能、性能、输入输出、数据管理的规定、其他专门要求）

第四步：运行环境规定（用户界面、设备、软件接口、故障处理）

第五步：附录

说明：软件需求说明书是系统分析员在需求分析阶段需要完成的文档，是软件需求分析的最终结果。作用是：作为软件人员与用户之间事实上的技术合同说明；作为软件人员下一步进行设计和编码的基础；作为测试和验收的依据

总体设计规格说明书

第一步：引言（编写目的、项目背景、定义、参考资料）

第二步：任务概述（目标、运行环境、需求概述、条件与限制）

第三步：总体设计（处理流程、功能分配）

第四步：接口设计（外部接口、内部接口）

第五步：数据结构设计（逻辑、物理结构设计）

第六步：运行设计（运行模块的组合、运行控制、运行时间）

第七步：出错处理设计（出错输出信息、出错处理对策）

第八步：安全保密设计

说明：在总体设计阶段设计人员完成的主要文档是总体设计说明书，它主要规定软件的结构。

详细设计说明书

第一步：引言（编写目的、背景、定义、参考资料）

第二步：总体设计（需求概述、软件结构）

第三步：程序描述（功能、性能、输入/输出项、算法、流程逻辑、接口、存储分配）

说明：它是程序运行过程的描述，把设计的思想告诉其他相关人员。只有想让别人指导你设计的思想后别人才能做相应的工作，可读性高同样有利于维护

测试分析报告

第一步：引言（编写目的、背景说明、定义、参考资料）

第二步：测试概要

第三步：测试结果及发现

第四步：对软件功能的结论

第五步：分析摘要（能力、缺陷和限制、建议、评价）

说明：测试分析报告是在测试的基础上，对测试的结果以及测试的数据等加以记录和分析总结。

操作手册

第一步：引言（编写目的、背景说明、定义、参考资料）

第二步：软件概述（软件的结构、程序表）

第三步：安装和初始化

第四步：运行说明

第五步：非常规过程

第六步：远程操作

说明：为了给使用者提供一个使用指南，以便为首次使用该系统的用户说明使用方法，解决过程中遇到的问题。

不足之处欢迎斧正哦~