软件开发文档 订阅
软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。 展开全文
软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。
信息
提    高
软件开发的效率
分    类
开发文档
中文名
软件开发文档
保    证
软件的质量
软件开发文档简介
软件文档可以分为开发文档和产品文档两大类。开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《 QA 文档》、《项目总结》等。产品文档包括:《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》。用户文档《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。
收起全文
精华内容
下载资源
问答
  • 软件开发文档

    2015-09-08 15:36:12
    软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。 目录 ...
    软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。

    1简介编辑

    软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。
    软件文档可以分为开发文档和产品文档两大类。
    开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《 QA 文档》、《项目总结》等。 产品文档包括:《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》。用户文档《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。

    2分类编辑

    开发文档

    1. 《功能要求》 -- 来源于客户要求和市场调查,是软件开发中最早期的一个环节。客户提出一个模糊的功能概念,或者要求解决一个实际问题,或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书,把他们的要求全部列表书写在文档中,必要时加以图表解说。这份文档是需求分析的基础。
    2. 《投标方案》 -- 根据用户的功能要求,经过与招标方沟通和确认,技术人员开始书写《投标方案》,方案书一般包括以下几个重要的章节: 前言 -- 项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析 -- 项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案 -- 总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理 -- 描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。 技术支持 -- 公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。 系统报价 -- 软、硬件平台报价列表、软件开发费用、系统维护费用等。 项目进度 -- 整个项目的进度计划,包括签署合同、项目启动、需求分析系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。
    3. 《需求分析》 -- 包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础,进行详细的功能分析 ( 包括客户提出的要求和根据开发经验建议的功能 ) ,列出本产品是什么,有什么特殊的概念,包括哪些功能分类,需要具备什么功能,该功能的操作如何,实现的时候该注意什么细节,客户有什么要求,系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。
    4. 《技术分析》 -- 包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价,竞争对手技术分析等。以《需求分析》为基础,进行详细的技术分析 ( 产品的性能和实现方法 ) ,列出本项目需要使用什么技术方案,为什么,有哪些技术问题要解决 ,估计开发期间会碰到什么困难,技术方案以后如何升级,对本项目的技术有什么评价等。
    5. 《系统分析》 -- 包括功能实现、模块组成、功能流程图、函数接口、数据字典软件开发需要考虑的各种问题等。以《需求分析》为基础,进行详细的系统分析 ( 产品的开发和实现方法 ) ,估计开发期间需要把什么问题说明白,程序员根据《系统分析》,开始在项目主管的带领下进行编码。
    6. 《数据库文档》 -- 包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础,进行详细的数据库设计。必要时可以用图表解说,特别是关系数据库。
    7. 《功能函数文档》 -- 包括变量名、变量初植、功能,函数名,参数,如何调用、备注、注意事项等。以《系统分析》为基础,进行详细的说明,列出哪个功能涉及多少个函数,以便以后程序员修改、接手和扩展。
    8. 《界面文档》 -- 包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求,这里与软件完成后的运行界面是一致的。
    9. 《编译手册》 -- 包括服务器编译环境、操作系统、编译工具、 GNU 的 C++ 编译器版本信息、目录说明、程序生成、源程序文件列表、 Makefile 配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。
    10. 《 QA 文档》 -- 包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等,提供给软件测试人员使用。
    11. 《项目总结》 -- 包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。

    产品文档

    1. 《产品简介》 -- 包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。
    2. 《产品演示》 -- 包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用 Power point 或者 VCD 录制软件实现。
    3. 《疑问解答》 -- 列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。
    4. 《功能介绍》 -- 以《需求分析》为书写基础,包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。
    5. 《技术白皮书》 -- 以《技术分析》为书写基础,包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。
    6. 《评测报告》 -- 第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。
    7. 《安装手册》 -- 包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。
    8. 《使用手册》 -- 包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。
    9. 《维护手册》 -- 包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。
    10. 《用户报告》 -- 包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。
    11. 《销售培训》 -- 包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。

    软件开发文档

    第一、需求分析文档[1]
    什么是用户需求分析文档呢?也就是在和客户进行沟通时,把用户所要求的信息记录下来,根据用户的要求进行需求分析,规划出我们要开发的软件所要实现哪些功能。
    第二、概要设计文档[1]
    概要设计:顾名思义,就是对我们所要开发的软件进行一个整体的概括,把这个软件所包含的功能模块作一个设计,以后我们在开发的时候就有目标,有方向了。
    第三、系统设计文档[1]
    系统设计,就是对概要的一个详细的实施,就是分析我们所要开发软件各大功能模块中所包含的小模块,把这些小模块都一一列举出来,然后再对软件开发人员进行有条理的进行开发任务的分配。
    第四、详细设计文档[1]
    详细设计文档,主要是把我们每个小模块,小功能的业务逻辑处理用文字的方式表达出来,让程序员在编码的时候有一个依据和参照;同时,在进行详细文档设计的时候,有的软件公司也会根据不同的项目作出相应的《软件开发代码规范》[2]性文档。以保障我们所做工作的统一性。
    第五、软件测试文档[1]
    当我们参照软件详细设计文档编码完成后,接着就会根据我们所实现的功能,进行软件测试文档的编写;大多测试文档有两类,一类是软件单体测试文档,一类是软件结合测试文档;顾名思义,单体测试:就是对软件中每个小的方法,一个独立的方法进行测试的文档;结合测试:就是把多个功能模块组合到一起进行测试,主要是为了检测每个功能模块之前的交互性和功能的结合实现性。
    第六、软件完成后的总结汇报型文档[1]
    不管所开发软件的规模大小,在一个软件开发结束后,我们都会把开发过中的问题和项目开发总结一起记录下来,以防以后在开发过程中再有类似问题出现,提高我们的开发效率。
    根据软件开发公司的规模、标准和客户的需求不同,[1]开发文档的种类和数量也不同,我在这里和大家讨论的软件开发相关文档都是最基础的;在软件行业有一句话:一个软件能否顺利的完成并且功能是否完善,重要是看这个软件有多少文档,软件开发文档是一个软件的支柱,如果你的开发文档漏洞百出,那么你所开发出来的软件也不可能会好;开发文档的好坏可以直接影响到所开发出来软件的成功与否。
    展开全文
  • 国家标准软件开发文档模板

    千次下载 热门讨论 2009-12-02 09:51:47
    国家标准软件开发文档模板,包括:操作手册(GB8567——88)、测试分析报告(GB8567——88)、测试计划(GB8567——88)、概要设计说明书(GB8567——88)、开发进度月报(GB8567——88)、可行性研究报告(GB8567...
  • 软件开发文档总结

    千次阅读 2015-11-01 21:06:40
    前言:  最近一个多星期都写在文档,刚开始写文档... 软件开发文档是软件开发和维护过程中的必备资料。它能提高软件的开发效率,保证软件的质量,而且在软件的使用过程中有指导、帮助、解惑的作用。尤其是在维护阶段

      前言:      

           最近一个多星期都写在文档,刚开始写文档的时候简直是一头雾水,而且也觉得写文档是一个枯燥乏味的过程。如今已经把文档写完啦,也开始意识到了文档的重要性。下面谈一谈自己对文档的一些理解和看法。

    是什么?

          软件开发文档是软件开发和维护过程中的必备资料。它能提高软件的开发效率,保证软件的质量,而且在软件的使用过程中有指导、帮助、解惑的作用。尤其是在维护阶段,文档更是不可缺少的资料。可以毫不夸张地说文档已经成为了软件的一部分。从某个意义上来说,文档比程序更重要。

    分类:

          按照文档的使用范围和目标对象,将文档分为三类:开发文档、管理文档、产品文档。

                        

           按照软件工程的开发阶段进行分类,即定义阶段、开发阶段、运维阶段、如下图

                                     

    对每一个文档的理解:

    (1)可行性研究报告:

           说明在项目进行前,对项目从经济可行性、技术可行性、社会环境可行性等几个方面确定该项目公司是否要接手。阐述为了达到开发目标,所采用的各种可行性方案。以及论证所选方案的理由。

    (2)项目开发计划:

           此项目开发计划的编写主要是为了给开发系统做主要的规划和整合,在开发过程中起引导的作用,以及为软件使用人员的使用提供一些简单的声明。项目开发计划应交给管理部门,作为开发阶段评审的参考。

    (3)软件需求说明书:(软件规格说明书)

           软件需求说明书是用户与开发人员双发在对软件需求,取得一致性理解的基础上,对目标软件的功能、性能用户界面以及运行环境等做出详细的说明。还能够在一定程度上,控制系统进化过程。在需求分析完成后,如果用户追加需求,那么需求规格说明书将用于确定追加需求是否为新需求。如果是,开发人员必须针对新需求进行需求分析,扩充需求规格说明书,进行软件再设计。

    (4)数据要求说明书:

           明确需采集数据的信息系统,数据采集的范围和方法,为生成和维护系统数据文卷做好准备。

    (5)数据库设计说明书:

            明确系统的物理结构和数据结构,用于开发人员进行项目设计。同时也为之后的数据库维护提供了一个很好的说明书,是数据库进行维护的重要材料。

    (6)概要设计说明书:

            说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据库设计和出错处理设计等,是概要设计的主要成果。为后续进一步的详细设计做好准备。

    (7)详细设计说明书:

            着重描述每一模块是怎么实现的,包括逻辑结构、流程结构以及算法等。以求开发者高效得完成该系统。

    (8)用户手册和操作手册:

             为用户提供帮助,让用户了解系统的功能、如何使用、以及如果解决软件使用过程中出现的一些小问题等情况。通过本文档的学习让用户能够快速全面的掌握本软件的使用方法。     

    (9)测试计划:

             根据测试计划报告,对软件进行测试,为测试提供各种测试方案。并记录详细的测试过程,以便于快速高效得查找出项目中的bug。

    (10)测试分析报告:

             测试工作完成后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论性意见和建议。

    (11)开发进度月表:

            该报告是软件开发人员按月向管理部门提交项目进度情况的报告,让管理人员对开发人员的项目进度能够有一个大概的了解,以便更好的完成开发工作。报告中应该包括进度计划以及实际的执行情况。阶段性成果,遇到的问题,以及是如何解决的等。

    (12)项目开发总结报告:

            软件项目开发阶段完成后,应该把实际开发情况与项目开发计划做一个对比。总结实际执行情况并对开发工作进行评价,指出开发此项目的经验和获得的教训。

    各个文档的读者:

            不同的文档是为不同的人员而书写的。下图中将展示各个文档的预期读者。

            

    总结:

            文档是软件开发和运维阶段必备的宝典,是软件开发过程中不可或缺的一部分。第一次写文档真的是无从下手,一头雾水,但是硬着头皮去做,写过一般之后,回过头来再看看。发现原来不太懂的东西似乎有写懂了。学习就是一个过程需要不断的去重复,重复就是力量!






            


    展开全文
  • 软件开发 | 如何写软件开发文档

    千次阅读 2019-10-15 15:52:34
    开发文档说明

    1. 需求规格说明

    依据什么需求,开发出什么

    2. 系统设计

    2.1 开发环境

    硬件开发平台:NVIDIA Jetson TX2
    工业相机:***
    操作系统:Ubuntu 16.04
    开发平台:ROS
    编程语言:Python、C++

    2.2 总体设计

    系统包含:数据采集、算法实现、结果输出

    2.2.1 数据采集

    在某某硬件平台上安装某某操作系统,安装ROS,安装驱动,采集数据

    2.2.2 算法实现

    采用深度学习、机器学习算法实现某某功能

    2.2.3 结果输出

    针对某某进行输出

    3. 编程实现

    程序流程图绘制

    4.集成

    集成包括内部模块的集成和与外部其他模块的集成。
    内部模块的集成,主要包括实时采集图像,输入到检测模块处理,然后保存结果供调试使用,最后将检测结果发送出去。
    与外部模块的集成,即决策模块,是通过ROS完成的,红绿灯识别模块和决策模块分别为两个节点,红绿灯识别节点发布带有检测结果的话题,决策节点订阅这个话题就可以获取检测结果。

    5.测试

    测试分为离线测试和在线测试。
    离线测试为搭建环境,训练模型,编程实现,测试结果,主要是在线测试前的准备过程。
    在线测试需要在真实场景下进行实车测试,检验方案的有效性

    6.维护

    此方案主要针对特定地点路口红绿灯的识别问题,如果场景变化,还要重新采集数据集进行训练。
    目前版本对GPU依赖较高,同时存在实时性不高的问题,后期会优化模型,使用或研发性能更好的框架进行模型的训练。

    参考链接:https://blog.csdn.net/learning_tortosie/article/details/79959969

    展开全文
  • 软件开发文档总集

    千次阅读 2015-02-09 10:03:05
    第一部分 软件开发文档……………第2页 一:软件需求说明书………………………………………………………..第2页 二:概要设计规格说明书……………………………………………………………第3页 三 :详细设计规格...
    目录
    第一部分 软件开发文档……………第2页
    一:软件需求说明书………………………………………………………..第2页
    二:概要设计规格说明书……………………………………………………………第3页
    三 :详细设计规格说明书……………………………………………….第4页
    四:模块开发卷宗………………………………………………第5页
    第二部分 软件管理文档……………第7页
    一:可行性研究报告………………………………………….第7页
    二:项目开发计划………………………………………………第9页
    第三部分 测试计划……………………..第10页
    一:概要 ………………………………………………………….第10页
    二:详细测试计划………………………………………………第10页
    三:测试人员的测试实施计划……………………………第10页
    四:测试分析报告………………………………………………第11页
    五:开发进度月报:…………………………………………….第12页
    六:项目开发总结……………………………………………….第13页
    第四部分 用户文档 ………………第14页
    一:用户手册……………………………………………………….第14页
    二:操作手册……………………………………………………….第15页
    三:维护建议……………………………………………………….第16页

    第五部分 文档编制例子………………….第17页

    第2 页 共18 页
    第一部分 软件开发文档
    软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计
    说明书、可行性研究报告、项目开发计划。
    一:软件需求说明书
    软件需求说明书也称为软件规格说明。该说明书对所开发软件的功能、性能、用户
    界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理
    解基础上达成的协议,也是实施开发工作的基础。软件需求说明书的编制目的的就是
    为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解、并使之面成为
    整个开发工作的基础。
    其格式如下:
    1 引言
    1.1 编写目的。
    1.2 背景
    1.3 定义
    2 任务概述
    2.1 目标
    2.2 用户的特点
    2.3 假定和约束
    3 需求规定
    3.1 对功能的规定
    3.2 对性能的规定
    3.2.1 精度
    3.2.2 时间特性的需求
    3.2.3 灵活性
    3.3 输入输出要求
    3.4 数据管理能力要求
    3.5 故障处理要求
    3.6 其他专门要求
    4 运行环境规定
    4.1 设备
    4.2 支持软件
    4.3 接口
    4.4 控制

    二:概要设计规格说明书
    概要设计说明书又可称系统设计说明书,这里所说的系统是指程序系统。编制的目
    的是说明对程序系统的设计考虑,包括程序系统的基本处理。流程、程序系统的组织
    结构、模块划分、功能分配、接口设计。运河行设计、数据结构设计和出错处理设计
    等,为程序的详细设计提供基础。
    其格式要求如下:
    1 引言
    1.1 编写目的
    1.2 背景
    1.3 定义
    1.4 参考资料
    2 总体设计
    2.1 需求规定
    2.2 运行环境
    2.3 基本设计概念和处理流程
    2.4 结构
    2.5 功能需求与程序的关系
    2.6 人工处理过程
    2.7 尚未解决的问题
    3 接口设计
    3.1 用户接口
    3.2 外部接口
    3.。3 内部接口
    4 运行设计
    4.1 运行模块的组合
    4.2 运行控制
    4.3 运行时间
    5 系统数据结构设计
    5.1 逻辑结构设计要点
    5.2 物理结构设计要求
    5.3 数据结构与程序的关系
    6 系统出错处理设计
    6.1 出错信息
    6.2 补救措施
    6.3 系统维护设计

    三 :详细设计规格说明书
    详细设计说明书又可称程序设计说明书。编制目的是说明一个软件系统各个层次中
    的每一个程序(每人模块或子程序)的设计考虑,如果一个软件系比较简单,层次很
    少,本文件可以不单独编写,有关内容合并入概要设计说明书。
    基格式如下:
    1 引言
    1.1 编写目的
    1.2 背景
    1.3 定义
    1.4 参考资料
    2 程序设计系统的结构
    3 程序1(标识符)设计说明
    3.1 程序描述
    3.2 功能
    3.3 性能
    3.4 输入项
    3.5 输出项
    3.6 算法
    3.7 流程逻辑
    3.8 接口
    3.9 存储分配
    3.10 注释设计
    3.11 限制条件
    3.。12 测试计划
    3.13 尚未解决的问题
    4 程序2(标识符)设计说明

    四:模块开发卷宗
    模块开发卷宗是在模块开发过程中逐步编写出来的,每完成一个模块或一组密切相
    关的模块的复制进编写一份,应该把所有的模块开发卷宗汇集在一起。编写的目的是记
    录和汇意低层次开发的进度和结果,经便于对整个模块开发工作的管理和复审,并为
    将来的维护提供非常有用的技术信息。
    具体的格式要求如下:
    1 标题
    2 模块开发情况表
    3 功能说明
    4 设计说明
    5 源代码清单
    6 测试说明
    7 复审的结论
    其中模块开发情况表的格式如下表
    模块标识符
    模块的描述性名称
    代码设计
    计划开始日

    实际开始日

    计划完成日

    实际完成日

    模块测试
    计划开始日

    实际开始日

    计划开始日

    软件开发文档总集 soon(整理) 计算机07 级04 班
    第6 页 共18 页
    实际开始日

    组装测试
    计划开始日

    实际开始日

    计划开始日

    实际开始日

    代码复查日期/筌字
    源代码行数 预计
    实际
    目际模块大

    预计
    实际
    模块际识符
    项目负责人批准日期/签字

    第二部分 软件管理文档
    一:可行性研究报告
    可行性研究报告的编写目的是:说明该软件开发项目的实现在技术、经济和社会条
    件方面的可行性:评述为了合理达到开发目标而可能选择的各种方案;说明并论证所选
    定的方案。可行性研究报告的编写格式要求如下所示:
    1 引言
    1.1 编写目的
    1.2 背景
    1.3 定义
    1.4 参考资料
    2 可行性研究的前提
    2.1 要求
    2.2 目标
    2.3 条件、假定和限制
    2.4 进行可行性研究的方法
    2.5 评价尺度
    3 对现有系统的分析
    3.1 处理流程和数据流程
    3.2 工作负荷
    3.3 费用开支
    3.4 人员
    3.5 设备
    3.6 局限性
    4 所建议的系统
    4.1 对所建议系统的说明
    4.2 处理流程和数据流程
    4.3 改进之处
    4.4 影响
    4.4.1 结设备的影响
    4.4.2 对软件的影响
    4.4.3 对用户单位机构的影响
    4.4.4 对系统运行过程的影响
    4.4.5 对开发的影响

    4.4.6 对地点和设备的影响
    4.4.7 对经费开支的影响
    4.5 局限性
    4.6 技术条件方面的可行性
    5 可选择的其他系统的可行性
    5.1 可选择的系统方案1
    5.2 可选择的系统方案2
    5.3 。。。。。。。。。。。
    6 投资及效益分析
    6.1 支出
    6.1.1 基本建设投资
    6.1.2 其他一次性支出
    6.1.3 非一次性支出
    6.2 收益
    6.2.1 一次性收益
    6.2.2 非一次性收益
    6.2.3 不可定量的收益
    6.3 收益投资比
    6.4 投资回收周期
    6.5 敏感性分析
    7 社会因素方面的可行性
    7.1 法律方面的可行性
    7.2 使用方面的可行性
    8 结论

    二:项目开发计划
    软件项目开发计划即为软件项目实施方案制定出的具体计划。项目开发计划应提前
    给管理部门,并作为开发阶段评审的基础。编制项目开发计划的止的是用文件的形
    式,把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需的软
    硬条件等问题做出的安排记载下来,以便根据本计划开展和检查项目的开发工作。编
    制内容的格式要求如下:
    1 引言
    1.1 编写目的
    1.2 定义
    1.3 参考资料
    2 项目概述
    2.1 工作内容
    2.2 主要参加人员
    2.3 产品
    2.3.1 程序
    2.3.2 方件
    2.3.3 服务
    2.3.4 非移交的产品
    2.4 验收标准
    2.5 完成项目的最迟期限
    2.6 本计划的批准者和批准日期
    3 实施计划
    3.1 工作任务的分配与人员分工
    3.2 接口人员
    3.3 进度
    3.4 预算
    3.5 关键问题
    4 支持条件
    4.1 计算机系统支持
    4.2 需收用户承担的工作
    4.3 由外单位提供的条件
    5 专题计划要点

    第三部分 测试计划
    一:概要
    概要测试计划是软件项目实施计划中的一项重要的内容,应当在软件开发初期、即
    需求分析阶段制订。
    项计划应当定义被测试对象和测试目标,确定测试阶段和测试周期的划分;制订测
    试人员、软硬件资源和测试进度等方面的计划,规定软件测试方法,测试标准以及支持
    环境和测试工具。
    二:详细测试计划
    详细测试计划是针对子系统在特定的测试阶段所要进行的测试工作制订详细计划,
    它详细说明规定了测试小组的各项测试任务,测试策略、任务分配和进度安排等。
    三:测试人员的测试实施计划
    测试人员的测试实施计划是根据详细计划制订的测试者的测试具体实施计划。它
    规定了测试者在每一轮测试中负责测试的内容,测试强度和工作进度等。测试实施计
    划是整个软件测试的组成部分,是检查测试实际执行情况的重要依据。
    测试计划的具体的格式具体要求如下
    1 引言
    1.1 编写目的
    1.2 背景
    1.3 定义
    1.4 参考资料
    2 计划
    2.1 软件说明
    2.2 测试内容
    2.3 测试1(标识符)
    2.3.1 进度安排
    2.3.2 条件
    2.3.3 测试资料
    2.3.4 测试培训
    2.4 测试2(标识符)

    3 测试设计说明
    3.1 测试1(标识符)
    3.1.1 控制
    3.1.2 输入
    3.1.3 输出
    3.1.4 过程
    3.2 测试2(标识符)
    4 评价准则
    4.1 范围
    4.2 数据整理
    4.3 尺度
    四:测试分析报告
    测试工作完成以后,应当提交测试计划情况说明书,对测试结果加以分析,并提
    出测试的结论性意见,具体格式要求如下:
    1 引言
    1.1 编写目的
    1.2 背景
    1.3 定义
    1.4 参考资料
    2 测试概要
    3 测试结果及发现
    3.1 测试1(标识符)
    3.2 测试2(标识符)
    4 对软件功能的结论
    4.1 功能1(标识符)
    4.1.1 能力
    4.1.2 限制
    4.2 功能2(标识符)
    4.3 。。。。。。。。
    5 分析摘要
    5.1 能力
    5.2 缺陷和限制
    5.3 建议
    5.4 评价
    6 测试资源消耗

    五:开发进度月报:
    开发进度月报的编制目的是及时向有关部门汇报项目开发的进度和情况,以便及时
    发现和处理开发过程中出现的问题,一般,开发进度月报是以项目组单位每月编写的。
    如果被开发的软件系统规模比较大,整个工程项目被划分给若干个分项目驵承担,开
    发进度月报将以分项目为单位搂月编写。
    开发进度月报具体的格式要求如下:
    1 标题
    2 工程进度与状态
    2.1 进度
    2.2 状态
    3 资源耗用与状态
    3.1 资源耗用
    3.1.1 工时
    3.1.3 机时
    3.2 状态
    4 经费支出与状态
    4.1 经费支出
    4.1.1 支持性费用
    4.1.2 设备购置费
    4.2 状态
    5 下一个月的工作计划
    6 建议

    六:项目开发总结
    软件项目开发完成之后,应当与项目实施计划对照,总结实际执行的情况,如进度、
    成果、资源利用、成本和投入的人力。此外,还需对开发工作做出评价,总结经验和教
    训。项目开发总结报告的编制是为了总结本项目开发工作的经验,说明实际取得的开
    发结果以及对整个开发工作的各个方面的评价。具体的格式要求如下:
    1 引言
    1.1 编写目的
    1.2 背景
    1.3 定义
    1.4 参考资料
    2 实际开以结果
    2.1 产品
    2.2 主要功能和性能
    2.3 基本流程
    2.4 进度
    2.5 费用
    3 开发工作评价
    3.1 对生产效率的评价
    3.2 对产品质量的评价
    3.3 对技术方法的评价
    3.4 出错原因的分析
    4 经验与教训


    第四部分 用户文档
    一:用户手册
    用户手册的编制是要使用非专门术语的语言,充分地描述该软件系统所具有的功能
    及基本的使用方法,使用户(或潜在用户)通过本手册能够了解该软件的用途,并且能
    够确定在什么情况下,如何使用它,具体的格式要求如下:
    1 引言
    1.1 编写目的
    1.2 背景
    1.3 定义
    1.4 参考资料
    2 用途
    2.1 功能
    2.2 性能
    2.2.1 精度
    2.2.2 时间特性
    2.2.3 灵活性
    2.3 安全保密
    3 运行环境
    3.1 硬设备
    3.2 支持软件
    3.3 数据结构
    4 使用过程
    4.1 安装与初始化
    4.2 输入
    4.2.1 输入数据的现实背景
    4.2.2 输入格式
    4.2.3 输入举例
    4.3 输出
    4.3.1 输出数据的现实背景
    4.3.2 输出格式
    4.3.3 输出举例
    4.4 文卷查询
    4.5 出错处理和恢复
    4.6 终端操作


    二:操作手册
    操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识,
    包括操作方法的细节,具体的格式要求如下:
    1 引言
    1.1 编写目的
    1.2 背景
    1.3 定义
    1.4 参考资料
    2 软件征述
    2.1 软件的结构
    2.2 程序表
    2.3 文卷表
    3 安装与初始化
    4 运行说明
    4.1 运行表
    4.2 运行步骤
    4.3 运行1(标识符)说明
    4.3.1 运行控制
    4.3.2 操作控制
    4.3.3 输入——输出文卷
    4.3.4 输出文段
    4.3.5 输出文段的复制
    4.3.6 恢复过程
    4.4 运行2(标识符)说明
    5 非常规过程
    6 远程操作

    三:维护建议
    软件产品投入运行之后,可能有修改、更正等问题。应当对存在的问题、修改的
    考虑以及修改的影响估计等作详细的描述,写成维护修改建议、提交审批。
    具体的内容要求在国际上并未作详细的规定,所以在此我们将大致介绍一下维护修
    改建议文档的写法,其格式如下:
    1 引言
    1.1 综述
    1.2 术语及缩写语
    1.3 参考资料
    2 程序结构描述
    3 维护过程
    3.1 启动
    3.2 系统的查询及事件报告功能
    3.3 硬件状态能功能描述
    4 出错处理及非常规过程
    4.1 系统重启动过程
    4.2 严重故障时的紧急处理
    4.3 一般故障的处理
    4.4 数据备份工作
    5 附录
    5.1 附录一
    5.2 附录二

    第五部分 文档编制例子
    文档首见如下:
    文档标题
    文档主题
    文档编号:ABC—RA-MIS-R-XXX01
    文档版本:2。0
    文档标题用于说明项目的名称,文档主题用于说明本文档的内容,文档编号和文
    档版本主要用于归档和检索,它们分别引用自该文档的页眉。要保持文档标题信息和
    页眉的一至,
    页眉的格式如下:
    工和名称: 文档标题 工程阶段: 需求分析
    文档名称: 文档主题
    阅览范围:
    作者: Author 审核:
    生成日期: 修改日期:
    文档编号: 文档版本:


    展开全文
  • 软件开发文档模板

    万次阅读 多人点赞 2018-08-13 15:55:49
    2.2 软件开发平台要求 2.3 软件项目的开发实施过程管理要求 2.3.1 软件项目实施过程总体要求 2.3.2 软件项目实施变更要求 2.3.3 软件项目实施里程碑控制 3. 软件开发 3.1 软件的需求分析 3.1.1 需求...
  • 软件开发文档范例

    热门讨论 2015-03-16 14:34:25
     说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述 为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案 的理由。  2.◇ 项目开发计划:  为软件项目实施方案...
  • 软件开发中常见英文缩写和各类软件开发文档的英文缩写: 文章复制粘贴来源于:http://blog.sina.com.cn/s/blog_7326867a0100yfdl.html 英文简写 文档名称 MRD market requirement document...
  • 软件开发文档-详细设计文档

    万次阅读 2019-06-21 11:22:34
    帮助开发人员理解项目的业务逻辑术语描述执行标准与相关文档 编码标准,文件管理标准,版本管理标准项目概述 1.背景 2.现状项目目标编码规范系统功能概述 系统功能总图系统总体介绍系统模块设计 模块结构图,...
  • 软件开发文档是软件开发使用和维护中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。  软件文档可以分为开发文档和...
  • 软件开发文档大全

    千次下载 热门讨论 2006-12-31 10:48:22
    包括了软件开发过程中的各类文档的模版
  • 完整的全套 软件开发文档模板

    热门讨论 2008-06-13 16:44:29
    完整的全套 软件开发文档模板 各个方面基本都有
  • 软件开发文档汇总

    2018-12-17 20:10:10
     ◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。  ◇项目开发计划:为软件项目...
  • 软件开发文档模板(全套)

    千次下载 热门讨论 2018-05-18 11:42:45
    2、项目开发计划 3、需求规格说明书 4、概要设计说明书 5、详细设计说明书 6、用户操作手册 7、测试计划 8、测试分析报告 9、开发进度月报 10、项目开发总结报告 11、程序维护手册 12、软件问题报告 13、...
  • java软件开发文档

    2017-02-16 14:46:47
    一、需求文档,功能文档 二、业务流程文档 三、接口文档 四、DB文档 ...五、测试文档 ...六、网络环境文档 ...软件安装文档 九、上线文档 1程序类 源代码 字体库 程序清单 部署文档 2DB类 DB脚本 图文说明

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 32,171
精华内容 12,868
关键字:

软件开发文档