精华内容
参与话题
问答
  • 软件开发常用文档(16个文档),包含:项目开发计划;可行性研究报告;软件文档;概要设计说明书;软件需求说明书;数据库设计说明书;详细设计说明书;测试计划。。。。。。
  • 软件开发文档-详细设计文档

    万次阅读 2019-06-21 11:22:34
    帮助开发人员理解项目的业务逻辑术语描述执行标准与相关文档 编码标准,文件管理标准,版本管理标准项目概述 1.背景 2.现状项目目标编码规范系统功能概述 系统功能总图系统总体介绍系统模块设计 模块结构图,...

    引言

    引言也称前言、序言或概述经常作为科技论文的开端,提出文中要研究的问题,引导读者阅读和理解全文


    编写目的

    帮助开发人员理解项目的业务逻辑


    术语描述


    执行标准与相关文档

    编码标准,文件管理标准,版本管理标准


    项目概述

    1、背景
    2、现状

    项目目标

    最终要实现的目标

    编码规范

    前端规范,后台规范,数据库规范,中间件使用规范


    系统功能概述

    系统功能总图

    系统总体介绍

    描述下系统的总体情况

    系统模块设计

    模块结构图,模块汇总表,功能简述


    模块功能点

    【功能描述:说明该程序应具有的功能,功能结构图,原型界面,可采用IPO图(即输入一处理一输出图),类图,用例图等。】

    1、输入项

    【给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。】

    2、输出项

    【给出对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。】

    3、算法

    【详细说明本程序所选用的算法,具体的计算公式和计算步骤。】

    4、逻辑流程

    【用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。】

    5、接口

    【用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构。】

    6、存储分配

    【根据需要,说明本程序的存储分配。】

    7、注释设计

    【说明准备在本程序中安排的注释,如:

    a. 加在模块首部的注释;

    b. 加在各分枝点处的注释;

    c. 对各变量的功能、范围、缺省条件等所加的注释;

    d. 对使用的逻辑所加的注释等等。】

    8、限制条件

    【说明本程序运行中所受到的限制条件】

    9、测试计划

    【说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定】

    展开全文
  • 软件开发技术文档编写规范

    万次阅读 多人点赞 2017-12-29 09:40:14
    在项目开发过程中,应该按要求编写好十三种文档文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。  ◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述...

    在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。

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

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

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

      ◇概要设计说明书:该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。

      ◇详细设计说明书:着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。

      ◇用户操作手册:本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。

      ◇测试计划:为做好集成测试和验收测试,需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

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

      ◇开发进度月报:该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

      ◇项目开发总结报告:软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。

      ◇软件维护手册:主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明,便于软件的维护。

      ◇软件问题报告:指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。

    ◇ 软件修改报告:软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。

    1    可行性分析报告

    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.5技术可行性评价:包括

      ● 在限制条件下,功能目的是否达到

      ● 利用现有技术,功能目的是否达到

      ● 对开发人员数量和质量的要求,并说明能否满足

      ● 在规定的期限内,开发能否完成

     

    5所建议系统经济可行性分析

    5.1支出

    5.2效益

    5.3收益/投资比

    5.4投资回收周期

    5.5敏感性分析:指一些关键性因素,如:

      ● 系统生存周期长短

      ● 系统工作负荷量

      ● 处理速度要求

      ● 设备和软件配置变化对支出和效益的影响等的分析

     

    6社会因素可行性分析

    6.1法律因素:如

      ● 合同责任

      ● 侵犯专利权

      ● 侵犯版权

    6.2用户使用可行性:如

      ● 用户单位的行政管理

      ● 工作制度

      ● 人员素质等能否满足要求

     

    7其他可供选择的方案

      逐个阐明其它可供选择的方案,并重点说明未被推荐的理由。

    8结论意见

      ● 可着手组织开发

      ● 需等待若干条件具备后才能开发

      ● 需对开发目标进行某些修改

      ● 不能进行或不必进行

      ● 其它

    2    项目开发计划

    1引言

    1.1编写目的:阐明编写可行性研究报告的目的,提出读者对象

    1.2项目背景:应包括

      ● 项目的委托单位、开发单位和主管部门;

      ● 该软件系统与其他系统的关系。

    1.3定义:列出文档中用到的专门术语的定义和缩写词的原文

    1.4参考资料:可包括:

      ● 项目经核准的计划任务书、合同或上级机关的批文

      ● 文档所引用的资料、规范等

      ● 列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源;

     

    2项目概述

    2.1工作内容:简要说明项目的各项主要工作,介绍所开发软件的功能、性能等;若不编写可行性研究报告;则应在本节给出较详细的介绍;

    2.2条件与限制: 阐明为完成项目应具备的条件、开发单位已具备的条件以及尚需创造的条件。必要时还应说明用户及分合同承担的工作、完成期限及其他条件与限制。

    2.3产品

    2.3.1程序:列出应交付的程序名称、使用的语言及存储形式。

    2.3.2文档:列出应交付的文档。

    2.4运行环境:应包括硬件环境、软件环境。

    2.5服务:阐明开发单位可向用户提供的服务。如人员培训、安装、保修、维护和其他运行支持。

    2.6验收标准

     

    3实施计划

    3.1任务分解:任务的划分及各项任务的负责人。

    3.2进度:按阶段完成的项目,用图表说明开始时间、完成时间。

    3.3预算

    3.4关键问题:说明可能影响项目的关键问题,如设备条件、技术难点或其他风险因素,并说明对策。

     

    4人员组织及分工

     

    5交付期限

     

    6专题计划要点

      如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。

     

     

    3    软件需求说明书

    1引言

    1.1编写目的:阐明编写需求说明书的目的,指明读者对象。

    1.2项目背景:应包括

      ● 项目的委托单位、开心单位和主管部门;

      ● 该软件系统与其他系统的关系。

    1.3定义:列出文档中所用到的专门术语的定义和缩写词的愿文。

    1.4参考资料:可包括

      ● 项目经核准的计划任务书、合同或上级机关的批文

      ● 文档所引用的资料、规范等

      ● 列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源

     

    2任务概述

    2.1目标

    2.2运行环境

    2.3条件与限制

     

    3数据描述

    3.1表态数据

    3.2动态数据:包括输入数据和输出数据。

    3.3数据库描述:给出使用数据库的名称和类型。

    3.4数据词典

    3.5数据采集

     

    4功能需求

    4.1功能划分

    4.2功能描述

     

    5性能需求

    5.1数据精确度

    5.2时间特性:如响应时间、更新处理时间、数据转换与传输时间、运行时间等。

    5.3适应性:在操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时,应具有的适应能力。

     

    6运行需求

    6.1用户界面:如屏幕格式、报表格式、菜单格式、输入输出时间等。

    6.2硬件接口

    6.3软件接口

    6.4故障处理

     

    7其他需求

      如可使用性、安全保密、可维护性、可移植性等。

     

     

    4    概要设计说明书

    1引言

    1.1写目的:阐明编写概要设计说明书的目的,指明读者对象。

    1.2项目背景:应包括

      ● 项目的委托单位、开发单位和主管部门

      ● 该软件系统与其他系统的关系。

    1.3定义:列出本文档中所用到的专门术语的定义和缩写词的愿意。

    1.4参考资料:

      ● 列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源

      ●项目经核准的计划任务书、合同或上级机关的批文;项目开发计划;需求规格说明书;测试计划(初稿);用户操作手册

      ● 文档所引用的资料、采用的标准或规范。

     

    2任务概述

    2.1目标

    2.2需求概述

    2.3条件与限制

     

    3总体设计

    3.2总体结构和模块外部设计

    3.3功能分配:表明各项功能与程序结构的关系。

     

    4接口设计

    4.1外部接口:包括用户界面、软件接口与硬件接口。

    4.2内部接口:模块之间的接口。

     

    5数据结构设计

     

    6逻辑结构设计

      所有文档的统一封面格式如下页所示。

     

    7物理结构设计

     

    8数据结构与程序的关系

     

    9运行设计

    9.1运行模块的组合

    9.2运行控制

    9.3运行时间

     

    10出错处理设计

    10.1出错输出信息

    10.2出错处理对策:如设置后备、性能降级、恢复及再启动等。

     

    11安全保密设计

     

    12维护设计

      说明为方便维护工作的设施,如维护模块等。

    5    详细设计说明书

    1引言

    1.1编写目的:阐明编写详细设计说明书的目的,指明读者对象。

    1.2项目背景:应包括项目的来源和主管部门等。

    1.3定义:列出本文档中所用到的专门术语的定义和缩写词的愿意。

    1.4参考资料:

      ● 列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源

      ●项目经核准的计划任务书、合同或上级机关的批文;项目开发计划;需求规格说明书;概要设计说明书;测试计划(初稿);用户操作手册

      ● 文档所引用的资料、软件开发的标准或规范。

     

    2总体设计

    2.1需求概述

    2.2软件结构:如给出软件系统的结构图。

     

    3程序描述

    3.1逐个模块给出以下说明:

      ● 功能

      ● 性能

      ● 输入项目

      ● 输出项目

    3.2算法:模块所选用的算法。

    3.3程序逻辑:详细描述模块实现的算法,可采用:标准流程图;PDL语言;N-S图;判定表等描述算法的图表。

    3.4接口

      ● 存储分配

      ● 限制条件

    3.5测试要点:给出测试模块的主要测试要求。

     

     

    6    用户操作手册

    1引言

    1.1编写目的:阐明编写手册的目的,指明读者对象。

    1.2项目背景:说明项目的来源、委托单位、开发单位及和主管部门。

    1.3定义:列出手册中使用的专门术语的定义和缩写词的愿意。

    1.4参考资料:

      ● 列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源

      ● 项目经核准的计划任务书、合同或上级机关的批文;项目开发计划;需求规格说明书;概要设计说明书;详细设计说明书;测试计划

      ● 文档中所引用的其他资料、采用的软件工程标准或软件工程规范。

     

    2软件概述

    2.1目标

    2.2功能

    2.3性能

    2.4数据精确度:包括输入、输出及处理数据的精度。

    2.5时间特性:如响应时间、处理时间、数据传输时间等。

    2.6灵活性:在操作方式、运行环境需做某些变更时软件的适应能力。

     

    3运行环境

    3.1硬件

      ● 列出软件系统运行时所需的硬件最小配置,如计算机型号、主存容量

      ● 外存储器、媒体、记录格式、设备型号及数量

      ● 输入、输出设备

      ● 数据传输设备及数据转换设备的型号及数量。

    3.2支持软件

      ● 操作系统名称及版本号

      ● 语言编译系统或汇编系统的名称及版本号

      ● 数据库管理系统的名称及版本号

      ● 其他必要的支持软件

     

    4使用说明

    4.1安装和初始化:给出程序的存储形式、操作命令、反馈信息及其做含意、表明安装完成的测试实例以及安装所需的软件工具等。

    4.2输入:给出输入数据或参数的要求。

      ● 数据背景:说明数据来源、存储媒体、出现频度、限制和质量管理等。

      ● 数据格式:如长度、格式基准、标号、顺序、分隔符、词汇表、省略和重复、控制。

      ● 输入举例。

    4.3输出:给出每项输出数据的说明。

      ● 数据背景:说明输出数据的去向、使用频度、存放媒体及质量管理等。

      ● 数据格式:详细阐明每一输出数据的格式,如首部、主体和尾部的具体形式。

      ● 举例

    4.4出错和恢复:给出出错信息及其含意;用户应采取的措施,如修改、恢复、再启动。

    4.5求助查询:说明如何操作。

     

    5运行说明

    5.1运行表:列出每种可能的运行情况,说明其运行目的。

    5.2运行步骤:按顺序说明每和运行的步骤,应包括:

    5.3运行控制

    5.4操作信息:运行目的、运行目的、操作要求、启动方法、预计运行时间、操作命令格式及说明、其他事项;

    5.5输入/输出文件:给出建立或更新文件的有关信息,如:文件的名称及编号;记录媒体;存留的目录;文件的支配:说明确定保留文件或废弃文件的准则,分发文件的对象,战胜硬件的优先级及保密控制等。

    5.6启动或恢复过程

     

    6非常规过程

      提供应急戒非常规操作的必要信息及操作步骤,如出错处理操作、向后备系统切换操作及维护人员须知的操作和注意事项。

     

    7操作命令一览表

      按字母顺序逐个列出全部操作命令的格式、功能及参数说明。

     

    8程序文件(或命令文件)和数据文件一览表

      按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

     

    9用户操作举例

     

    7    测试计划

    1引言

    1.1编写目的:阐明编写测试计划的目的并指明读者对象。

    1.2项目背景:说明项目的来源、委托单位及主管部门。

    1.3定义:列出测试 计划中所用到的专门术语的定义和缩写词的原意。

    1.4参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:项目的计划任务书、合同或批文;项目开发计划;需求规格说明书;概要设计说明书;详细设计说明书;用户操作手册;本测试计划中引用的其他资料、采用的软件开发标准或规范。

     

    2任务概述

    2.1目标

    2.2运行环境

    2.3需求概述

    2.4条件与限制

     

    3计划

    3.1测试方案:说明测试方法和选取测试用例的原则。

    3.2测试项目:列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。

    3.3测试准备

    3.4测试机构及人员:测试机构名称、负责人和职责。

     

    4测试项目说明

    4.1按顺序逐个对测试项目做出说明

      4.1.1 测试项目名称及测试内容

      4.1.2 测试用例

      4.1.3 输入:输入的数据和输入命令。

      4.1.4 输出:预期的输出数据。

    4.2步骤及操作

    4.3允许偏差:给出实测结果与预期结果之间允许偏差的范围。

    4.4进度

    4.5条件:给出项测试对资源的特殊要求,如设备、软件、人员等。

    4.6测试资料:说明项测试所需的资料。

     

    5评价

    5.1范围:说明所完成的各项测试说明问题的范围及其局限性。

    5.2准则:说明评论测试结果的准则。

     

    8    测试分析报告

    1引言

    1.1编写目的:阐明编写测试分析报告的目的并指明读者对象。

    1.2项目背景:说明项目的来源、委托单位及主管部门。

    1.3定义:列出测试分析报告中所用到的专门术语的定义和缩写词的原意。

    1.4参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:项目的计划任务书、合同或批文;项目开发计划;需求规格说明书;概要设计说明书;详细设计说明书;用户操作手册;测试计划;测试分析报告所引用的其他资料、采用的软件工程标准或工程规范。

     

    2测试计划招待情况

    2.1机构和人员:给出测试机构名称、负责人和参与测试人员名单。

    2.2测试结果:按顺序给出每一测试项目的:实测结果数据;与预期结果数据的偏差;该项测试表明的事实;该项测试发现的问题。

     

    3软件需求测试结论

      按顺序给出每一项需求测试的结论。包括:证实的软件能力;局限性(即项需求未得到充分测试的情况及原因。

     

    4评价

    4.1软件能力:经过测试所表明的软件能力。

    4.2缺陷和限制:说明测试所揭露的软件缺陷和不足,以及可能给软件运行带来的影响。

    4.3建议:提出为弥补上述缺陷的建议。

    4.4测试结论:说明能否通过。

    9    开发进度月报

    1报告时间及所处的开发阶段

     

    2工程进度

    2.1本月内的主要活动

    2.2实际进展与计划比较

     

    3所用工时

      按不同层次人员分别计时。

    4所用机时

      按所用计算机机型分别计时。

    5经费支出

      分类列出本月经费支出项目,给出支出总额,并与计划比较。

    6工作遇到的问题及采取的对策

    7本月完成的成果

    8下月的工作计划

    9特殊问题

     

    10       项目开发总结报告

    1引言

    1.1编写目的:阐明编写总结报告的目的并指明读者对象。

    1.2项目背景:说明项目的来源、委托单位、开发单位及主管部门。

    1.3定义:列出报告中所用到的专门术语的定义和缩写词的原意。

    1.4参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:项目的计划任务书、合同或批文;项目开发计划;需求规格说明书;概要设计说明书;详细设计说明书;用户操作手册;测试计划;测试分析报告;本报告引用的其他资料、采用的开发标准或开发规范。

     

    2开发结果

    2.1产品:可包括列出各部分的程序名称、源程序行数(包括注释行)或目标程序字节数及程序总计数量、存储形式;产品文档名称等。

    2.2主要功能及性能

    2.3所用工时:按人员的不同层次分别计时。

    2.4所用机时:按所用计算机机型分别计时。

    2.5进度:给出计划进度与实际进度的对比。

    2.6费用

     

    3评价

    3.1生产率评价:如平均每人每月生产的源程序行数、文档的字数等。

    3.2技术方案评价

    3.3产品质量评价

    4经验与教训

     

    11       软件维护手册

    1引言

    1.1编写目的:阐明编写手册的目的并指明读者对象。

    1.2项目背景:说明项目的提出者、开发者、用户和使用场所。

    1.3定义:列出报告中所用到的专门术语的定义和缩写词的原意。

    1.4参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,及保密级别,可包括:用户操作手册;与本项目有关的其他文档。

     

    2系统说明

    2.1系统用途:说明系统具备的功能,输入和输出。

    2.2安全保密:说明系统安全保密方面的考虑。

    2.3总体说明:说明系统的总体功能,对系统、子系统和作业做出综合性的介绍,并用图表的方式给出系统主要部分的内部关系。

    2.4程序说明:说明系统中每一程序、分程序的细节和特性。

    2.4.1程序1的说明

      ● 功能:说明程序的功能。

      ● 方法:说明实现方法。

      ● 输入:说明程序的输入、媒体、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。

      ● 处理:处理特点和目的,如:用图表说明程序的运行的逻辑流程;程序主要转移条件;对程序的约束条件;程序结束时的出口要求;与下一个程序的通信与联结(运行、控制);由该程序产生并茶馆处理程序段使用的输出数据类型和存放单元;程序运行存储量、类型及存储位置等。

      ● 输出:程序的输出。

      ● 接口:本程序与本系统其他部分的接口。

      ●表格:说明程序内部的各种表、项的细节和特性。对每张表的说明至少包括:表的标识符;使用目的;使用此表的其他程序;逻辑划分,如块或部,不包括表项;表的基本结构;设计安排,包括表的控制信息。表目结构细节、使用中的特有性质及各表项的标识、位置、用途、类型、编码表示。

      ● 特有的运行性质:说明在用户操作手册中没有提到的运行性质。

    2.4.2程序2的说明

      与程序1的说明相同。以后的其他各程序的说明相同。

     

    3操作环境

    3.1设备:逐项说明系统的设备配置及其特性。

    3.2支持软件:列出系统使用的支持软件,包括它们的名称和版本号。

    3.3数据库:说明每个数据库的性质和内容,包括安全考虑。

    3.3.1总体特征:如标识符、使用这些数据库的程序、静态数据、动态数据;数据库的存储媒体;程序使用数据库的限制。

    3.3.2结构及详细说明

      ● 说明该数据库的结构,包括其中的记录和项。

      ● 说明记录的组成,包括首部或控制段、记录体。

      ● 说明每个记录结构的字段,包括:标记或标号、字段的字符长度和位数、该字段的允许值范围。

      ● 扩充:说明为记录追加字段的规定。

     

    4维护过程

    4.1约定:列出该软件系统设计中所使用全部规则和约定,包括:程序、分程序、记录、字段和存储区的标识或标号助记符的使用规则;图表的处理标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号名;使用的软件技术标准;标准化的数据元素及其特征。

    4.2验证过程:说明一个程序段修改后,对其进行验证的要求和过程(包括测试程序和数据)及程序周期性验证的过程。

    4.3出错及纠正方法:列出出错状态及其纠正方法。

    4.4专门维护过程:说明文档其他地方没有提到的专门维护过程。如:维护该软件系统的输入输出部分(如数据库)的要求、过程和验证方法;运行程序库维护系统所必需的要求、过程和验证方法;对闰年、世纪变更的所需要的临时性修改等。

    4.5专用维护程序:列出维护软件系统使用的后备技术和专用程序(如文件恢复程序、淘汰过时文件的程序等)的目录,并加以说明,内容包括:维护作业的输入输出要求;输入的详细过程及在硬设备上建立、运行并完成维护作业的操作步骤。

    4.6程序清单和流程图:引用或提供附录给出程序清单和流程图。

     

    12       软件问题报告

    1登记号

      由软件配置管理部门为该报告规定一个唯一的、顺序的编号。

    2登记日期

      软件配置管理部门登记该报告的日期。

    3问题发现日期

      发现该问题的日期和时间。

    4活动

      在哪个阶段发现的问题,分为单元测试、组装测试、确认测试和运行维护。

    5状态

      在软件配置记录中维护的动态指示,状态表示有:正在复查"软件问题报告",以确定将采取什么行动;"软件问题报告"已由指定的人去进行处理;修改已完成,并经过测试,正准备交给主程序库;主程序库已经更新,主程序库修改的重新测试沿未完成;做了重新测试,问题再现;做了重新测试,所做的修改无故障,"软件问题报告"被关闭;留待以后关闭。

    6报告人

      填写"软件问题报告"人员的姓名、地址、电话。

    7问题属于什么方面

      区分是程序的问题,还是模块的问题,或是数据库的问题,文件的问题。也可能是它们的某种组合。

    8模块/子系统

      出现的模块名。如果不知是哪个模块,可标出子系统名,尽量给出细节。

    9修订版本号

      出现问题的模块版本。

    10磁带

      包含有问题的模块的主程序库的磁带的标识符。

    11数据库

      当发现问题时所使用数据库的标识符。

    12文件号

      有错误的文件的编号。

    13测试用例

      发现错误时所使用测试用例的标识符。

    14硬件

      发现错误时所使用的计算机系统的标识。

    15问题描述/影响

      问题症兆的详细描述。如果可能,则写明实际问题所在。也要给出该问题对将来测试、接口软件和文件等的影响。

    16附注

      记载补充信息。

     

    13       软件修改报告

    1登记号

      由软件配置管理部门为该报告规定的编号。

    2登记日期

      软件配置管理部门登记"软件修改报告"的日期。

    3时间

      准备好"软件修改报告"的日期。

    4报告人

      填写该报告的作者。

    5子系统名

      受修改影响的子系统名。

    6模块名

      被修改的模块名。

    7"软件问题报告"的编号

      被"软件修改报告"处理或部分处理的"软件问题报告"的编号。如果某"软件问题报告"的问题只是部分被处理,则在编号后附以p,如1234p。

    8修改

      包括程序修改、文件更新、数据库修改或它们的组合。

    9修改描述

      修改的详细描述。如果是文件更新或数据库修改,还要列出文件更新通知或数据库修改申请的标识符。

    10批准人

      批准人签字,正式批准进行修改。

    11语句类型

      程序修改中涉及到的语句类型,包括:输入/输出语句类、计算语句类、逻辑控制语句类、数据处理语句类(如数据传送、存取语句类)。

    12程序名

      被修改的程序、文件或数据库的名字。

    13老修订版

      当前的版本/修订本标识。

    14新修订版

      修改后的版本/修订本标识。

    15数据库

      如果申请数据库修改,则给出数据库的标识符。

    16数据库修改报告

      数据库修改申请号。

    17文件

      如果要求对文件进行修改,则给出文件的名字。

    18文件更新

      文件更新通知单的编号。

    19修改是否已测试

      指出已对修改做了哪些测试,如单元、子系统、组装、确认和运行测试等,并注明测试成功与否。

    20"软件问题报告"是否给出问题的准确描述

      回答'是'或'否'。

    21问题注释

      准确地叙述要维护的问题。

    22问题源

      指明问题来自于哪里,如软件需求说明书、设计说明书、数据库、源程序等。

    23资源

      完成修改所需资源的估计,即总的人时数和计算机时间的开销。

    展开全文
  • golang相关在线学习文档

    千次阅读 2020-10-23 21:11:18
    https://flydk.gitbooks.io/go/content/ch1/ch1-01.htmlgo圣经 https://www.kancloud.cn/kancloud/web-application-with-golang/44160goweb... https://www.kancloud.cn/shuangdeyu/gin_book/949436gogin中文版文档

    https://flydk.gitbooks.io/go/content/ch1/ch1-01.html   go圣经
           https://www.kancloud.cn/kancloud/web-application-with-golang/44160  go web编程
           https://www.kancloud.cn/shuangdeyu/gin_book/949436  go gin中文版文档
           https://www.bookstack.cn/read/gin-docs-zh/d806a8735717b3df.md  gin web文档

     

    展开全文
  • HTTP文档

    2020-07-01 19:32:51
    是客户端与服务端传输文本的一种协议标准 ...hrrps协议(加密传输)端口443 一、请求方法 get(获取信息页面) post(上传,修改,添加,服务端信息) ...trace(回显服务器收到的请求,主要用于测试或诊断) ...

    http

    • 是客户端与服务端传输文本的一种协议标准
    • http协议是无状态的
    • http协议默认端口是80
    • hrrps协议(加密传输)端口443

    一、请求方法

    • get(获取信息页面)
    • post(上传,修改,添加,服务端信息)
    • put(修改)
    • delete(删除)
    • head(只返回头信息)
    • trace(回显服务器收到的请求,主要用于测试或诊断)
    • connect(HTTP/1.1协议中预留给能够将连接改为管道方式的代理服务器)
    • options(客户端查看服务器性能)

    二、请求报文

    1. 建立TCP连接

    在HTTP工作开始之前,Web浏览器首先要通过网络与Web服务器建立连接,该连接是通过TCP来完成的,该协议与IP协议共同构建
    Internet,即著名的TCP/IP协议族,因此Internet又被称作是TCP/IP网络。HTTP是比TCP更高层次的应用层协议,根据规则,
    只有低层协议建立之后才能,才能进行更层协议的连接,因此,首先要建立TCP连接,一般TCP连接的端口号是80。

    1. Web浏览器向Web服务器发送请求命令

    一旦建立了TCP连接,Web浏览器就会向Web服务器发送请求命令。例如:GET/sample/hello.jsp HTTP/1.1。

    1. Web浏览器发送请求头信息

    浏览器发送其请求命令之后,还要以头信息的形式向Web服务器发送一些别的信息,之后浏览器发送了一空白行来通知服务器,它已经结束了该头信息的发送。

    1. Web服务器应答

    客户机向服务器发出请求后,服务器会客户机回送应答, HTTP/1.1 200 OK ,应答的第一部分是协议的版本号和应答状态码。

    1. Web服务器发送应答头信息

    正如客户端会随同请求发送关于自身的信息一样,服务器也会随同应答向用户发送关于它自己的数据及被请求的文档。

    1. Web服务器向浏览器发送数据

    Web服务器向浏览器发送头信息后,它会发送一个空白行来表示头信息的发送到此为结束,接着,它就以Content-Type应答头信息所描述的格式发送用户所请求的实际数据。

    1. Web服务器关闭TCP连接

    一般情况下,一旦Web服务器向浏览器发送了请求数据,它就要关闭TCP连接,然后如果浏览器或者服务器在其头信息加入了这行代码:

    三、HTTP响应报文

    在这里插入图片描述
    HTTP响应报文主要由状态行、响应头部、空行以及响应数据组成。

    1.状态行

    由3部分组成,分别为:协议版本,状态码,状态码描述。

    其中协议版本与请求报文一致,状态码描述是对状态码的简单描述,所以这里就只介绍状态码。

    状态码

    状态代码为3位数字。 1xx:指示信息–表示请求已接收,继续处理。 2xx:成功–表示请求已被成功接收、理解、接受。
    3xx:重定向–要完成请求必须进行更进一步的操作。 4xx:客户端错误–请求有语法错误或请求无法实现。
    5xx:服务器端错误–服务器未能实现合法的请求。

    下面列举几个常见的:
    在这里插入图片描述
    2.响应头部

    与请求头部类似,为响应报文添加了一些附加信息

    常见响应头部如下:
    在这里插入图片描述
    3.响应数据

    用于存放需要返回给客户端的数据信息。

    下面是一个响应报文的实例:

    HTTP/1.1 200 OK  状态行
    Date: Sun, 17 Mar 2013 08:12:54 GMT  响应头部
    Server: Apache/2.2.8 (Win32) PHP/5.2.5
    X-Powered-By: PHP/5.2.5
    Set-Cookie: PHPSESSID=c0huq7pdkmm5gg6osoe3mgjmm3; path=/
    Expires: Thu, 19 Nov 1981 08:52:00 GMT
    Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
    Pragma: no-cache
    Content-Length: 4393
    Keep-Alive: timeout=5, max=100
    Connection: Keep-Alive
    Content-Type: text/html; charset=utf-8
      空行
    
    <html>  响应数据
    <head>
    <title>HTTP响应示例<title>
    </head>
    <body>
    Hello HTTP!
    </body>
    </html>
    

    四、http状态码

    1xx:响应

    2xx:成功

    2XX系列响应代码表明操作成功了。

    • 200 get请求成功
    • 201修改成功

    3xx:重定向

    3XX系列响应代码表明:客户端需要做些额外工作才能得到所需要的资源。它们通常用于GET请求。他们通常告诉客户端需要向另一个URI发送GET请求,才能得到所需的表示。那个URI就包含在Location响应报头里。

    • 302 临时重定向
    • 304 未修改
    • 307 临时重定向

    4xx:客户端的问题

    这些响应代码表明客户端出现错误。不是认证信息有问题,就是表示格式或HTTP库本身有问题。客户端需要自行改正。

    • 401 未授权
    • 403 禁止访问
    • 404 找不到

    5xx:服务器问题

    这些响应代码表明服务器端出现错误。

    • 500 服务器内部错误
    • 503 服务器找不到
    • 504 超时

    五、GET和POST请求

    在这里插入图片描述

    • get可以收藏地址,post不能
    • get可以缓存,post不能缓存
    • get 的内存2048kb,post无限
    • get请求在浏览器地址显示,留历史记录,post参数不会在地址显示,不留历史记录

    六、http特点

    1、无连接:一次处理一个链接,处理完直接关闭
    2、无状态:没有历史记录功能,处理完断开,客户端和服务互相不了解
    3、简单快捷:get 和post 还有header求情方式
    4、灵活:不同content-type返回上传不同数据类型
    5、支持BS和CS

    七、互联网专业名词

    1、B/S架构:Browser/Server,浏览器/服务器模式
    2、C/S架构:Client-Server(C/S)结构
    3、To B 产品:各种管理系统,技术负责,图表多
    4、ToC 产品:客户直接使用的产品/要求好看,任性化
    5、B2C :Businiess To Customer 商家对个人 例如: 京东、淘宝
    6、B2B :Businiess To Businiess 商家对商家 例如:1688
    7、C 2 C:Customer To Customer 个人对个人 例:咸鱼 转转
    8、O2O:online To Offline 线上支付 线下 消费 例:美团
    9、P2P:个人对个人 例子:理财

    展开全文
  • 实施文档

    2020-11-18 13:42:48
    分类专栏: 企业管理杂谈 文章标签: 文档 文档管理 项目管理 工作 配置管理 工具 项目实施文档是用来记录、描述、展示实施过程中一系列信息的处理过程,通过书面或图示的形式对项目活动过程或结果进行描述、定义、...
  • 产品介绍文档

    2018-06-04 16:21:50
    作为产品的开发思路和产品特点的介绍文档,从产品的设计到自主研发,生产和销售,欢迎各界人士合作
  • 文档

    2020-11-18 21:32:55
    f=open(“C:/Users/86188/Desktop.txt”).read() # 打开文档 f=f.replace(’,’,’’).replace(’.’,’’).replace(’"’,’’).replace(’:’,’’) # 去标点 f=f.split() # 单词化 r=collections.Counter(f) # ...
  • title: 入坑 docsify,一款神奇的文档生成利器! tagline: by 沉默王二 tags: - java Guide 哥是我认识的一个非常优秀的年轻人,胖嘟嘟的身躯里充斥着无穷无尽的才华,他的JavaGuide在 GitHub 上已经标星 91K+ 了...
  • OpenKM安装及详细配置-绝对实用

    千次阅读 热门讨论 2018-12-14 11:03:37
    作者:FCyunwei 参考文章:https://blog.csdn.net/li_cheng_liang/article/details/78899348 ... 前言 所谓万事开头难,初次接触OpenKM也是从百度查资料开始,但发现真正有价值的文章不多。 在windows平台参考C...
  • HTML5所有常用元素 - <!--...-->注释 - <html>根元素 - <head>页面头部分 - <title>页面标题 - <body>页面主体部分 - <h1>到<h6>定义标题一到六 ...定...
  • Java API文档 中文网页版

    万次下载 热门讨论 2007-03-21 14:25:52
    Java API文档中文版,欢迎下载!!
  • 最新java ee api中文版帮助文档 chm格式

    千次下载 热门讨论 2013-04-10 20:52:44
    最新java ee api帮助文档 ,chm格式的。中文版和英文版两版本,网上好不容易找到的
  • Java 中文 API文档

    千次阅读 2019-01-10 10:04:37
    API 开发人员文档 Java 2 Platform 软件包 java.applet 提供创建 applet 所必需的类和 applet 用来与其 applet 上下文通信的类。 java.awt 包含用于创建用户界面和绘制图形图像的所有类。 java.awt.col...
  • API文档访问与调试概述通常我们要构建API 服务,自然少不了文档,但由于API文档的分离使得我们每次对API进行的更改都需要再去修改文档后同步文档,不但编写稳定繁琐而且稍有纰漏难免就会出现调用的异常,而编写、...
  • JavaFX API文档

    2008-12-08 10:24:47
    JavaFX API文档 JavaFX API文档 JavaFX API文档
  • 13 ArcGIS API for JavaScript开发入门文档

    千次阅读 热门讨论 2020-09-04 12:53:47
    这篇文章写在我用ArcGIS API for JavaScript(后面统称为"ArcGIS JS API")开发了两年项目后的某一天夜里。写这篇文章主要是两个目的吧,第一个原因肯定是为后面越来越多的从事WebGIS开发的GISer提供一个学习路线,...
  • Spring项目集成apidoc生成api接口文档

    万次阅读 2018-01-29 14:05:24
     JavaWeb/spring项目写成的api接口,需要自动生成api文档,甚至需要在线测试接口。考虑实现的方案有swagger,apidoc,spring rest docs。在之后的项目都有一一尝试,最终还是觉得apidoc的方式比较合适,虽然有一些...
  • nodejs API 中文文档

    2019-02-10 14:03:56
    nodejs API 中文文档,这份文档的翻译工作始于 2016年 4月初,由于翻译量较大,加之 Node.js 官方版本更新较快,因而目前尚无法跟上官网的(版本)更新节奏。但整体算是比较新的了。适合新手入门或者当作 使用手册 ...
  • 本文介绍一个非常好用的自动化生成 Restful API 文档的工具——Api2Doc 它基于 SpringBoot ,原理类似于 Swagger2,但比 Swagger2 要简单好用。 目录 项目背景 Api2Doc 简介 引入 Api2Doc 依赖 启用 Api2Doc ...
  • c/c++中文帮助文档API

    千次下载 热门讨论 2008-04-20 14:23:09
    c/c++中文帮助文档API),包含c和c++所有的库函数
  • Java API文档的阅读技巧

    万次阅读 2017-12-01 12:04:28
    1、Api文档的阅读技巧,先读主干,了解功能,在看枝叶,英文也是如此 2、java api文档再使用的时候,尽量少的使用搜索,而是通过目录寻找,这样可以帮助你熟悉目标类所在的具体位置 3、左侧蓝色的比较大的是...
  • webAPI文档

    2016-07-31 15:49:50
    jdk,xpath,jsp,servlet,mysql,js,jquery,dom4j,正则表达式等api.chm, web开发涉及的大部分api都有了,方便web开发使用!
  • poi中文api文档

    万次阅读 2017-05-03 11:44:36
    POI中文API文档 一、 POI简介 Apache POI是Apache软件基金会的开放源码函式库,POI提供API给Java程序对Microsoft Office格式档案读和写的功能。 二、 HSSF概况 HSSF 是Horrible SpreadSheet Format的缩写,通过...
  • Documentation for Android SDK(API 19) Android SDK 官方使用说明文档,对应Android 4.4.2 开发库。 系列文件共分3个压缩文件: Android API 离线文档.part01.rar Android API 离线文档.part02.rar Android API ...
  • java API接口文档

    2013-03-07 12:03:04
    API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
  • JS API文档生成工具jsdoc加强版

    热门讨论 2009-04-14 15:30:49
    随着Javascript脚本的日益强大,对js的api生成工具的需求也是与日俱增,经过本人下载使用过的多个js api文档生成工具的比较,并对其中一款(jsdoc)进行了部分改进,感觉对于日常的基于js代码的api文档的生成大有帮助...
  • ElasticSearch文档API

    千次阅读 2016-12-27 15:18:23
    ElasticSearch 5.x 创建索引 index API
  • jQuery EasyUI 1.3.5 离线简体中文API文档

    千次下载 热门讨论 2013-12-18 20:58:05
    (译者注:该点更新内容官方更新公告上没有注明,具体内容和用法请看datebox的API。) 历史版本: - jQuery EasyUI 1.3.4 离线API简体中文版 http://download.csdn.net/detail/richie696/6302785 - jQuery EasyUI ...
  • api模板文档

    2017-09-15 09:54:16
    接口模板,主要接口概述、接口路径设计、接口请求方式、接口返回数据规则,具体的接口要求有接口地址、协议、参数、接口说明、返回说明、返回格式

空空如也

1 2 3 4 5 ... 20
收藏数 5,480,274
精华内容 2,192,109
关键字:

文档