软件工程文档总结




    吐槽一下

    写文档之前,纠结了好长时间,不知道怎么写、文档完成了之后做总结,感觉又来了、

    我在想,是不是别人在第一次写这个东西的时候也这么纠结、


    搜集了好多文档的模板来看,找找感觉吧、

    

    


    在都编辑完了之后发现这些文档也挺有规律性的,从一个软件开发之前,到开发完了之后都是需要有文档做辅助的,尤其是在编写“用户手册”的时候,也是在这篇文档上感触非常大,--为人民服务!

   

    想起了之前忘了在哪里听到或看到的一句话,文档的质量、厚度、在很大程度上决定了这个软件的优秀与否、可能这是第一次写这个让人有点头疼的东西,感觉还不是很多,业绩理解到这里了、不过还有接下来的好多次文档,盲人摸象,一点一点的来吧、


    接下来,就简单的赘述一下对文档的小小理解:


    可行性研究报告:

        它是在要做一个项目的时候来分析这个项目实施的可行性、有效性、技术方案及技术政策进行具体深入、细致的评价、以确定一个在技术上合理,在经济上核算的最优方案。

    项目开发计划书:

        在项目的开发过程中有关的 人员、进度、软硬件、已经出现问题的应对措施、编辑出来、以供开发者使用。

    软件需求说明书:

        能够使用户、开发者、等有一个对此软件项目共同的理解、明确了解此项目的需求,并可以作为验收的标准。

    数据要求说明书:

        ...


    


    用户手册:

        使用非专业及易理解的语言编辑出此软件的使用方法、技巧、让使用者简单上手。


        经过这次不成熟的文档,至少为下次编写文档打下了一定的基础、不聪明,但是会努力!

      

 



转载于:https://www.cnblogs.com/wangc66/p/5172177.html

非常全名,包括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、付费专栏及课程。

余额充值