【软工】文档

位置&＃xff1a;软件开发的灵魂

作者&＃xff1a;软件开发者

类型&＃xff1a;文本实体&＃xff08;用文字或是图片的形式&＃xff0c;表现出软件开发的整个过程&＃xff09;

分类&＃xff1a;

• 需求文档
• 设计文档
• 测试文档
• 用户手册

细分&＃xff1a;

1. 可行性研究&＃xff1a;项目能不能行&＃xff0c;哪里行&＃xff0c;为什么行

2. 项目开发计划&＃xff1a;项目该如何开发&＃xff0c;详细列出开发的各个阶段&＃xff0c;各个细节都要注意到。

3. 软件需求说明书&＃xff1a;软件开发人员和用户&＃xff08;代表&＃xff09;交流的结果&＃xff0c;方便用户更好的理解用户需求&＃xff0c;主要表明用户需求&＃xff0c;也就是软件需要满足什么功能。

4. 概要设计说明书&＃xff1a;软件的物理设计和逻辑设计&＃xff0c;模块之间的数据调用&＃xff0c;一些具体的问题&＃xff01;为软件设计一个整体的框架&＃xff01;

5. 详细设计说明书&＃xff1a;概要设计说明书的一个细化&＃xff0c;就是把设计到每一个具体的点上&＃xff08;算法&＃xff0c;流程逻辑……&＃xff09;&＃xff0c;小型的软件开发可以没有此文档&＃xff01;

6. 数据库&＃xff08;数据&＃xff09;说明书&＃xff1a;主要说明数据库是如何设计的内容&＃xff08;表格设计&＃xff0c;数据类型&＃xff0c;长度……&＃xff09;&＃xff0c;用于开发前期&＃xff0c;为后期开发提供帮助&＃xff01;

7. 测试计划&＃xff1a;如何进行测试&＃xff0c;进行那方面的测试&＃xff1f;测试的条件……预期能达到什么样的结果&＃xff01;

8. 测试分析报告&＃xff1a;对测试进行分析评估&＃xff0c;就相当于&＃xff0c;战后打扫战场&＃xff01;

9. 项目开发总结报告&＃xff1a;项目开发算是基本完成&＃xff0c;总结性评估&＃xff0c;总结问题和收获&＃xff01;为以后项目开发留下记录&＃xff0c;取其精华&＃xff0c;弃其糟粕&＃xff01;

10. 操作手册&＃xff1a;说明书&＃xff0c;告诉使用者&＃xff0c;软件的主要功能&＃xff0c;如何使用&＃xff08;具体的使用情况&＃xff09;&＃xff01;

11. 用户手册&＃xff1a;和操作手册有异曲同工之妙&＃xff0c;但是它会要介绍软件的更重细节&＃xff08;格式的问题&＃xff0c;数据结构&＃xff09;&＃xff0c;而且会对用户遇到的问题解决

12. 开发进度月报&＃xff1a;类似与我们的日报&＃xff0c;汇报一下我们的开发情况&＃xff0c;总结一下工作经验&＃xff01;

图解&＃xff1a;

作用&＃xff1a;

• 提高软件开发效率
• 保证软件质量
• 指导&＃xff0c;帮助&＃xff0c;解惑
• 软件工程师进行交流的一中工具
• 精确的描述系统

历史&＃xff1a;早期的软件文档主要是指是用户手册&＃xff0c;主要是用来对软件系统界面元素的设计、规划、和实现过程的记录&＃xff0c;以此来增强系统的可用性。

以上自己解释部分&＃xff0c;仅代表个人理解&＃xff0c;有什么不全面或是局限的认识&＃xff01;欢迎大家积极交流&＃xff01;