软件文档写作-基本介绍.ppt

* 软件文档写作 Software Document Writing 学习软件文档写作的目的： 3. 对于工程团队及技术产品的最终用户而言，软件文档的撰写是必不可缺的一部分。目前的软件文档存在诸多问题，影响了其有效性。 2. 市场的需求，具有软件文档写作经验已成为许多软件公司招聘的一项基本要求。 1. 要发展我国的软件产业就必须学习国外先进的软件开发技术和方法，把软件开发工程化、规范化，进行综合性管理，而软件文档的规范化撰写，是此项工作的第一步。 4. 软件开发流程的要求。美国水平比较高的软件公司软件开发流程十分规范，技术文档和使用文档非常细致，量非常大。按照一位经理的说法，是“所有的事情都有文档记录”。不仅如此，美国更有technical writer(技术写作师)这个职业。国内这方面的差距较大：软件工程师视文档为负担，项目经理本身是软件工程师出身，更加没有动力实施这些规范，公司老总可能又不懂软件开发管理，于是低水平现状是想躲都躲不掉了。 授课内容： 采取讲座方式，用案例介绍各类软件文档的写作。 作业及考试要求： 平时占50% 考查占50% 写作工具： Win Word Docbook 软件文档知多少？ 如今，软件开发越来越复杂，软件功能也越来越丰富。而几乎所有成熟的商业软件，都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的！”，当我们震撼于Microsoft Windows的惊世巨著的同时，也道听途说了微软公司软件工程是如何的完善规范。的确，集数百名员工几年的共同努力之大成，软件项目管理的成败是控制开发成本的关键环节。这里面，少不了贯穿其中的重要步骤----软件文档。 　　软件文档可以分为开发文档和产品文档两大类。　　开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 　　产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。 一、开发文档 　　1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 　　2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 　　前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 　　需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。 　　技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。 　　技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。 系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。 　　项目进度--整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。 　　3. 《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析(包括客户提出的要求和根据开发经验建议的功能)，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。 4. 《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析(产品的性能和实现方法)，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 5. 《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需