软件开发技术文档-小猪cms 开发文档

软件开发技术文档编写规范编程规范下载仕学规范下载编程规范下载警徽规范下载编程规范下载在项目开发过程中，应该按要求编写好十三种文档，文档编制要求拥有针对性、精确性、清楚性、完好性、灵巧性、可追溯性。◇可行性解析报告：说明该软件开发项目的实此刻技术上、经济上和社会要素上的可行性，评论为了合理地达到开发目标可供选择的各种可能实行方案气瓶 现场处置方案 .pdf气瓶 现场处置方案 .doc见习基地管理方案.doc关于群访事件的化解方案建筑工地扬尘治理专项方案下载，说明并论证所选定实行方案的原由。◇项目开发计划：为软件项目实行方案制定出详细计划，应该包含各部分工作的负责人员、开发的进度、开发经费的估量、所需的硬件及软件资源等。◇软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运转环境等作出详细的说明。它是在用户与开发人员两方对软件需求获得共同理解并完成协议离婚协议模板下载合伙人协议 下载渠道分销协议免费下载授课协议下载敬业协议下载的条件下编写的，也是实行开发工作的基础。该说明书应给出数据逻辑和数据收集的各项要求，为生成和保护系统数据文件做好准备。◇大纲设计说明书：该说明书是大纲实质阶段的工作成就，它应说明功能分配、模块划分、程序的整体结构、输入输出以及接口设计、运转设计、数据结构设计和犯错办理设计等，为详细设计供应基础。

◇详细设计说明书：侧重描述每一模块是如何实现的，包含实现算法、逻辑流程等。◇用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件获得详细的认识,为操作人员提供该软件各种运转状况的相关知识，特别是操作方法的详细细节。◇测试计划：为做好集成测试和查收测试，需为如何组织测试制定实行计划。计划应包含测试的内容、进度、条件、人员、测试用例的采纳原则、测试结果同意的误差范围等。◇测试解析报告：测试工作完成此后，应提交测试计划执行状况的说明，对测试结果加以解析，并提出测试的结论建议。◇开发进度月报：该月报系软件人员按月向管理部门提交的项目进展状况报告，报告应包含进度计划与实质执行状况的比较、阶段成就、遇到的问题快递公司问题件快递公司问题件货款处理关于圆的周长面积重点题型关于解方程组的题及答案关于南海问题和解决的方法以及下个月的打算等。◇项目开发总结报告：软件项目开发完成此后，应与项目实行计划比较，总结实质执行的状况，如进度、成就、资源利用、成本和投入的人力，其余，还需对开发工作做出议论，总结出经验和教训。◇软件保护手册：主要包含软件系统说明、程序模块说明、操作环境、支持软件的说明、保护过程的说明，便于软件的维护。

◇软件问题报告：指出软件问题的登记状况，如日期、发现人、状态、问题所属模块等，为软件更正供应准备文档。◇软件更正报告：软件产品投入运转此后，发现了需对其进行修正、改正等问题，应将存在的问题、更正的考虑以及更正的影响作出详细的描述，提交审批。可行性解析报告前言1.1编写目的：说明编写可行性研究报告的目的，提出读者对象。1.2项目背景：应包含●所建议开发软件的名称●项目的任务提出者、开发者、用户及实现软件的单位●项目与其余软件或其余系统的关系。1.3定义：列出文档顶用到的特地术语的定义和缩写词的原文。1.4参照资料：列出相关资料的作者、标题、编号、发布日期、第一版单位或资料本源，可包含●项目经同意的计划任务书、合同或上司机关的批文●与项目相关的已发布的资料●文档中所引用的资料，所采纳的软件标准或规范可行性研究的前提2.1要求：列出并说明建议开发软件的的基本要求，如●功能●性能●输入/输出●基本的数据流程和办理流程●安全与保密要求●与软件相关的其余系统●完成日期2.2目标：可包含●人力与设施花费的节约●办理速度的提升●控制精度或生产力的提升●管理信息服务的改进●决策系统的改进●人员工作效率的提升2.3条件、假定和限制：可包含●建议开发软件运转的最短寿命●进行明显方案选择比较的限期●经费本源和使用限制●法律和政策方面的限制●硬件、软件、运转环境和开发环境的条件和限制●可利用的信息和资源●建议开发软件投入使用的最迟时间2.4可行性研究方法2.5决定可行性的主要要素对现有系统的解析3.1办理流程和数据流程3.2工作负荷3.3花费支出：如人力、设施、空间、支持性服务、资料等项开支3.4人员：列出所需人员的专业技术类型和数目3.5设施3.6限制性：说明现有系统存在的问题以及为何需要开发新的系统所建议技术可行性解析4.1对系统的简要描述4.2与现有系统比较的优胜性4.3办理流程和数据流程4.4采纳建议系统可能带来的影响●对设施的影响●对现有软件的影响●对用户的影响●对系统运转的影响●对开发环境的影响●对经费支出的影响4.5技术可行性议论:包含●在限制条件下，功能目的能否达到●利用现有技术，功能目的能否达到●对开发人员数目和质量的要求，并说明能否满足●在规定的限期内，开发能否完成所建议系统经济可行性解析5.1支出5.2效益5.3收益/投资比5.4投资回收周期5.5敏感性解析：指一些重点性要素，如：●系统生计周期长短●系统工作负荷量●办理速度要求●设施和软件配置变化对支出和效益的影响等的解析社会要素可行性解析6.1法律要素：如●合同责任●入侵专利权●入侵版权6.2用户使用可行性：如●用户单位的行政管理●工作制度关于办公室下班关闭电源制度矿山事故隐患举报和奖励制度制度下载人事管理制度doc盘点制度下载●人员素质等能否满足要求其余可供选择的方案逐一说明其余可供选择的方案，并重点说明未被介绍的原由。

结论建议可着手组织开发需等候若干条件具备后才能开发需对开发目标进行某些更正不可以进行或不用进行其余项目开发计划前言1.1编写目的：说明编写可行性研究报告的目的，提出读者对象1.2项目背景：应包含●项目的拜托单位、开发单位和主管部门；●该软件系统与其余系统的关系。1.3定义：列出文档顶用到的特地术语的定义和缩写词的原文1.4参照资料：可包含：●项目经同意的计划任务书、合同或上司机关的批文●文档所引用的资料、规范等●列出这些资料的作者、标题、编号、发布日期、第一版单位或资料本源；项目归纳2.1工作内容:简要说明项目的各项主要工作，介绍所开发软件的功能、性能等；若不编写可行性研究报告；则应在本节给出

较详细的介绍；2.2条件与限制:说明为完成项目应具备的条件、开发单位已具备的条件以及尚需创建的条件。必需时还应说明用户及分合同承担的工作、完成限期及其余条件与限制。2.3产品2.3.1程序：列出应交付的程序名称、使用的语言及储存形式。2.3.2文档：列出应交付的文档。2.4运转环境：应包含硬件环境、软件环境。2.5服务：说明开发单位可向用户供应的服务。如人员培训、安装、保修、保护和其余运转支持。2.6查收标准实行计划3.1任务分解：任务的划分及各项任务的负责人。3.2进度：按阶段完成的项目，用图表说明开始时间、完成时间。3.3估量3.4重点问题：说明可能影响项目的重点问题，如设施条件、技术难点或其余风险要素，并说明对策。人员组织及分工交付限期专题计划重点如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。软件需求说明书前言1.1编写目的：说明编写需求说明书的目的，指明读者对象。1.2项目背景：应包含●项目的拜托单位、高兴单位和主管部门；●该软件系统与其余系统的关系。1.3定义：列出文档中所用到的特地术语的定义和缩写词的愿文。1.4参照资料：可包含●项目经同意的计划任务书、合同或上司机关的批文●文档所引用的资料、规范等●列出这些资料的作者、标题、编号、发布日期、第一版单位或资料本源任务归纳2.1目标2.2运转环境2.3条件与限制数据描述3.1表态数据3.2动向数据：包含输入数据和输出数据。

3.3数据库描述：给出使用数据库的名称和种类。3.4数据词典3.5数据收集功能需求4.1功能划分4.2功能描述性能需求5.1数据精确度5.2时间特征：如响应时间、更新办理时间、数据变换与传输时间、运转时间等。5.3适应性：在操作方式、运转环境、与其余软件的接口以及开发计划等发生变化时，应拥有的适应能力。运转需求6.1用户界面：如屏幕格式、报表格式、菜单格式、输入输出时间等。6.2硬件接口6.3软件接口6.4故障办理其余需求如可使用性、安全保密、可保护性、可移植性等。大纲设计说明书前言1.1写目的：说明编写大纲设计说明书的目的，指明读者对象。1.2项目背景：应包含●项目的拜托单位、开发单位和主管部门●该软件系统与其余系统的关系。1.3定义：列出本文档中所用到的特地术语的定义和缩写词的愿意。1.4参照资料：●列出这些资料的作者、标题、编号、发布日期、第一版单位或资料本源●项目经同意的计划任务书、合同或上司机关的批文；项目开发计划；需求规格说明书；测试计划（底稿）；用户操作手册●文档所引用的资料、采纳的标准或规范。任务归纳2.1目标2.2需求归纳2.3条件与限制整体设计3.2整体结构和模块外面设计3.3功能分配：表示各项功能与程序结构的关系。

接口设计4.1外面接口：包含用户界面、软件接口与硬件接口。4.2内部接口：模块之间的接口。数据结构设计逻辑结构设计所有文档的一致封面格式以下页所示。物理结构设计数据结构与程序的关系运转设计9.1运转模块的组合9.2运转控制9.3运转时间犯错办理设计犯错输出信息犯错办理对策：如设置后备、性能降级、恢复及再启动等。安全保密设计保护设计说明为方便保护工作的设施，如保护模块等。详细设计说明书前言1.1编写目的：说明编写详细设计说明书的目的，指明读者对象。1.2项目背景：应包含项目的本源和主管部门等。1.3定义：列出本文档中所用到的特地术语的定义和缩写词的愿意。1.4参照资料：●列出相关资料的作者、标题、编号、发布日期、第一版单位或资料本源●项目经同意的计划任务书、合同或上司机关的批文；项目开发计划；需求规格说明书；大纲设计说明书；测试计划（初稿）；用户操作手册●文档所引用的资料、软件开发的标准或规范。整体设计2.1需求归纳2.2软件结构：如给出软件系统的结构图。程序描述3.1逐一模块给出以下说明：●功能●性能●输入项目●输出项目3.2算法：模块所采纳的算法。3.3程序逻辑：详细描述模块实现的算法软件开发技术文档，可采纳：标准流程图；PDL语言；N-S图；判断表等描述算法的图表。

3.4接口●储存分配●限制条件3.5测试重点：给出测试模块的主要测试要求。用户操作手册前言1.1编写目的：说明编写手册的目的，指明读者对象。1.2项目背景：说明项目的本源、拜托单位、开发单位及和主管部门。1.3定义：列出手册中使用的特地术语的定义和缩写词的愿意。1.4参照资料：●列出相关资料的作者、标题、编号、发布日期、第一版单位或资料本源●项目经同意的计划任务书、合同或上司机关的批文；项目开发计划；需求规格说明书；大纲设计说明书；详细设计说明书；测试计划●文档中所引用的其余资料、采纳的软件工程标准或软件工程规范。软件归纳2.1目标2.2功能2.3性能2.4数据精确度：包含输入、输出及办理数据的精度。2.5时间特征：如响应时间、办理时间、数据传输时间等。2.6灵巧性：在操作方式、运转环境需做某些改正时软件的适应能力。运转环境3.1硬件●列出软件系统运转时所需的硬件最小配置，如计算机型号、主存容量●外储存器、媒体、记录格式、设施型号及数目●输入、输出设施●数据传输设施及数据变换设施的型号及数目。3.2支持软件●操作系统名称及版本号●语言编译系统或汇编系统的名称及版本号●数据库管理系统的名称及版本号●其余必需的支持软件使用说明4.1安装和初始化：给出程序的储存形式、操作命令、反响信息及其做含意、表示安装完成的测试实例以及安装所需的软件工具等。4.2输入：给出输入数据或参数的要求。●数据背景：说明数据本源、储存媒体、出现频度、限制和质量管理等。●数据格式:如长度、格式基准、标号、序次、分开符、词汇表、省略和重复、控制。●输入举例。4.3输出：给出每项输出数据的说明。●数据背景：说明输出数据的

去向、使用频度、存放媒体及质量管理等。●数据格式：详细说明每一输出数据的格式，如首部、主体和尾部的详细形式。●举例4.4犯错和恢复：给出犯错信息及其含意；用户应采纳的措施，如更正、恢复、再启动。4.5求援盘问：说明如何操作。运转说明5.1运转表：列出每种可能的运转状况，说明其运转目的。5.2运转步骤：按序次说明每和运转的步骤，应包含：5.3运转控制5.4操作信息：运转目的、运转目的、操作要求、启动方法、估计运转时间、操作命令格式及说明、其余事项；5.5输入/输出文件：给出建立或更新文件的相关信息，如：文件的名称及编号；记录媒体；存留的目录；文件的支配：说明确定保留文件或荒弃文件的准则，发散文件的对象，战胜硬件的优先级及保密控制等。5.6启动或恢复过程特别规过程供应给急戒特别规操作的必需信息及操作步骤，如犯错办理操作、向后备系统切换操作及保护人员须知的操作和注意事项。操作命令一览表按字母序次逐一列出所有操作命令的格式、功能及参数说明。程前言件（或命令文件）和数据文件一览表按文件名字母序次或按功能与模块分类序次逐一列出文件名称、表记符及说明。用户操作举例测试计划前言1.1编写目的：说明编写测试计划的目的并指明读者对象。

1.2项目背景：说明项目的本源、拜托单位及主管部门。1.3定义：列出测试计划中所用到的特地术语的定义和缩写词的原意。1.4参照资料：列出相关资料的作者、标题、编号、发布日期、第一版单位或资料本源，可包含：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；大纲设计说明书；详细设计说明书；用户操作手册；本测试计划中引用的其余资料、采用的软件开发标准或规范。任务归纳2.1目标2.2运转环境2.3需求归纳2.4条件与限制计划3.1测试方案：说明测试方法和采纳测试用例的原则。3.2测试项目：列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。3.3测试准备3.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.1范围：说明所完成的各项测试说明问题的范围及其限制性。

5.2准则：说明议论测试结果的准则。测试解析报告前言1.1编写目的：说明编写测试解析报告的目的并指明读者对象。1.2项目背景：说明项目的本源、拜托单位及主管部门。1.3定义：列出测试解析报告中所用到的特地术语的定义和缩写词的原意。1.4参照资料：列出相关资料的作者、标题、编号、发布日期、第一版单位或资料本源，可包含：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；大纲设计说明书；详细设计说明书；用户操作手册；测试计划；测试解析报告所引用的其余资料、采纳的软件工程标准或工程规范。测试计划款待状况2.1机构和人员：给出测试机构名称、负责人和参加测试人员名单。2.2测试结果：按序次给出每一测试项目的：实测结果数据；与预期结果数据的误差；该项测试表示的事实；该项测试发现的问题。软件需求测试结论按序次给出每一项需求测试的结论。包含：证明的软件能力；限制性（即项需求未获得充分测试的状况及原由。议论4.1软件能力：经过测试所表示的软件能力。4.2缺点和限制：说明测试所揭示的软件缺点和不足，以及可能给软件运转带来的影响。4.3建议：提出为填充上述缺点的建议。4.4测试结论：说明能否经过。

开发进度月报报告时间及所处的开发阶段工程进度2.1本月内的主要活动2.2实质进展与计划比较所用工时按不一样层次人员分别计时。所用机时按所用计算机机型分别计时。经费支出分类列出本月经费支出项目，给出支出总数，并与计划比较。工作遇到的问题及采纳的对策本月完成的成就下月的工作计划特别问题项目开发总结报告前言1.1编写目的：说明编写总结报告的目的并指明读者对象。1.2项目背景：说明项目的本源、拜托单位、开发单位及主管部门。1.3定义：列出报告中所用到的特地术语的定义和缩写词的原意。1.4参照资料：列出相关资料的作者、标题、编号、发布日期、第一版单位或资料本源，可包含：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；大纲设计说明书；详细设计说明书；用户操作手册；测试计划；测试解析报告；本报告引用的其余资料、采纳的开发标准或开发规范。开发结果2.1产品：可包含列出各部分的程序名称、源程序行数（包含说明行）或目标程序字节数及程序总计数目、储存形式；产品文档名称等。2.2主要功能及性能2.3所用工时：按人员的不一样层次分别计时。2.4所用机时：按所用计算机机型分别计时。2.5进度：给出计划进度与实质进度的比较。

2.6花费议论3.1生产率议论：如均匀每人每个月生产的源程序行数、文档的字数等。3.2技术方案议论3.3产质量量议论经验与教训软件保护手册前言1.1编写目的：说明编写手册的目的并指明读者对象。1.2项目背景：说明项目的提出者、开发者、用户和使用处所。1.3定义：列出报告中所用到的特地术语的定义和缩写词的原意。1.4参照资料：列出相关资料的作者、标题、编号、发布日期、第一版单位或资料本源软件开发技术文档，及保密级别，可包含：用户操作手册；与本项目相关的其余文档。系统说明2.1系统用途：说明系统具备的功能，输入和输出。2.2安全保密：说明系统安全保密方面的考虑。2.3整体说明：说明系统的整体功能，对系统、子系统和作业做出综合性的介绍，并用图表的方式给出系统主要部分的内部关系。2.4程

序说明：说明系统中每一程序、分程序的细节和特征。2.4.1程序1的说明●功能：说明程序的功能。●方法：说明实现方法。●输入：说明程序的输入、媒体、运转数据记录、运转开始时使用的输入数据的种类和存放单元、与程序初始化相关的入口要求。●办理：办理特色和目的，如：用图表说明程序的运转的逻辑流程；程序主要转移条件；对程序的拘束条件；程序结束时的出口要求；与下一个程序的通讯与联系（运转、控制）；由该程序产生并茶社办理程序段使用的输出数据种类和存放单元；程序运转储存量、种类及储存地点等。●输出：程序的输出。●接口：本程序与本系统其余部分的接口。●表格：说明程序内部的各种表、项的细节和特征。对每张表的说明最少包含：表的表记符；使用目的；使用此表的其余程序；逻辑划分，如块或部，不包含表项；表的基本结构；设计安排，包含表的控制信息。表目结构细节、使用中的特有性质及各表项的表记、地点、用途、种类、编码表示。●独有的运转性质：说明在用户操作手册中没有提到的运转性质。2.4.2程序2的说明与程序1的说明同样。此后的其余各程序的说明同样。操作环境3.1设施：逐项说明系统的设施配置及其特征。3.2支持软件：列出系统使用的支持软件，包含它们的名称和版本号。

3.3数据库：说明每个数据库的性质和内容，包含安全考虑。3.3.1整体特色：如表记符、使用这些数据库的程序、静态数据、动向数据；数据库的储存媒体；程序使用数据库的限制。3.3.2结构及详细说明●说明该数据库的结构，包含此中的记录和项。●说明记录的构成，包含首部或控制段、记录体。●说明每个记录结构的字段，包含：标志或标号、字段的字符长度和位数、该字段的同意值范围。●扩大：说明为记录追加字段的规定。保护过程4.1商定：列出该软件系统设计中所使用所有规则和商定，包含：程序、分程序、记录、字段和储存区的表记或标号助记符的使用规则；图表的办理标准、卡片的连接序次、语句和记号中使用的缩写、出此刻图表中的符号名；使用的软件技术标准；标准化的数据元素及其特色。4.2考据过程：说明一个程序段更正后，对其进行考据的要乞降过程（包含测试程序和数据）及程序周期性考据的过程。4.3犯错及纠正方法：列出犯错状态及其纠正方法。4.4特地保护过程：说明文档其余地方没有提到的特地保护过程。如：保护该软件系统的输入输出部分（如数据库）的要求、过程和考据方法；运转程序库保护系统所必需的要求、过程和考据方法；对闰年、世纪改正的所需要的暂时性更正等。

4.5专用保护程序：列出保护软件系统使用的后备技术和专用程序（如文件恢复程序、裁减过时文件的程序等）的目录，并加以说明，内容包含：保护作业的输入输出要求；输入的详细过程及在硬设施上建立、运转并完成保护作业的操作步骤。4.6程序清单和流程图：引用或供应附录给出程序清单和流程图。软件问题报告登记号由软件配置管理部门为该报告规定一个独一的、序次的编号。登记日期软件配置管理部门登记该报告的日期。问题发现日期发现该问题的日期和时间。活动在哪个阶段发现的问题，分为单元测试、组装测试、确认测试和运转保护。状态在软件配置记录中保护的动向指示，状态表示有：正在复查"软件问题报告"，以确立将采纳什么行动；"软件问题报告"已由指定的人去进行办理；更正已完成，并经过测试，正准备交给主程序库；主程序库已经更新，主程序库更正的重新测试沿未完成；做了重新测试，问题再现；做了重新测试，所做的更正无故障，"软件问题报告"被关闭；留待此后关闭。报告人填写"软件问题报告"人员的姓名、地址、电话。问题属于什么方面划分是程序的问题，还是模块的问题，或是数据库的问题，文件的问题。也可能是它们的某种组合。模块/子系统出现的模块名。

假如不知是哪个模块，可标出子系统名，尽量给出细节。订正版本号出现问题的模块版本。磁带包含有问题的模块的主程序库的磁带的表记符。数据库当发现问题时所使用数据库的表记符。文件号有错误的文件的编号。测试用例发现错误时所使用测试用例的表记符。硬件发现错误时所使用的计算机系统的表记。问题描述/影响问题症兆的详细描述。假如可能，则写明实质问题所在。也要给出该问题对未来测试、接口软件和文件等的影响。附注记录增补信息。软件更正报告登记号由软件配置管理部门为该报告规定的编号。登记日期软件配置管理部门登记"软件更正报告"的日期。时间准备好"软件更正报告"的日期。报告人填写该报告的作者。子系统名受更正影响的子系统名。模块名被更正的模块名。7"软件问题报告"的编号被"软件更正报告"办理或部分办理的"软件问题报告"的编号。假如某"软件问题报告"的问题不过部分被办理，则在编号后附以p，如1234p。更正包含程序更正、文件更新、数据库更正或它们的组合。更正描述更正的详细描述。假如是文件更新或数据库更正，还要列出文件更新通知或数据库更正申请的表记符。同意人同意人签字，正式同意进行更正。语句种类程序更正中涉及到的语句种类，包含：输入/输出语句类、计算语句类、逻辑控制语句类、数据办理语句类（如数据传递、存取语句类）。

程序名被更正的程序、文件或数据库的名字。老订正版当前的版本/订正本表记。新订正版更正后的版本/订正本表记。数据库假如申请数据库更正，则给出数据库的表记符。数据库更正报告数据库更正申请号。文件假如要求对文件进行更正，则给出文件的名字。文件更新文件更新通知单的编号。更正能否已测试指出已对更正做了哪些测试，如单元、子系统、组装、确认和运转测试等，并注明测试成功与否。20"软件问题报告"能否给出问题的正确描述回答'是'或'否'。问题说明正确地表达要保护的问题。问题源指明问题来自于哪里，如软件需求说明书、设计说明书、数据库、源程序等。资源完成更正所需资源的估计，即总的人时数和计算机时间的开支。