摘要

软件项目开发过程中,应该具有完备的文档支持,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯行。完备的文档对软件开发及使用起到很大的作物。一般情况要求编写好以下几种文档(视情况增减)。

常用开发文档

  1. 可行性分析报告

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

  2. 软件开发计划

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

  3. 软件需求规格说明)

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

  4. 软件概要设计说明

    是概要设计阶段的工作总结。主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等,为详细设计作好准备。

  5. 软件详细设计说明

    着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。

  6. 数据库设计说明

    数据库 顶层设计、包括存取 操纵数据库使用的软件配置项等

  7. 软件用户手册

    详细描述了该软件的功能、性能和用户界面,使用该软件的具体方法等。

  8. 软件测试说明

    描述执行计算机软件配置项CSCI,系统或子系统合格性测试所用到的测试准备、测试用例及测试过程。

  9. 软件测试计划

    包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

  10. 软件测试报告

    测试计划的执行情况,对测试结果的分析,提出测试结论。

  11. 开发进度月报

    按月提交的项目进展情况报告。包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。

  12. 项目开发总结报告

    项目完成以后,总结实际执行情况。如进度、成果、资源利用、成本和投入的人力,对项目开发作出评价,总结经验与教训。

  13. 软件维护手册

    主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。

  14. 软件问题报告

    记录软件出现问题的日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。

  15. 软件修改报告

    软件产品投入使用后,发现了需修改、更正的问题,要将出现的问题、修改意见、修改可能

    出现影响作出详细描述,提交审批。

中英文名称及缩写

中文名称 英文名称 英文缩写
可行性分析报告 Feasibility Analysis Report FAR
软件开发计划 Software Development Plan SDP
软件需求规格说明 Software Requirements Specification SRS
概要设计说明 Preliminary Design Document PDD
详细设计说明 Detailed Design Document DDD
数据库设计说明 Database Design Description DBDD
软件用户手册 Software User’s Manual SUM
软件测试说明 Software Testing Description STD
软件测试计划 Software Testing Plan STP
软件测试报告 Software Test Report STR
开发进度月报 Development Progress Monthly Report DPMR
项目开发总结报告 Project Development Summary Report PDSR
软件维护手册 Software Maintenance Manual SMM
软件问题报告 Software Problem Report SPR
软件修改报告 Software Change Report SCR

最后更新: 2018年03月28日 21:27

原始链接: http://rickeryan.tk/2018/03/26/Dev-Doc/

× 打赏作者~
打赏二维码