软件文档知识.pptVIP

上节回顾 广告策划书 广告文案 商品广告 产品介绍 商务启事 新闻等 应用文写作 理论部分 第五章 软件文档知识 本章重点 软件文档及其组成 软件工程标准 软件技术文档的编写技巧 软件文档管理 5.1 软件文档 什么是文档？ 也称文件，记录的数据和数据媒体，具有固定不变的格式。 可被人和计算机阅读。 软件文档有什么作用？ 站在公司的角度： 文档可以规范公司对软件开发过程的管理，提高软件开发工 作的效率，避免公司资源的流失，使公司不会在项目开发上 被动，帮助公司走向专业化，提高软件质量，便于软件过程 的改进，应对年审等等 。 站在个人的角度： 让自己在开发过程中清楚自己的位置和工作的进展，便于自 己将来对以前的代码进行阅读和改进，让自己在开发工作中 时刻保持主动的位置，帮助自己由原来的开发人员上升到开 发管理的层次或是便于你对开发团队的管理等等 软件文档有什么作用？ 1、管理依据 2、任务之间联系的凭证 3、质量保证 4、培训与参与 5、软件维护支持 6、历史档案 文档的分类 开发文档 用户文档 管理文档 产品文档（用户文档） 规定关于软件产品的使用、维护、增强、转换和传 输的信息。（P 60) 三种作用。 三种类型的读者。 三方面的内容。 开发文档 描述软件开发过程，包括软件需求、软件设 计、软件测试、保证软件质量的一类文档。 管理文档 ? 对文档的管理涉及打开、查看、编辑、搜索等内容。 Windows 2000的资源管理器仍然是管理文档的主要场所，新增的文件夹、历史记录、搜索按钮、自动记忆功能、多种打开方式等进一步增强了它的管理功能。 文档简要介绍 可行性研究报告;项目开发计划;软件需求说明书;数据要求说明书;概要设计说明书;详细设计说明书;数据库设计说明书;用户手册;操作手册;模块开发卷宗;测试计划;测试分析报告;开发进度月报; 项目开发总结报告 5.2 软件工程标准 什么是软件工程标准？ 为防止编写出程序的交流的障碍，制定了标准化程 序设计语言而规定的若干个标准子集。 软件工程标准的层次 国家标准 GB-中国国家技术监督局公布的“国标” ANSI-美国国家标准协会。民间性，权威性 FIPS-美国商务部国家标准局联邦信息处理标准 BS-英国国家标准 DIN-德国标准协会 JIS-日本工业标准 行业标准 IEEE-美国电气与电子工程师协会 GJB-中国军用标准 D0D-STD-美国国防部标准 MIL-美国军用标准 中国的软件工程标准化工作 基础标准 开发标准 文档标准 管理标准 5.3 软件写作要求 编写的原则： 针对性、正确性、准确性、 完整性、简洁性、统一性、易读性 软件文档的质量要求: 针对性、精确性、清晰性 完整性、灵活性、可追溯性 软件技术文档的编写技巧 1、制定一个技术评价核对表 2、在技术文档编写的过程中明确责任 3、增加技术文档编写者的准确性 4、设置任务的优先次序 软件技术文档的编写技巧 一、制定一个技术评价核对表 许多的程序开发设计者以及管理者都缺乏从技术上评价一个 文档的经验。这里有一些方法可以提高这些技术文档的准确 性：? 把注意力集中于技术事实上，这样能够核实这些技术是作为 技术文档而被编写出来的。技术评论的工作并不等同于一般 的编辑工作。  一定要从技术上核实，在技术文档里编写的程序与步骤的准确性。 一定要从技术上核实，在技术文档中使用的图片捕捉的准确性 。   软件技术文档的编写技巧 二、在技术文档编写的过程中明确责任 技术文档编写不好的一个原因常常是由于对它不够重视。这 是由于在编写技术文档的时候，没有十分的明确各种责任。 因此，一定要在技术文档编写的过程中明确责任，这些方法包括：?  在技术文档中加入作者以及相关人员的姓名。一些公司可能有规定，禁 止出现员工的姓名，但是在技术文档中包含作者以及相关人士姓名的做 法能够促进这些内部员工之间的交流。对于外部的文档使用者，比如为 商业现货软件编写的用户指南，可以加入作者以及相关人员的姓名， 用以明确和承认他们对开发所做的工作和贡献。  把文档的技术评论作为提供给开发设计人员的年度评论的一部分。  在项目计划中指派专人负责技术评论的工作。 软件技术文档的编写技巧 三、增加技术文档编写者的准确性 由于技术文档编写者在许多公司内都是非常主观的 一个职位，并且编写技术文档也是他们最主要的职 责，因此做这些工作的人都必须与他们所编写的技 术文档的准确性有着直接的利害关系。?  软件技术文档的编写技巧 四、设置任务的优先次序 通常的情况下，主要的开发设计人员脑海中包含着有关整个项目的信息，而且，有时候还会同时考虑许