软件写作基本介绍.pptVIP

软件文档写作 Software Document Writing  学习软件文档写作的目的: 1.要发展我国的软件产业就必须学习国外先进的软件开发 技术和方法,把软件开发工程化、规范化,进行综合性管理 而软件文档的规范化撰写,是此项工作的第一步。 2.市场的需求,具有软件文档写作经验已成为许多软件公司 招聘的一项基本要求。 对于工程团队及技术产品的最终用户而言,软件文档的撰 写是必不可缺的一部分。目前的软件文档存在诸多问题,影响 了其有效性。 4.软件开发流程的要求。美国水平比较高的软件公司软件开 发流程十分规范,技术文档和使用文档非常细致,量非常大。 按照一位经理的说法,是“所有的事情都有文档记录”。不仅 如此,美国更有 technica1 writer(技术写作师)这个职业。国 内这方面的差距较大:软件工程师视文档为负担,项目经理本 身是软件工程师出身,更加没有动力实施这些规范,公司老总 可能又不懂软件开发管理,于是低水平现状是想躲都躲不掉了  授课内容 采取讲座方式,用案例介绍各类软件文档的写作 写作工具: Win word Docbook 作业及考试要求 平时占50% 考查占50%  软件文档知多少? 如今,软件开发越来越复杂,软件功能也越来越丰富。而 几乎所有成熟的商业软件,都是靠一个开发团队齐心协力的血 汗结晶。“罗马不是一天建成的! 当我们震撼于 Microsof t Windows的惊世巨著的同时,也道听途说了微软公司软件工程是 如何的完善规范。的确,集数百名员工几年的共同努力之大成 软件项目管理的成败是控制开发成本的关键环节。这里面,少 不了贯穿其中的重要步骤-软件文档 软件文档可以分为开发文档和产品文档两大类。 开发文档包括:《功能要求》、《投标方案》、《需求分 析》、《技术分析》、《系统分析》、《数据库文档》、《功 能函数文档》、《界面文档》、《编译手册》、《QA文档》、 《项目总结》 产品文档包括:《产品简介》、《产品演示》、《疑问解 答》、《功能介绍》、《技术白皮书》、《评测报告》、《安 装手册》、《使用手册》、《维护手册》、《用户报告》、 《销售培训》等  开发文档 1.《功能要求》-来源于客户要求和市场调查,是软件开发 中最早期的一个环节。客户提岀一个模糊的功能概念,或者要 求解决一个实际问题,或者参照同类软件的一个功能。有软件 经验的客户还会提供比较详细的技术规范书,把他们的要求全 部列表书写在文档中,必要吋加以图表解说。这份文档是需求 分析的基础 2.《投标方案》--根据用户的功能要求,经过与招标方沟通 和确认,技术人员开始书写《投标方案》,方案书一般包括以 下几个重要的章节 前言-项目背景、公司背景和业务、技术人员结构、公司的 成功案例介绍等 需求分析-项目要求、软件结构、功能列表、功能描述、注 意事项等。 技术方案-总体要求和指导思想、技术解决方案、软件开发 平台、网络结构体系等。