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