详解软件工程之软工文档(总结篇)

  •        最近的半个月的时间一直在写软件工程的文档,软件工程的文档也总算接近尾声了,下面我谈一谈对软工文档的简单的理解。

           在开始写软工的文档时,不知道软工的文档不是干嘛用的,总之是一头雾水。文档快结束时,才体会到文档的重要性。


    一、对文档重要性的理解

             

           文档的作用其实是很多,不仅仅只是为用户、程序员提供一个可靠的依据。无论是对于用户还是对于程序员都做到有据可寻,编程结束之后如果出现什么差错,检查这是谁的问题,当然就得根据文档,文档就相当于法律条文,明确规定各自的任务,不符合用户的需求就是程序员的问题,这样公司就会遭受损失。

           为系统的维护,提供最有利的技术支撑,相信大家都知道,做系统非常的容易,后期的维护工作才是一个优秀的编程团队需要考虑的问题。


    二、各个文档的目的


    对于每个文档的目的深刻的理解,编程只是再简单不过的小菜。

    1. 可行性研究报告

    说明该软件开发项目目的是在在技术、经济和社会条件方面的可行性;评述为了合理地达到开发目标而可能选择的各种方案等等。

    在开始一个项目时,需要完成可行性研究报告,研究此开发项目是否能够完成,解释理由。

    1. 项目开发计划

    此项目开发计划的编写主要是为了给开发系统做主要的规划和整合,在开发过程中起到引导作用,以及给在使用者提供简单的说明。

    项目开发计划是为项目组长查看,此项目的开发计划以及多长时间可以完成,是查工作进度最直接的证据。

    1. 软件需求说明书

       本文档的目的

    1. 方便用户、分析人员和软件设计人员进行理解和交流。用户通过需求规格说明书在分析阶段即可初步判定目标软件能否满足其原来的期望,但是本文档主要是作为设计人员的软件开发的基本出发点和系统维护人员发现和添加新功能需求的基础,也是维护人员的技术支持文档之一。
    2. 支持目标系统的确认。软件开发目标是否完成不应由系统测试阶段的人为因素决定,而应根据需求规格说明书确立的可测试标准决定。
    3. 控制系统进化过程。在需求分析完成后,如果用户追加需求,那么需求规格说明书将用于确定追加需求是否为新需求。如果是,开发人员必须针对新需求进行需求分析,扩充需求规格说明书,进行软件再设计。
    1. 详细设计说明书

    本文档的编写为了系统软件的开发途径和应用方法,以求开发者在最短的时间高效的开发并完成该系统。

    1. 数据库设计说明书

    本说明书说明项目的数据库设计、结构情况,用于开发人员进行项目设计,同时也为后续的数据库维护工作提供了良好的使用说明,也可以作为未来版本升级的重要资料。

    数据库是一个项目中最重要的部分,如果数据库出现各种各样的问题,编写的软件再好也可能成为废品,没有数据库作为支持,编写的任何代码都没有用武之地。

    1. 测试计划

    根据测试计划报告,对软件进行测试,详细记录测试过程,以对软件的食量进行评价,对软件设计人员提供BUG依据。

    测试计划是在项目开发的过程中制定的,为测试提供各种测试方案,可以方便更加查找项目中的BUG。

    1. 测试分析报告

    为了发现软件更多的错误,根据测试计划进行各种测试,并详细的将测试结果详细的解释清楚。

    1. 项目开发总结报告

    为了总结本项目开发工作的经验,说明实际取得的开发结果以及对整个开发工作的各个方面的评价,说明本项目的工作流程,工程开发中状况,最终结果,经验教训等。

    1. 操作手册和用户手册

    目的是为了给用户提供帮助,对于没有接触过本系统的用户能够学会使用本系统。通过本文档,能够让用户熟练使用本系统。

    操作手册和用户手册是给用户看的,最简单的目的就是让未使用过此系统用户看到这个文档时能够在最短的时间内,可以高效的使用本系统。就像平常生活中的各种说明书,虽然我们没哟接触过某一个商品,但是通过使用说明书可以在最短的时间内掌握,并灵活运用。

    1. 开发进度月报

           为项目组长掌握开发进度提供最可靠的依据,高效的完成软件的开发,并为项目的开发总结报告提供各项依据。


    三总结


           软件工程是编程的基础,文档就是程序员的助手,文档至关重要。


    软件工程的学习是很简单的,希望我的分享对您有帮助,并希望大家提供宝贵的建议。

    详解软件工程之第一要务需求分析

    详解软件工程之学习方法

    详解软件工程之软件测试

    详解软件工程之软工文档(总结篇)


  • 3
    点赞
  • 16
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 19
    评论
非常全名,包括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.用户操作举例
软件工程文档模板(完整规范版) , 1. 范围 1 2. 总体要求 1 2.1 总体功能要求 1 2.2 软件开发平台要求 1 2.3 软件项目的开发实施过程管理要求 2 2.3.1 软件项目实施过程总体要求 2 2.3.2 软件项目实施变更要求 2 2.3.3 软件项目实施里程碑控制 2 3. 软件开发 3 3.1 软件的需求分析 3 3.1.1 需求分析 3 3.1.2 需求分析报告的编制者 4 3.1.3 需求报告评审 4 3.1.4 需求报告格式 4 3.2 软件的概要设计 4 3.2.1 概要设计 4 3.2.2 编写概要设计的要求 4 3.2.3 概要设计报告的编写者 4 3.2.4 概要设计和需求分析、详细设计之间的关系和区别 4 3.2.5 概要设计的评审 4 3.2.6 概要设计格式 4 3.3 软件的详细设计 5 3.3.1 详细设计 5 3.3.2 特例 5 3.3.3 详细设计的要求 5 3.3.4 数据库设计 5 3.3.5 详细设计的评审 5 3.3.6 详细设计格式 5 3.4 软件的编码 5 3.4.1 软件编码 5 3.4.2 软件编码的要求 5 3.4.3 编码的评审 6 3.4.4 编程规范及要求 6 3.5 软件的测试 6 3.5.1 软件测试 6 3.5.2 测试计划 6 3.6 软件的交付准备 6 3.6.1 交付清单 6 3.7 软件的鉴定验收 7 3.7.1 软件的鉴定验收 7 3.7.2 验收人员 7 3.7.3 验收具体内容 7 3.7.4 软件验收测试大纲 7 3.8 培训 7 3.8.1 系统应用培训 7 3.8.2 系统管理的培训(可选) 8 附录A 软件需求分析报告文档模板 9 附录B 软件概要设计报告文档模板 21 附录C 软件详细设计报告文档模板 33 附录D 软件数据库设计报告文档模板 43 附录E 软件测试(验收)大纲 55

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

程序猿小亮

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值