【软工】文档

位置软件开发的灵魂

作者软件开发者

类型文本实体(用文字或是图片的形式,表现出软件开发的整个过程)

分类

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

细分

1. 可行性研究:项目能不能行,哪里行,为什么行

2. 项目开发计划:项目该如何开发,详细列出开发的各个阶段,各个细节都要注意到。

3. 软件需求说明书:软件开发人员和用户(代表)交流的结果,方便用户更好的理解用户需求,主要表明用户需求,也就是软件需要满足什么功能。

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

5. 详细设计说明书:概要设计说明书的一个细化,就是把设计到每一个具体的点上(算法,流程逻辑……),小型的软件开发可以没有此文档!

6. 数据库(数据)说明书:主要说明数据库是如何设计的内容(表格设计,数据类型,长度……),用于开发前期,为后期开发提供帮助!

7. 测试计划:如何进行测试,进行那方面的测试?测试的条件……预期能达到什么样的结果!

8. 测试分析报告:对测试进行分析评估,就相当于,战后打扫战场!

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

10. 操作手册:说明书,告诉使用者,软件的主要功能,如何使用(具体的使用情况)!

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

12. 开发进度月报:类似与我们的日报,汇报一下我们的开发情况,总结一下工作经验!

图解:

【软工】文档

作用:

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

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


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