软件开发文档总结

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/whc888666/article/details/82502749

概述

学了将近一个月的软件工程,怎么说呢?由于之前没有接触过,很多的视频看的我是一头雾水。迷迷糊糊中,软件工程就这样学习完了,意识到了它很重要,但是就是不知道它到底有多么的重要。特别是后来自己又在模板的引导下进行了第一次的文档编写,不得不说思路还是清晰了很多,由于目前学的都是理论的知识,没有真正的实际过,这次的文档编写相当于小小的实践了一把。可是我的感受就是他确实挺重要的,但是具体重要到什么程度,我目前还是有点晕。当然了刚接触一个新的知识,有这样的感受也能理解。下面我就来说说这次学到的东西吧。

定义

软件开发文档:软件开发使用和维护过程中必备的资料,是他能提高软件的开发效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。

作用

软件文档其实它就是一个桥梁,它是开发人员与客户之间的桥梁,也是开发人员之间的桥梁,同时它也是开发人员与上下级之间的桥梁。你说他重要吗?我怎么感觉远远比写代码重要多了呢?其实一个没有文档的软件就不叫软件,更不能称其为软件产品。重要、重要、重要。

体现

如果说我们编写的文档不是一份合格的文档那么我们将无法做到如下:
1、项目的管理依据
2、技术交流的语言
3、项目质量的保证
4、培训维护的资料
5、维护软件的支持
6、记载历史的语言

分类

这么重要的软件,我们先来看看分类:有利于理解:(看图)
这里写图片描述
这里写图片描述
下面看看这样分类的作用:
1、开发文档
(1)它是软件开发过程中各个阶段间的通讯工具,它记录生成软件需求、设计、编码和测试的详细规定和说名。
(2)它描述开发小组的职责,包含开发过程中任何其他事项的角色定义“如何做”和“何时做”。
(3)它作为检验点儿允许管理者评定开发进度。如果开发文档丢失、不完整或过时,管理者将失去跟踪和控制软件项目的一个重要工具。
(4)它形成了维护人员所要求的基本软件支持文档。而这些支持文档可作为文档的一个部分。
(5)它记录了软件开发的历史。
2、用户文档
(1)为使用和运行软件产品的客户提供培训和参考信息;
(2)为那些未参加开发本软件的程序员维护它提供信息;
(3)促进软件产品的市场流通或者提高软件的可接受性;
3、管理文档
(1)开发过程中每个阶段的进度和进度变更的记录;
(2)软件变更情况的记录
(3)职责定义

预期读者

下面我们来看下,每个文档的相关预期读者:
这里写图片描述

猜你喜欢

转载自blog.csdn.net/whc888666/article/details/82502749