软件文档的作用和分类

原创 2004年09月08日 12:41:00
如今,软件开发越来越复杂,软件功能也越来越丰富。而几乎所有成熟的商业软件,都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的!”,当我们震撼于Microsoft Windows的惊世巨著的同时,也道听途说了微软公司软件工程是如何的完善规范。的确,集数百名员工几年的共同努力之大成,软件项目管理的成败是控制开发成本的关键环节。这里面,少不了贯穿其中的重要步骤----软件文档。


  软件文档可以分为开发文档和产品文档两大类。

  开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。


  产品文档包括:《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。


一、开发文档


  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.《销售培训》--包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。

文档的作用和分类

可行性研究报告: 说明该软件开发项目的实现在技术上、经 济上和社会因素上的可行性,评述为了合理地达到开发目标可供 选择的各种可能实施的方案,说明并论证所选定实施方案的理 由。 项目开发计划: 为...
  • Mrknowledge
  • Mrknowledge
  • 2016年03月14日 18:00
  • 271

SDL学习(一)

SDL(Simple DirectMedia Layer)是一套开放源代码的跨平台多媒体开发库,使用C语言写成。SDL提供了数种控制图像、声音、输出入的函数,让开发者只要用相同或是相似的代码就可以开发...
  • HEVC_CJL
  • HEVC_CJL
  • 2013年02月12日 18:14
  • 5314

软件文档的分类与说明

软件文档可以分为开发文档和产品文档两大类。       开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册...
  • ml5271169588
  • ml5271169588
  • 2014年02月08日 02:25
  • 639

好用的需求文档管理工具Telelogic DOORS

Telelogic DOORS 是需求文档管理市场上的领先工具。使用DOORS,用户可以编辑、跟踪和管理项目中建立起来的所有需求,以保证最终产品符合所有定义的客户需求。 变更和配置管理。 ...
  • SunCherryDream
  • SunCherryDream
  • 2014年04月08日 09:10
  • 6558

软件项目设计文档分类

软件项目设计文档分类author:chinayaosir(jack.yao)blog:   http://blog.csdn.net/chinayaosir/QQ:    44633197声明:严禁其...
  • chinayaosir
  • chinayaosir
  • 2016年09月26日 14:53
  • 498

doctype(文档类型)的作用是什么?

DOCTYPE是docunment type(文档定义)的简写,用来说明web设计中所用的html或xhtml的类型,指出浏览器或者其他阅读程序按照什么样的规则(W3C所发布的一个文档类型定义即DTD...
  • xujie_0311
  • xujie_0311
  • 2014年12月20日 14:45
  • 3249

软件设计文档国家标准

操作手册(GB8567——88) 1引言 1.1编写目的 说明编写这份操作手册的目的,指出预期的读者。 1.2前景 说明: a.  这份操作手册所描述的软件系统的名...
  • cui55
  • cui55
  • 2014年02月26日 14:33
  • 7403

人机交互方法研究 ——如何设计一个体贴的软件

(《创新创业训练》课程报告,只能算作《About Face3:交互设计精髓》的摘录) 1 人机交互基础知识 1.1 背景 二十世纪八十年代初,苹果公司生产出第一台图形界面的电脑。大约十年之后,“...
  • qq_17615475
  • qq_17615475
  • 2015年11月27日 10:40
  • 1404

软件功能测试需求分析

最近自己预习了一下软件功能测试的需求分析,需求,即用户对系统的目标要求。用户需求通常只涉及系统的外部可现行为,不涉及系统的内部特性。 测试需求的过程:            作为测试人...
  • jiangren21
  • jiangren21
  • 2015年10月10日 23:25
  • 517

关于几种软件测试分类的方法

1.从是否关心内部结构来看 (1).白盒测试:又称为结构测试或逻辑驱动测试,是一种按照程序内部逻辑结构和编码结构,设计测试数据并完成测试的一种测试方法。 (2)黑盒测试:又称为数据驱动测试,把测试对象...
  • javaxiaobenhai
  • javaxiaobenhai
  • 2015年10月11日 00:30
  • 4277
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:软件文档的作用和分类
举报原因:
原因补充:

(最多只允许输入30个字)