计算机软件文档编写标准化

◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。
http://blog.csdn.net/bergn/articles/227879.aspx
01可行性分析报告
◇ 项目开发计划:为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
http://blog.csdn.net/bergn/articles/227875.aspx
02项目开发计划
◇ 软件需求说明书(软件规格说明书):对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。
http://blog.csdn.net/bergn/articles/227871.aspx
03软件需求说明书
◇ 概要设计说明书:该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。
http://blog.csdn.net/bergn/articles/227868.aspx
04概要设计说明书
◇ 详细设计说明书:着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。
http://blog.csdn.net/bergn/articles/227867.aspx
05详细设计说明书
◇ 用户操作手册:本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。
http://blog.csdn.net/bergn/articles/227865.aspx
06用户操作手册
◇ 测试计划:为做好集成测试和验收测试,需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
07测试计划
◇ 测试分析报告:测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。
http://blog.csdn.net/bergn/articles/227864.aspx
08测试分析报告
◇ 开发进度月报:该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
http://blog.csdn.net/bergn/articles/227859.aspx
09开发进度月报
◇ 项目开发总结报告:软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。
10开发进度月报
http://blog.csdn.net/bergn/articles/227857.aspx
◇ 软件维护手册:主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明,便于软件的维护。
http://blog.csdn.net/bergn/articles/227855.aspx
11软件维护手册
◇ 软件问题报告:指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。
http://blog.csdn.net/bergn/articles/227851.aspx
12软件问题报告
◇ 软件修改报告:软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。
http://blog.csdn.net/bergn/articles/227847.aspx
13软件修改报告


注意,以上文件开头都是编码了的。
那么,对于文档编号:
01 ~ 20: 留给规范化文档
21 ~ 50: 留给非规范化补充文档
51 ~ 99: 留给辅助文档,或者参考文档

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
非常全名,包括14分文档,包括有 可行性研究报告模版、详细设计说明书模版、程序维护手册模版、软件修改报告模版、软件问题报告模版、项目开发总结报告模版、需求规格说明书模版、测试计划模版、用户操作手册模版、项目开发计划模版 等等。例如: 《用户操作手册》 1.引言 1 1.1编写目的 1 1.2项目背景 2 1.3定义 2 1.4参考资料 2 2.软件概述 2 2.1目标 2 2.2功能 2 2.3性能 2 3.运行环境 2 3.1硬件 2 3.2支持软件 3 4.使用说明 3 4.1安装和初始化 3 4.2输入 3 4.3输出 3 4.4出错和恢复 3 4.5求助查询 3 5.运行说明 3 5.1运行表 3 5.2运行步骤 3 6.非常规过程 3 7.操作命令一览表 3 8.程序文件(或命令文件)和数据文件一览表 3 9.用户操作举例 3 1.引言 1.1编写目的 【阐明编写手册的目的,指明读者对象。】 1.2项目背景 【应包括项目的来源、委托单位、开发单位和主管部门。】 1.3定义 【列出手册中所用到的专门术语的定义和缩写词的原文。】 1.4参考资料 【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括: a. 项目的计划任务书、合同或批文; b. 项目开发计划; c. 需求规格说明书; d. 概要设计说明书; e. 详细设计说明书; f. 测试计划; g. 手册中引用的其他资料、采用的软件工程标准或软件工程规范。】 2.软件概述 2.1目标 2.2功能 2.3性能 a. 数据精确度【包括输入、输出及处理数据的精度。】 b. 时间特性【如响应时间、处理时间、数据传输时间等。】 c. 灵活性【在操作式、运行环境需做某些变更时软件的适应能力。】 3.运行环境 3.1硬件 【列出软件系统运行时所需的硬件最小配置,如 a. 计算机型号、主存容量; b. 外存储器、媒体、记录格式、设备型号及数量; c. 输入、输出设备; d. 数据传输设备及数据转换设备的型号及数量。】 3.2支持软件 【如: a. 操作系统名称及版本号; b. 语言编译系统或汇编系统的名称及版本号; c. 数据库管理系统的名称及版本号; d. 其他必要的支持软件。】 4.使用说明 4.1安装和初始化 【给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成的测试实例以及安装所需的软件工具等。】 4.2输入 【给出输入数据或参数的要求。】 4.2.1数据背景 【说明数据来源、存储媒体、出现频度、限制和质量管理等。】 4.2.2数据格式 【如: a. 长度; b. 格式基准; c. 标号; d. 顺序; e. 分隔符; f. 词汇表; g. 省略和重复; h. 控制。】 4.2.3输入举例 4.3输出 【给出每项输出数据的说明。】 4.3.1数据背景 【说明输出数据的去向、使用频度、存放媒体及质量管理等。】 4.3.2数据格式 【详细阐明每一输出数据的格式,如:首部、主体和尾部的具体形式。】 4.3.3举例 4.4出错和恢复 【给出: a. 出错信息及其含意; b. 用户应采取的措施,如修改、恢复、再启动。】 4.5求助查询 【说明如何操作。】 5.运行说明 5.1运行表 【列出每种可能的运行情况,说明其运行目的。】 5.2运行步骤 【按顺序说明每种运行的步骤,应包括:】 5.2.1运行控制 5.2.2操作信息 a. 运行目的; b. 操作要求; c. 启动法; d. 预计运行时间; e. 操作命令格式及说明; f. 其他事项。 5.2.3输入/输出文件 【给出建立或更新文件的有关信息,如:】 a. 文件的名称及编号; b. 记录媒体; c. 存留的目录; d. 文件的支配【说明确定保留文件或废弃文件的准则,分发文件的对象,占用硬件的优先级及保密控制等。】 5.2.4启动或恢复过程 6.非常规过程 【提供应急或非常规操作的必要信息及操作步骤,如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。】 7.操作命令一览表 【按字母顺序逐个列出全部操作命令的格式、功能及参数说明。】 8.程序文件(或命令文件)和数据文件一览表 【按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。】 9.用户操作举例

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值