【前言】经过断断续续的将近一个月的时间终于把这12个文档写完了。之前我们总以为软件开发就是写代码,把功能实现了就行啦。学了软件工程之后我们才知道软件开发是一个工程从开始的需求分析到最好的上线,都必须按照规范来,否则这就不能称之为一款好的作品。还有最最重要的就是文档,据说华为有三分之二的软件开发人员都是写文档的,这就足以说明文档的重要性了。
对于文档的初次接触我们首先要知道的就是编写每个文档的目的和文档的预期读者。知道这些我们才知道应该使用什么样的语言去描述我们想要表达的内容,例如如果是给软件开发人员看的我们就要用计算机的专业术语,用语尽量规范化专业化,,但是如我们的读者是用户的话,我们所描述的语言就要尽可能的简单易理解,就不要使用我们所在领域的一些专业用语了,否则用户看不懂我们编写的文档就没有意义了。
文档 | 所属阶段 | 编写目的 | 作者 | 预期读者 |
《可行性研究报告》 | 可行性研究 | 就是从各方面来看这个项目能不能做 | 项目提出者 | 客户、开发人员、维护人员 |
《项目开发计划》 | 项目启动阶段 | 为这个项目各个方面制定计划 | 项目组长 | 软件开发人员、系统分析人员 |
《软件需求说明书》 | 需求分析 | 这个软件可以解决什么问题,满足哪些需求 | 系统分析人员 | 项目组长、软件开发人员、用户代表 |
《概要设计说明书》 | 总体分析 | 对程序框架的设计 | 软件开发人员 | 开发小组成员、项目组长、测试人员 |
《详细设计说明书》 | 详细设计 | 一个软件系统各个层次中的每一个程序 (每个模块或子程序)的设计考虑 | 软件开发人员 | 开发小组其他人员、项目组长、测试人员 |
《数据库设计说明书》
| 详细设计 | 对于设计中的数据库的所有标识.逻辑结构和物理结构做出具体的设计规定 | 数据库设计人员 | 数据库管理人员、软件开发小组其他成员 |
《数据要求说明书》 | 详细设计 | 根据提交对象的不同,可分为内部数据需求说明书和外部关联数据需求说明书,分别提交被审计单位和外部关联单位 | 软件开发人员 | 数据库设计人员、数据库管理人员、软件开发小组其他成员 |
《项目开发总结报告》 | 编码 | 为了总结报告在工作过程中产生的问题、行到经验, 并且 总结报告设计和制作者 过程中的逻辑和想法 | 软件开发人员 | 软件开发小组成员、项目组长 |
《测试计划》 | 测试 | 操作手册是用户手册的一部分 | 软件测试人员 | 软件开发小组人员、测试人员 |
《测试分析报告》。 | 测试 | 测试分析报告就是对测试结果做以分析 | 软件测试人员 | 软件开发小组成员、 |
《操作手册》 《用户手册》 | 交付使用 | . 操作手册是用户手册的一部分。 操作手册是系统级别的文档,而用户手册是需求级别的文档 | 软件开发人员 | 用户、项目组长 |
《开发进度月报》 | 整个阶段 | 就是对软件开发过程的一个记录 | 软件开发人员 | 项目组长、软件开发小组成员 |
【总结】把这些文档的作者和读者、编写目的都弄明白然后就会了解这些文档的作用。我们要认识到文档的重要性才能走上软件开发的正规道路。
以上的这些分析都是本人个人的简介,如有错误请大家帮助指正。