软件开发文档编写规范

对于软件工程学科的同学都知道，软件工程是一门技术含量高设计极其复杂的学科。为了控制好软件产品质量和规范，就必须用大量的文档约束软件工程的进度和状态。浩大的软件工程对于缺少工作和项目经验的人来说，必然是摸不着头脑不知从何开始。为了让大家能够快速适应标准的软件开发过程，今天我为大家粗略的描述开发中需要的文档，本人将按照国家软件质量标准来说明介绍。
　　在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。

项目文档管理软件我推荐大家使用（Telelogic doors V8.0），此软件可以很好的管理好繁多的项目文档。

Telelogic doors V8.0下载：http://pan.baidu.com/share/home?uk=4076915866&view=share#category/type=0

Telelogic doors V8.0 使用方法介绍： http://zz563143188.iteye.com/blog/1830393

接下来将是十三种文档的介绍（文档模板请下载附件）

　　1.◇ 可行性分析报告：
　　　　说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述
为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案
的理由。

　　2.◇ 项目开发计划：
　　　为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开
发的进度、开发经费的预算、所需的硬件及软件资源等。

　　3.◇ 软件需求说明书（软件规格说明书，系统测试需要的标准文档）：
　　对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是
在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实
施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护
系统数据文件做好准备。

　　4.◇ 概要设计说明书：
　　　　该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序
的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，
为详细设计提供基础。

　　5.◇ 详细设计说明书：
　　　　着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

　　6.◇ 用户操作手册：
　　　　本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件
得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法
的具体细节。

　　7.◇ 测试计划：
　　　　为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括
测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

　　8.◇ 测试分析报告：
　　　　测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分
析，并提出测试的结论意见。

　　9.◇ 开发进度月报：
　　　　该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括
进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月
的打算等。

　　10.◇ 项目开发总结报告：
　　　　软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，
如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，
总结出经验和教训。

　　11.◇ 软件维护手册：
　　　　主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护
过程的说明，便于软件的维护。

　　12.◇ 软件问题报告：
　　　　指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为
软件修改提供准备文档。

　　13.◇ 软件修改报告：
　　　　软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在
的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。

一、可行性研究报告.rar (10.6 KB)
下载次数: 1355

二、项目开发计划.rar (7.5 KB)
下载次数: 1155

三、需求规格说明书.rar (8.7 KB)
下载次数: 1181

四、概要设计说明书.rar (8.3 KB)
下载次数: 1212

五、详细设计说明书.rar (7.4 KB)
下载次数: 1293

六、用户操作手册.rar (9.9 KB)
下载次数: 1053

七、测试计划.rar (8.5 KB)
下载次数: 1029

八、测试分析报告.rar (6.9 KB)
下载次数: 986

九、开发进度月报.rar (5.9 KB)
下载次数: 1044

十、项目开发总结报告.rar (7 KB)
下载次数: 996

十一、程序维护手册.rar (9.1 KB)
下载次数: 1010

十二、软件问题报告.rar (7.1 KB)
下载次数: 953

十三、软件修改报告.rar (7.8 KB)
下载次数: 958

本文来自CSDN 博客：https://blog.csdn.net/zhanghui962623727/article/details/52248990

软件开发文档编写规范相关推荐

python软件开发-如何编写Python软件开发文档（7个技巧）
开发文档是经常被程序员忽略的工作,有时也会被管理者忽略.这往往是由于在项目生命周期结束的后期缺乏时间,以及人们认为自己不擅长写作,其中一些人确实写不好,但他们中的大多数能够完成一个良好的文档. 在任何 ...
python开发软件的实例-如何编写Python软件开发文档（7个技巧）
开发文档是经常被程序员忽略的工作,有时也会被管理者忽略.这往往是由于在项目生命周期结束的后期缺乏时间,以及人们认为自己不擅长写作,其中一些人确实写不好,但他们中的大多数能够完成一个良好的文档. 在任何 ...
python写软件实例-如何编写Python软件开发文档（7个技巧）
开发文档是经常被程序员忽略的工作,有时也会被管理者忽略.这往往是由于在项目生命周期结束的后期缺乏时间,以及人们认为自己不擅长写作,其中一些人确实写不好,但他们中的大多数能够完成一个良好的文档. 在任何 ...
软件开发文档整理（之）一张示意图 | 清晰明了
在整个软件开发周期,开发文档是必不可少的资料,它们贯穿于整个开发周期,用来评估计划.规划进度.项目管理.软件测试.软件发布,可以说至关重要. 开发文档必须归档,没有归档的文档作用大打折扣,时效 ...
软件开发中常见英文缩写和各类软件开发文档的英文缩写
软件开发中常见英文缩写和各类软件开发文档的英文缩写: 文章复制粘贴来源于:http://blog.sina.com.cn/s/blog_7326867a0100yfdl.html 英文简写文档名称 ...
软件开发文档的价值和作用
现代软件研发理念强调敏捷开发,快速迭代,高效地响应用户的需求变化.可以说,自从有了敏捷方法,有相当一部分程序员长出一口气:终于可以不用写文档了. 那么,事实真的如此吗,文档应不应该写,应该如何编写? ...
python软件开发文档目录_python学习之-软件开发的目录规范
通常软件目录下有几个标准文件夹软件主文件夹命名,通常都是大写(ATM_SHOPPING) ------------------------------------------------------ ...
计算机软件开发文档编写指南
一.项目开发计划 1．引言... 1 1.1编写目的... 1 1.2项目背景... 1 1.3定义... 2 1.4参考资料... 2 2．项目概述... 2 2.1工作内容... 2 2.2条件与 ...
软件开发文档模板（学习）
1 可行性研究报告可行性研究报告的编写目的是:说明该软件开发项目的实现在技术.经济和社会条件方面的可行性:评述为了合理地达到开发目标而可能先择的各种方案:说明论证所选定的方案. 可行性研究报告的 ...
Just enough（刚刚好）的软件开发文档什么样？
在今年与多个软件开发单位的交流中,补文档的问题多次提到,试图通过本文谈谈文档的价值,如何写刚刚好的文档. 软件开发所需要的文档在传统的瀑布型生命周期下典型的有:开发计划,需求规格说明书,设计书(有分成 ...

软件开发文档编写规范

软件开发文档编写规范相关推荐

最新文章

热门文章