软件文档可以分为产品文档和开发文档两大类。
     产品文档包括:《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。  
项目管理者联盟,项目管理问题。
   开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。  
  
项目管理
  一、产品文档  
   项目管理
  1. 《产品简介》--包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。  
  2. 《产品演示》--包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用Power  point或者VCD录制软件实现。  项目管理者联盟,项目管理问题。
  3. 《疑问解答》--列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。  
  4. 《功能介绍》--以《需求分析》为书写基础,包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。  
  5. 《技术白皮书》--以《技术分析》为书写基础,包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。  项目管理者联盟,项目管理问题。
  6. 《评测报告》--第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。
   7. 《安装手册》--包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。  
  8. 《使用手册》--包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。  
  9. 《维护手册》--包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。  项目管理者联盟文章,深入探讨。
  10. 《用户报告》--包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。  
  11.《销售培训》--包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。
    二、开发文档  
  1. 《功能要求》--来源于客户要求和市场调查,是软件开发中最早期的一个环节。客户提出一个模糊的功能概念,或者要求解决一个实际问题,或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书,把他们的要求全部列表书写在文档中,必要时加以图表解说。这份文档是需求分析的基础。  
  2. 《投标方案》--根据用户的功能要求,经过与招标方沟通和确认,技术人员开始书写《投标方案》,方案书一般包括以下几个重要的章节:  
  前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。  
  需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。  
  技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。  
  项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。  
  技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。

  系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。

项目进度--整个项目的进度计划,包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。

3. 《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础,进行详细的功能分析(包括客户提出的 要求和根据开发经验建议的功能),列出本产品是什么,有什么特殊的概念,包括那些功能分类,需要具备什么功能,该功能的操作如何,实现的时候该注意什么细 节,客户有什么要求,系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。
    4. 《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、 技术升级方向、技术方案评价,竞争对手技术分析等。以《需求分析》为基础,进行详细的技术分析(产品的性能和实现方法),列出本项目需要使用什么技术方 案,为什么,有哪些技术问题要解决 ,估计开发期间会碰到什么困难,技术方案以后如何升级,对本项目的技术有什么评价等。  
  5. 《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础,进行详细的系统分析 (产品的开发和实现方法),估计开发期间需要把什么问题说明白,程序员根据《系统分析》,开始在项目主管的带领下进行编码。  
  6. 《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础,进行详细的数据库设计。必要时可以用图表解说,特别是关系数据库。  
  7. 《功能函数文档》--包括变量名、变量初植、功能,函数名,参数,如何调用、备注、注意事项等。以《系统分析》为基础,进行详细的说明,列出哪个功能涉及多少个函数,以便以后程序员修改、接手和扩展。  
  8. 《界面文档》--包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求,这里与软件完成后的运行界面是一致的。  项目管理者联盟,项目管理问题。
  9. 《编译手册》--包括服务器编译环境、操作系统、编译工具、GNU的C++编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。 
  10. 《QA文档》--包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等,提供给软件测试人员使用。  项目管理者联盟,项目管理问题。
  11. 《项目总结》--包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。

项目管理中软件项目文档的分类管理相关推荐

  1. 软件项目文档_什么是软件项目的好的文档?

    软件项目文档 开放地理空间(OSGeo)基金会最近参加了Google的第一个文档季节 ,其中Google赞助了高级技术作家为开源项目做出贡献. OSGeo是大约50个地理空间开源项目的总括组织. 多年 ...

  2. 项目管理/互联网/软件全套文档、产品文档、技术文档、测试文档、运维文档、项目文档

    前言 简约文档可提高团队沟通效率:详细文档体系可形成无形价值资产,比如降低人员培养周期. 所有文档列表都是基于实际产品.项目情况而定,最好在决定做一个新产品,或实施一个项目时,就根据实际情况拉出一张需 ...

  3. 软件项目文档规划的大道至简、小道至繁原则

      有些软件公司做项目时,要求软件文档必须做到面面具到,完善到所有细节,这是非常浪费人力物力的做法.而有些公司却为了节省成本,什么文档也不做,口头沟通业务流程,确定下来后直接交给开发人员,这样的后果我 ...

  4. 项目经理成长之路---PMP、管理知识、项目文档、项目管理软件工具、PPT、WORD

    项目经理成长之路---PMP.管理知识.项目文档.项目管理软件工具.PPT.WORD [1]PMP备考资料 | PMP备考九阴真经 --- 项目管理十大知识领域49个过程输入输出.工具与技术暨知识点汇 ...

  5. 【深入浅出项目管理视频1】-项目文档评审

    决定尝试用视频的方式来表达这些繁琐的内容, 比写长篇大论可能更直观些,这是我们产品中实现的项目文档评审过程,与大家分享: 不小心录的视频有些大,得有1280宽的显示器才能看完整,也不知道视频在cnbl ...

  6. 视频会议软件中的协同文档技术

    现今的视频会议软件产品不单只是音.视频的传输,还包括协同数据功能.协同数据功能主要包括:电子白板共享.文档协同浏览.共享桌面等功能.现在我们主要讨论的是视频会议软件中的协同文档技术.协同文档浏览主要是 ...

  7. 信息系统项目文档及其管理

    信息系统项目文档及其管理 信息系统项目相关信息(文档) 配置管理 配置管理的概念 配置管理的目标和方针 日常配置管理活动 信息系统项目相关信息(文档) 1.软件文档一般分为三类:开发文档.产品文档.管 ...

  8. SAP License:SAP项目文档的考核标准

    项目启动阶段 项目计划及对计划的调整 建议: 1. 对项目进度进行分类,定义每个阶段的关键任务. 2. 对每个阶段应形成的文档进行说明,哪类文档由谁制作,由谁签核必须做出统一的规定.最好能提供每类文档 ...

  9. 详述IT项目文档类别

    如今,软件开发越来越复杂,软件功能也越来越丰富.而几乎所有成熟的商业软件,都是靠一个开发团队齐心协力的血汗结晶."罗马不是一天建成的!",当我们震撼于Microsoft Windo ...

最新文章

  1. ubuntu 12.04 php mysql_Ubuntu 12.04下LAMP安装配置
  2. 【bzoj2693】jzptab 莫比乌斯反演+线性筛
  3. 第三十二期:如何摆脱「技术思维」的惯性?
  4. [Python]网络爬虫(七):Python中的正则表达式教程
  5. bat for 循环中定义变量(变量值不显示,通过使用「延期变量扩展」方式解决)
  6. 【软件开发】【项目管理】项目管理那些事儿之那些权力
  7. 步进电机 迷你L298N 2路直流电机驱动模块 正反转 PWM调速 双H桥
  8. 在网页上查看App Store的app介绍
  9. android+video+自动播放源码,华为手机浏览器使用Video.js无法自动播放
  10. 2019 中国开源年会即将开启
  11. 滤波器:使用Filter solutions设计椭圆函数LC高通滤波器
  12. vue中PC端使用高德地图 -- 实现搜索定位、地址标记、弹窗显示定位详情
  13. 漫谈程序员系列:你的幸运女神呢
  14. TikTok全球下载突破超20亿人次,它做对了什么?
  15. js Arry对象思维导图
  16. Github 上火热的十个 Python 项目,从Debug工具到AI水军、量化交易系统。( 嗨学编程)
  17. epoll的ET工作模式和LT工作模式
  18. Flink ReducingState 实例
  19. pfamscan 的使用_Pfam数据库蛋白编码能力预测说明
  20. Win10怎么禁止自动安装软件

热门文章

  1. anistropic filer
  2. Nvjdc(诺兰)再续经典——诺兰方舟ARK
  3. 趋势顶底指标公式 通达信趋势顶底主图选股指标 清晰的趋势顶底详解
  4. 微信小程序幽默风和git
  5. 《数字图像处理》读书笔记2:数字图像处理基础
  6. 精细化运营店铺,引导店铺走向正轨,带你玩转淘宝
  7. Shop项目--9. 清空购物车。cart.jsp
  8. 美国电子计算机大学排名,美国大学电子计算机专业排名院校有哪些?
  9. 南华大学计算机学院龚向坚,李跃-计算机科学与技术学院
  10. 这几个方法让你实现EXCEL文件翻译成中文