专注于互联网--专注于架构

最新标签
网站地图
文章索引
Rss订阅

首页 »项目管理 » 文档文字处理软件:软件文档知多少? »正文

文档文字处理软件:软件文档知多少?

来源: 发布时间:星期三, 2008年12月10日 浏览:25次 评论:0
  如今软件开发越来越复杂软件功能也越来越丰富而几乎所有成熟商业软件都是靠个开发团队齐心协力血汗结晶“罗马不是天建成!”当我们震撼于Microsoft Windows惊世巨著同时也道听途说了微软公司软件工程是如何完善规范集数百名员工几年共同努力之大成软件项目管理成败是控制开发成本关键环节这里面少不了贯穿其中重要步骤----软件文档
  软件文档可以分为开发文档和产品文档两大类
  开发文档包括:功能要求投标方案需求分析技术分析系统分析数据库文档功能文档界面文档编译手册QA文档项目总结
  产品文档包括:产品简介产品演示疑问解答功能介绍技术白皮书评测报告安装手册使用手册维护手册用户报告销售培训
、开发文档
  1. 功能要求--来源于客户要求和市场调查是软件开发中最早期个环节客户提出个模糊功能概念或者要求解决个实际问题或者参照同类软件个功能有软件经验客户还会提供比较详细技术规范书把他们要求全部列表书写在文档中必要时加以图表解说这份文档是需求分析基础
  2. 投标方案--根据用户功能要求经过与招标方沟通和确认技术人员开始书写投标方案方案书般包括以下几个重要章节:
  前言--项目背景、公司背景和业务、技术人员结构、公司成功案例介绍等
  需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等
  技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等
  项目管理--描述公司软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等
  技术支持--公司技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等
  系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等
  项目进度--整个项目进度计划包括签署合同、项目启动、需求分析、系统分析、开发、测试维护、系统集成、用户验收、用户培训等步骤时间规划
  3. 需求分析--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等功能要求为基础进行详细功能分析(包括客户提出要求和根据开发经验建议功能)列出本产品是什么有什么特殊概念包括那些功能分类需要具备什么功能该功能操作如何实现时候该注意什么细节客户有什么要求系统运行环境要求等这里功能描述跟以后使用手册是
  4. 技术分析--包括技术选型、技术比较、开发人员、关键技术问题解决、技术风险、技术升级方向、技术方案评价竞争对手技术分析等需求分析为基础进行详细技术分析(产品性能和实现方法)列出本项目需要使用什么技术方案为什么有哪些技术问题要解决 估计开发期间会碰到什么困难技术方案以后如何升级对本项目技术有什么评价等
  5. 系统分析--包括功能实现、模块组成、功能流程图、接口、数据字典、软件开发需要考虑各种问题等需求分析为基础进行详细系统分析(产品开发和实现方法)估计开发期间需要把什么问题说明白员根据系统分析开始在项目主管带领下进行编码
  6. 数据库文档--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等系统分析为基础进行详细数据库设计必要时可以用图表解说特别是关系数据库
  7. 功能文档--包括变量名、变量初植、功能参数如何、备注、注意事项等系统分析为基础进行详细说明列出哪个功能涉及多少个以便以后员修改、接手和扩展
  8. 界面文档--包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件要求这里与软件完成后运行界面是
  9. 编译手册--包括服务器编译环境、操作系统、编译工具、GNUC编译器版本信息、目录说明、生成、源文件列表、Makefile配置及其相关对应关系列表客户端编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装过程
  10. QA文档--包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等提供给软件测试人员使用
  11. 项目总结--包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目升级建议、对以后项目建议、人员素质情况等

二、产品文档
  1. 产品简介--包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址
  2. 产品演示--包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等般用Power
po或者VCD录制软件实现
  3. 疑问解答--列出用户关心问题和处理方法用于解答软件操作功能和解决用户疑难问题
  4. 功能介绍--以需求分析为书写基础包括软件介绍、软件结构、功能列表、功能描述和公司联系地址
  5. 技术白皮书--以技术分析为书写基础包括功能实现、技术选型、关键技术问题解决、技术方案特点、技术升级方向等
  6. 评测报告--第三方权威评测报告包括评测目、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等
  7. 安装手册--包括系统环境、运行平台、产品安装过程、环境设置、安装记录等
  8. 使用手册--包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等
  9. 维护手册--包括产品简介、系统须知、环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等
  10. 用户报告--包括产品简介、购买时间、使用目、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等
  11.销售培训--包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等

相关文章

读者评论

  • 共0条 分0页

发表评论

  • 昵称:
  • 内容: