⑴ 请问软件项目的技术开发文档都要写些什么呢,具体要求是什么呢,要写多少文档呢
要写的文档种类有很多;根据不同的软件系统,每种文档内容的内容、格式和要求又有所不同。
1)文档的种类可以参考任何一本《软件工程》书籍。大致包括:用户需求调研报告、需求分析、概要设计、用户手册、测试计划、详细设计、详细编码文档、测试报告等等
2)很多类型的软件文档都有国标(GB)或行业标准(例如国际军用标记——GJB)规定的格式,具体情况可查询相关标准。
⑵ 软件开发文档包括哪些
软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。
软件文档可以分为开发文档和产品文档两大类。
开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《 QA 文档》、《项目总结》等。
产品文档包括:《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》。
用户文档《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。
⑶ 技术状态文件包括什么
技术文件是指企业承担工程的有关技术文件和一般作为技术开发的技术资料。前者如施工图纸、技术要求、规范、规定等,后者主要是国内外、同行业技术资料、文件、情报的收集,积累等。
设计文件的分类:
1、按表达的内容分类
(1)图样
按照投影关系绘制的、用于说明产品加工和装配要求的设计文件。如装配图、零件图和外形图等。
(2)简图
以图形符号为主绘制的、用于说明产品电气装配连接、各种原理和其他示意性内容的设计文件。
(3)文字和表格
以文字和表格的方式说明产品的技术及组成情况的设计文件。它是一个初步构想,表示理论或理想电路,不涉及实现方式。如说明书、明细表和汇总表等。
2、按形成的过程分类
(1)试制文件
是指设计试制过程中所编制的各种设计文件。
(2)生产文件
是指设计性试制完成后,经整理修改,指导生产(包括生产性试制)所用的设计文件。
3、按绘制的过程和使用特征分类
(1)草图
是设计产品时绘制的原始图样。它是供讨论、试制的一种临时性设计文件,草图也可以是用徒手方式绘制的一种不正规的图样。
(2)原图
供描绘底图用的设计文件。
(3)底图
是作为确定产品及其组成部分的基本凭证的图样,它是使用能晒制复印图或照相的材料所绘制的设计文件。底图可分为:
①基本底图——原底图,是经各有关人员签署而制定的底图。存入机要技术档案室;
②副底图——基本底图的副本,供复制产品的企业印制复印图时使用。
(4)复印图
是用底图以晒制、照相或能保证与底图完全相同的其他方法所复制的图样。复制图可分为:①晒制复印图(蓝图);②照相复印图;③印制复印图。
(5)载有程序的媒体
它是指载有完整独立的功能程序的媒体,如计算机用的磁盘、光盘等。
技术文件管理:
1、审查要点
(1)企业应具备相应的产品标准和相关标准,企业制定的企业标准应经备案;
(2)企业的设计文件应正确、完整和统一;
(3)针对产品形成过程,企业应制定相应的工艺文件,并做到工艺文件正确、完整、统一;
(4)企业应有部门或专(兼)职人员对技术文件管理进行控制。
2、审查方法
(1)调阅标准文件清单,按《××X产品生产许可证发(换)证实施细则》的要求,查证企业是否具备产品现行有效的标准,对产品标准中引用的标准,凡涉及产品出厂检测技术要求的均应具备;
(2)企业制定的企业标准,凡作为产品交付依据的,应核查其是否备案;
(3)抽查企业的产品设计及工艺文件是否经编制、审核,且发布前是否经批准,且经批准的设计及工艺文件能否满足产品标准规定的性能、指标要求和指导生产的要求;
(4)分层次抽取设计、管理、执行部门的现行使用文件,核查是否一致,有无不同部门使用不同版本的情况;
(5)调阅企业文件更改规定,抽查更改的设计文件和工艺文件,查证更改是否符合规定要求;
(6)调阅企业的人员任命书或职能配置文件,查证是否有部门或专(兼)职人员对技术文件进行管理;
(7)调阅企业技术文件控制清单,查证是否能识别企业技术文件的现行修订状态;
(8)调阅企业文件发放、收回记录,抽样审查,查证企业有关部门能否得到并使用文件的现行有效版本。
3、审查关注点
(1)产品标准的修订是动态的,应要求企业提供具有和使用的国家或行业标准是否现行有效的客观证据;
(2)如企业制定的企业标准仅作为内部控制使用,则不需经标准化管理部门备案;
(3)企业的设计文件应包括产品的包装、标识及顾客使用说明等相关要求;
(4)企业对确定的关键、特殊过程进行的控制,企业工艺文件的简繁程度应与企业的实际相一致,只要能进行有效的控制即可,而不应要求一定如何如何。但工艺流程和工艺卡片则是需要的。
(5)工艺文件应经批准,应建立识别技术文件修订状态的控制清单及文件的发放、收回及处置记录。
⑷ 软件开发文档应包括哪些内容
开发文档
1. 《功能要求》 -- 来源于客户要求和市场调查,是软件开发中最早期的一个环节。客户提出一个模糊的功能概念,或者要求解决一个实际问题,或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书,把他们的要求全部列表书写在文档中,必要时加以图表解说。这份文档是需求分析的基础。
2. 《投标方案》 -- 根据用户的功能要求,经过与招标方沟通和确认,技术人员开始书写《投标方案》,方案书一般包括以下几个重要的章节: 前言 -- 项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析 -- 项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案 -- 总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理 -- 描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。 技术支持 -- 公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。 系统报价 -- 软、硬件平台报价列表、软件开发费用、系统维护费用等。 项目进度 -- 整个项目的进度计划,包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。
3. 《需求分析》 -- 包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础,进行详细的功能分析 ( 包括客户提出的要求和根据开发经验建议的功能 ) ,列出本产品是什么,有什么特殊的概念,包括哪些功能分类,需要具备什么功能,该功能的操作如何,实现的时候该注意什么细节,客户有什么要求,系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。
4. 《技术分析》 -- 包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价,竞争对手技术分析等。以《需求分析》为基础,进行详细的技术分析 ( 产品的性能和实现方法 ) ,列出本项目需要使用什么技术方案,为什么,有哪些技术问题要解决 ,估计开发期间会碰到什么困难,技术方案以后如何升级,对本项目的技术有什么评价等。
5. 《系统分析》 -- 包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础,进行详细的系统分析 ( 产品的开发和实现方法 ) ,估计开发期间需要把什么问题说明白,程序员根据《系统分析》,开始在项目主管的带领下进行编码。
6. 《数据库文档》 -- 包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础,进行详细的数据库设计。必要时可以用图表解说,特别是关系数据库。
7. 《功能函数文档》 -- 包括变量名、变量初植、功能,函数名,参数,如何调用、备注、注意事项等。以《系统分析》为基础,进行详细的说明,列出哪个功能涉及多少个函数,以便以后程序员修改、接手和扩展。
8. 《界面文档》 -- 包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求,这里与软件完成后的运行界面是一致的。
9. 《编译手册》 -- 包括服务器编译环境、操作系统、编译工具、 GNU 的 C++ 编译器版本信息、目录说明、程序生成、源程序文件列表、 Makefile 配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。
10. 《 QA 文档》 -- 包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等,提供给软件测试人员使用。
11. 《项目总结》 -- 包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。