软件文档写作-第7讲管理文档(完整)课件
- 格式：ppt
- 大小：555.50 KB
- 文档页数：16
下载文档原格式
合集下载
软件开发文档管理规范 PPT
5
编写文档的基本思路
• 明确文档范围，避免空泛浮躁
• 大而全的文档是没有用的
• 定位读者角度，防止对牛弹琴
• 以读者能够理解作为编写文档的标准
• 规范名词称谓，保持前后一致
• 统一的名词和称谓，会降低文档的歧义性
• 注重版本控制，切忌顾此失彼
• 不同阶段的文档记录了项目开发的完整过程
• 应用图文表格，保证内容清晰
• 培训用户的参考
• 帮助外界人员了解项目内幕
• 技术支持的帮手
• 帮助技术支持人员熟悉系统、分析错误、解决问题
• 记录历史的必须
• 软件最大的价值在于可复用性
2020年6月9 日
4
为什么需要文档管理？
按规范要求生成一整套文档的 过程，就是按照软件开发规范 完成一个软件开发的过程。
2020年6月9 日
• 内容残缺的体现
• 缺少项目背景和内容目录（举例） • 缺少表格和示意图（举例） • 缺少对思想的阐述和问题的分析（举例）
• 保证内容完整的方法
• 技巧1：提供统一的项目背景资料 • 技巧2：培养一致的文档编写习惯 • 技巧3：明确要求表格和图形的使用方式
2020年6月9 日
19
文档管理方法：如何写好需求分析
2020年6月9 日
13
文档的等级（3）
• 文档按照质量可划分为四个等级：
• 工作文档（3级文档）
• 适合于由同一单位内若干人联合开发的程序，或可被其他单位
使用的程序
• 正式文档（4级文档）
• 适合那些要正式发行供普遍使用的软件产品 • 关键性程序或具有重复管理应用性质（如工资计算）的程序需
要4级文档
软件项目管理培训讲 座
软件开发文档管理规范 PPT
记录历史的必须
软件最大的价值在于可复用性
为什么需要文档管理？
按规范要求生成一整套文档的 过程，就是按照软件开发规范 完成一个软件开发的过程。
编写文档的基本思路
明确文档范围，避免空泛浮躁
大而全的文档是没有用的
定位读者角度，防止对牛弹琴
以读者能够理解作为编写文档的标准
规范名词称谓，保持前后一致
统一的名词和称谓，会降低文档的歧义性
文档管理方法：如何写好里程碑报告
里程碑报告的内容
预期目标的解释和说明 已完成工作的说明 进度情况、测试结果的分析和说明 下一步工作的重点和难点
完成里程碑报告的过程
第一步：分析前一个里程碑报告的内容 第二步：说明当前里程碑的主要进展 第三步：总结存在的问题、困难和障碍 第四步：列出下一个里程碑的主要工作计划
软件开发文档管理规范
内容提要
文档的分类和等级 文档管理的原则和方法 文档示例与讨论
为什么需要文档管理？
项目管理的依据
了解进度、分析问题，提供项目可预见性
工作交流的凭证
口说无凭，立字为据
软件测试的基础
没有文档，测试人员无法展开工作
培训用户的参考
帮助外界人员了解项目内幕
技术支持的帮手
帮助技术支持人员熟悉系统、分析错误、解决问题
命名规范的重要性
统一的对外形象（举例） 有效的文档分类（举例） 快速的文档查找（举例）
命名规则的制定
并无统一规则，依据项目环境自定义 技巧1：确定统一的空白封面和项目名称 技巧2：同类型多个文档的命名方法 技巧3：文档存储和管理的方法
文档管理方法：如何保证内容完整？
内容残缺的体现
缺少项目背景和内容目录（举例） 缺少表格和示意图（举例） 缺少对思想的阐述和问题的分析（举例）
软件最大的价值在于可复用性
为什么需要文档管理？
按规范要求生成一整套文档的 过程，就是按照软件开发规范 完成一个软件开发的过程。
编写文档的基本思路
明确文档范围，避免空泛浮躁
大而全的文档是没有用的
定位读者角度，防止对牛弹琴
以读者能够理解作为编写文档的标准
规范名词称谓，保持前后一致
统一的名词和称谓，会降低文档的歧义性
文档管理方法：如何写好里程碑报告
里程碑报告的内容
预期目标的解释和说明 已完成工作的说明 进度情况、测试结果的分析和说明 下一步工作的重点和难点
完成里程碑报告的过程
第一步：分析前一个里程碑报告的内容 第二步：说明当前里程碑的主要进展 第三步：总结存在的问题、困难和障碍 第四步：列出下一个里程碑的主要工作计划
软件开发文档管理规范
内容提要
文档的分类和等级 文档管理的原则和方法 文档示例与讨论
为什么需要文档管理？
项目管理的依据
了解进度、分析问题，提供项目可预见性
工作交流的凭证
口说无凭，立字为据
软件测试的基础
没有文档，测试人员无法展开工作
培训用户的参考
帮助外界人员了解项目内幕
技术支持的帮手
帮助技术支持人员熟悉系统、分析错误、解决问题
命名规范的重要性
统一的对外形象（举例） 有效的文档分类（举例） 快速的文档查找（举例）
命名规则的制定
并无统一规则，依据项目环境自定义 技巧1：确定统一的空白封面和项目名称 技巧2：同类型多个文档的命名方法 技巧3：文档存储和管理的方法
文档管理方法：如何保证内容完整？
内容残缺的体现
缺少项目背景和内容目录（举例） 缺少表格和示意图（举例） 缺少对思想的阐述和问题的分析（举例）
软件文档写作-第7讲管理文档(完整)完整版本
(5) 标出Key Path：即EST = LST的 所有事件组成的路径
8
(2)
6
28 30
6
(2)
8
36 36
5
(0)
9
41 41
7
(0)
9
(0)
7
29 29
通常，甘特图适合按开发阶段安排，以作项目总体进度控制。网络计划 法便于在细节上安排人力，适合按精开选p发pt 阶段或子项目的工作步骤安排14。
精选ppt
7
3. 项目里程碑与阶段性文档
由于软件产品是无形的，因此，管理者需要通过文档的形式获 得信息，了解软件的开发状况，以作出管理的决定。
里程碑的建立，可以描述软件开发活动一个过程的终结。在 每个里程碑，都有一个正式的可以提交给管理层的阶段性结果。 比如，一份报告。
里程碑报告的内容不拘，以能清楚说明阶段性结果为标准， 应能代表项目中一个特定逻辑意义上的阶段的终结。
风险类型 项目 项目 项目 项目和产品 项目和产品 项目和产品 产品 业务 业务
风险描述 有经验的职员未完成项目就跳槽 不同的管理层考虑、关注的事情会不同 项目所需的基础硬件没有按期交付 软件需求与预期的相比，将会有较大变化 有关主要接口的描述未按期完成 过低估计了系统的规模 支持项目的CASE工具达不到要求 系统的基础技术被新技术取代 系统还未完成，其它有竞争力的产品就已经上市了
1
A
testing
A
2 debugging 3
ABC
78 testing
89
45
C
modifying
C
4 testing
67
精选ppt
13
持续时间
软件文档写作-基本介绍ppt课件
7
7. 《功能函数文档》--包括变量名、变量初植、功能，函数 名，参数，如何调用、备注、注意事项等。以《系统分析》为基 础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后 程序员修改、接手和扩展。
8. 《界面文档》--包括软件外观、界面素材、编辑工具、文 件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的 运行界面是一致的。
在设计阶段内，系统设计人员和程序设计人员应该在反复理
解软件需求的基础上，提出多个设计，分析每个设计能履行的功
能并进行相互比较，最后确定一个设计，包括该软件的结构、模
块的划分、功能的分配以及处理流程。在被设计系统比较复杂的
情况下，设计阶段应分解成概要设计阶段和详细设计阶段两个步
a．作为开发人员在一定阶段内的工作成果和结束标志； b．向管理人员提供软件开发过程中的进展和情况，把软件 开发过程中的一些“不可见的”事物转换成“可见的文字资料。 以便管理人员在各个阶段检查开发计划的实施进展，使之能够判 断原定目标是 否已达到，还将继续耗用资源的种类和数量；11
c．记录开发过程中的技术信息，便于协调以后的软件开发、 使用和修改；
4
一、开发文档 1. 《功能要求》--来源于客户要求和市场调查，是软件开发
中最早期的一个环节。客户提出一个模糊的功能概念，或者要 求解决一个实际问题，或者参照同类软件的一个功能。有软件 经验的客户还会提供比较详细的技术规范书，把他们的要求全 部列表书写在文档中，必要时加以图表解说。这份文档是需求 分析的基础。
宗，开发进度月报，项目开发总结报告；
开发人员：可行性研究报告，项目开发计划，软件需求说
明书，数据要求说明书， 概要设计说明书，详细设计说明书，
数据库设计说明书，测试计划，测试分析报告；
7. 《功能函数文档》--包括变量名、变量初植、功能，函数 名，参数，如何调用、备注、注意事项等。以《系统分析》为基 础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后 程序员修改、接手和扩展。
8. 《界面文档》--包括软件外观、界面素材、编辑工具、文 件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的 运行界面是一致的。
在设计阶段内，系统设计人员和程序设计人员应该在反复理
解软件需求的基础上，提出多个设计，分析每个设计能履行的功
能并进行相互比较，最后确定一个设计，包括该软件的结构、模
块的划分、功能的分配以及处理流程。在被设计系统比较复杂的
情况下，设计阶段应分解成概要设计阶段和详细设计阶段两个步
a．作为开发人员在一定阶段内的工作成果和结束标志； b．向管理人员提供软件开发过程中的进展和情况，把软件 开发过程中的一些“不可见的”事物转换成“可见的文字资料。 以便管理人员在各个阶段检查开发计划的实施进展，使之能够判 断原定目标是 否已达到，还将继续耗用资源的种类和数量；11
c．记录开发过程中的技术信息，便于协调以后的软件开发、 使用和修改；
4
一、开发文档 1. 《功能要求》--来源于客户要求和市场调查，是软件开发
中最早期的一个环节。客户提出一个模糊的功能概念，或者要 求解决一个实际问题，或者参照同类软件的一个功能。有软件 经验的客户还会提供比较详细的技术规范书，把他们的要求全 部列表书写在文档中，必要时加以图表解说。这份文档是需求 分析的基础。
宗，开发进度月报，项目开发总结报告；
开发人员：可行性研究报告，项目开发计划，软件需求说
明书，数据要求说明书， 概要设计说明书，详细设计说明书，
数据库设计说明书，测试计划，测试分析报告；
软件工程文档写作课件
需跨越多个阶段。
软件工程文档写作
19
软件生存期各阶段与各种文档编制的关系
软 件 需 求 软 件 编码与单 集成与 运行与 计划 分析 设计 元测试 测试 维护 可行性研 究报告 项目开发 计划 软件需求 说明书 数据要求 说明书
软件工程文档写作
20
软 件 需 求 软 件 编码与单 集成与 运行与 计划 分析 设计 元测试 测试 维护 测试计划
• 3、用户文档 用户手册 操作手册 维护修改建议 软件需求说明书
软件工程文档写作
9
软件文档的工作
▪ 国家标准局在1988年1月发布了
• 《计算机软件开发规范》
• 《软件产品开发文件编制指南》
作为软件开发人员工作的准则和规程。 它们基于软件生存期方法，把软件产品 从形成概念开始，经过开发、使用和不 断增补修订，直到最后被淘汰的整个过 程应提交的文档归于以下十三种。
软件工程文档写作
15
文档的分类
▪ 9、测试计划
针对组装测试和确认测试，需要为组织 测试制定计划。计划应包括
• 测试的内容
• 进度安排
• 条件
• 人员
• 测试用例的选取原则
• 测试结果允许的偏差范围等
软件工程文档写作
16
文档的分类
▪ 10、测试分析报告
测试工作完成后，应提交测试计划执行 情况的说明。对测试结果加以分析，并 提出测试的结论性意见。
?1开发文档软件需求说明书数据要求说明书概要设计说明书详细设计说明书可行性研究报告项目开发计划软件需求说明书数据要求说明书概要设计说明书详细设计说明书可行性研究报告项目开发计划文档的分类?2管理文档项目开发计划测试计划测试报告开发进度月报项目开发总结项目开发计划测试计划测试报告开发进度月报项目开发总结?3用户文档用户手册操作手册维护修改建议软件需求说明书用户手册操作手册维护修改建议软件需求说明书文档的分类软件文档的工作?国家标准局在1988年1月发布了?计算机软件开发规范?软件产品开发文件编制指南作为软件开发人员工作的准则和规程
软件工程文档写作
19
软件生存期各阶段与各种文档编制的关系
软 件 需 求 软 件 编码与单 集成与 运行与 计划 分析 设计 元测试 测试 维护 可行性研 究报告 项目开发 计划 软件需求 说明书 数据要求 说明书
软件工程文档写作
20
软 件 需 求 软 件 编码与单 集成与 运行与 计划 分析 设计 元测试 测试 维护 测试计划
• 3、用户文档 用户手册 操作手册 维护修改建议 软件需求说明书
软件工程文档写作
9
软件文档的工作
▪ 国家标准局在1988年1月发布了
• 《计算机软件开发规范》
• 《软件产品开发文件编制指南》
作为软件开发人员工作的准则和规程。 它们基于软件生存期方法，把软件产品 从形成概念开始，经过开发、使用和不 断增补修订，直到最后被淘汰的整个过 程应提交的文档归于以下十三种。
软件工程文档写作
15
文档的分类
▪ 9、测试计划
针对组装测试和确认测试，需要为组织 测试制定计划。计划应包括
• 测试的内容
• 进度安排
• 条件
• 人员
• 测试用例的选取原则
• 测试结果允许的偏差范围等
软件工程文档写作
16
文档的分类
▪ 10、测试分析报告
测试工作完成后，应提交测试计划执行 情况的说明。对测试结果加以分析，并 提出测试的结论性意见。
?1开发文档软件需求说明书数据要求说明书概要设计说明书详细设计说明书可行性研究报告项目开发计划软件需求说明书数据要求说明书概要设计说明书详细设计说明书可行性研究报告项目开发计划文档的分类?2管理文档项目开发计划测试计划测试报告开发进度月报项目开发总结项目开发计划测试计划测试报告开发进度月报项目开发总结?3用户文档用户手册操作手册维护修改建议软件需求说明书用户手册操作手册维护修改建议软件需求说明书文档的分类软件文档的工作?国家标准局在1988年1月发布了?计算机软件开发规范?软件产品开发文件编制指南作为软件开发人员工作的准则和规程
[计算机]软件文档写作11-管理文档
![[计算机]软件文档写作11-管理文档](https://img.taocdn.com/s1/m/a8c6247db307e87100f69625.png)
初考始虑适除的当了项的时目余间量和进。人度员安、排环境往的往变是化，不资精源确和预的算，也但需要随着项目进展信息 的不断增恰多当，的进估算度方安法排是采也用会“越理来想－越实接际近”方项式目。实即先际进度，因此，必 须不断估更算理新想项值目，然进后度逐。步加入预计出现的状况、偶然因素
致成的状况、项目开发人员的素质和经验……
工作分解结构主要有4目个标用途：
1. 思路工具：可以描述项目的整体思路，是一个计
划和设计活动的工具；活动
活动
1级
2. 结构设计工具：是项目工作的结构图，可以清晰
表达项目各项工作间的相互关系； 2级
活动
活动
活动
3. 计划工具：能够展示项目全貌，说明为完成项目
所需完成的各项活动；
… …
4. 项 架目。状随态着报低告一工级具项活目：动活可动以的作完为成项，目项状目态由报m级下告而的上框 工作不包断整合任，务1某一任务项2工任作务的3 完…成将任成务为n 里程碑，所
可行性研究
可行性研究
可行性研究
可行性研究
可行性研究
可行性报告
用户需求
估算报告
体系结果设计
4
系统需求
4. 项目进度
项目在管进理度者估算要时求，估管理算者完需成要有各一项定活的余动量所。需的时间和资源，并将 它们严密如的项组目织难度起大来，，则花以费安的排时项间也目会进较度多。。又不如同，项的项目，具有不同 的项目目都开是个在别发估开进算发度项人目员。进可度能时发必生须的考变虑动的，因硬素件。环境的变化等，
1. 项目开发计有划价书值。如随着项目需求的逐渐明确引起的项目计
项目开发计划划书细的化具、体项内目容可随提着供项资目源和变开化发引机起构的类项型目的计不划同的而变不同，一 般都会包括以下几化个等部。分： ① 项目目标。简述项所目以目，标在，实并际列工出作影中响，管理需的要约有束明条确件的，责如任预人算和、时间… ② 开发团队及人操的员变作安更原排实则。施，阐必来述要对团的项队控目组制计织。划方式实、施人维员护构，成并及对分项工目计划 ③ 软硬件资源需求。另分一析个和重列要出的所方需面资是源，，注在明组估织算文的档资时源，需就要要时考间及价格 ④ 工作分解。分虑解到项这目种为频一繁系变列更活的动需，要确定，项使目得里当程变碑更及发可生交时付，文文档 ⑤ 项目进度。描档述的项相目应各部活分动能之够间容的易依替赖换关。系、到达里程碑的时间等 ⑥ 风险分析。分析项目可能存在的风险、发生的可能性及应对风险的策略
致成的状况、项目开发人员的素质和经验……
工作分解结构主要有4目个标用途：
1. 思路工具：可以描述项目的整体思路，是一个计
划和设计活动的工具；活动
活动
1级
2. 结构设计工具：是项目工作的结构图，可以清晰
表达项目各项工作间的相互关系； 2级
活动
活动
活动
3. 计划工具：能够展示项目全貌，说明为完成项目
所需完成的各项活动；
… …
4. 项 架目。状随态着报低告一工级具项活目：动活可动以的作完为成项，目项状目态由报m级下告而的上框 工作不包断整合任，务1某一任务项2工任作务的3 完…成将任成务为n 里程碑，所
可行性研究
可行性研究
可行性研究
可行性研究
可行性研究
可行性报告
用户需求
估算报告
体系结果设计
4
系统需求
4. 项目进度
项目在管进理度者估算要时求，估管理算者完需成要有各一项定活的余动量所。需的时间和资源，并将 它们严密如的项组目织难度起大来，，则花以费安的排时项间也目会进较度多。。又不如同，项的项目，具有不同 的项目目都开是个在别发估开进算发度项人目员。进可度能时发必生须的考变虑动的，因硬素件。环境的变化等，
1. 项目开发计有划价书值。如随着项目需求的逐渐明确引起的项目计
项目开发计划划书细的化具、体项内目容可随提着供项资目源和变开化发引机起构的类项型目的计不划同的而变不同，一 般都会包括以下几化个等部。分： ① 项目目标。简述项所目以目，标在，实并际列工出作影中响，管理需的要约有束明条确件的，责如任预人算和、时间… ② 开发团队及人操的员变作安更原排实则。施，阐必来述要对团的项队控目组制计织。划方式实、施人维员护构，成并及对分项工目计划 ③ 软硬件资源需求。另分一析个和重列要出的所方需面资是源，，注在明组估织算文的档资时源，需就要要时考间及价格 ④ 工作分解。分虑解到项这目种为频一繁系变列更活的动需，要确定，项使目得里当程变碑更及发可生交时付，文文档 ⑤ 项目进度。描档述的项相目应各部活分动能之够间容的易依替赖换关。系、到达里程碑的时间等 ⑥ 风险分析。分析项目可能存在的风险、发生的可能性及应对风险的策略
软件文档写作课件
明确项目目标很重要，但不太容易
1 2 3 4 5
建立项目组织结构和职责
矩阵式组织结构 职责
质量保证人员 项目经理 客户代表 客户经理 测试经理 高级管理者 项目管理委员会
SCCB
测试人员
配置管理人员
技术经理
实施经理
需求人员
设计人员
编码人员
实施人员
1 2 3 4 5
确定项目采用的生命周期模型
生命周期的阶段构成
1 2 3 4 5
WBS分解的要求
分解后的任务应该是： 可管理的、可定量检查的、可分配任务的、独立的 复杂工作至少应分解成二项任务 每项工作的持续时间不能太长 不体现工期和任务的先后顺序
要包括管理活动：项目管理、质量保证、配置管理、 项目总结等
任务分解是大家商讨出的，不是项目经理自己定的。
1 2 3 4 5
配置管理计划 质量保证计划 项目进度报告 项目总结报告
1 2 3 4 5
《项目工作规范》编制目的
为项目争取资源 确定甲乙双方组织结构和人员 确定客户方对项目应有的配合 确定甲乙双方沟通交流方式、方法 确定项目组共同遵守的标准和规范
确定项目总体进度计划
确定项目质量控制措施和计划 确定项目的主要成果 评估项目风险
2、软件管理文档（8学时）
（1）项目工作规范（2学时） （2）项目工作计划（2学时） （3）配置管理计划（1学时） （4）质量保证计划（1学时） （5）项目进度报告（1学时） （6）项目总结报告（1学时）
5、软件文档管理（2学时）
（1）文档评审（1学时） （2）文档跟踪（1学时）
王海舰的就业指导课（10学时）
CMM的5个等级
持续改进的过程
5、优化级Optimizing 关注过程改进
软件文档写作11-管理文档
风险描述 有经验的职员未完成项目就跳槽 不同的管理层考虑、关注的事情会不同 项目所需的基础硬件没有按期交付 软件需求与预期的相比，将会有较大变化 有关主要接口的描述未按期完成 过低估计了系统的规模 支持项目的CASE工具达不到要求 系统的基础技术被新技术取代 系统还未完成，其它有竞争力的产品就已经上市了
持续时间(天数) 8 15 15 10 10 5 20 25 15 15 7 10
依赖关系
T1(M1)
T2，T4(M2) T1，T2(M3)
T1(M1) T4(M5) T3，T6(M4) T5，T7(M7) T9(M6) T11(M8) 6
条形图和活动网络图是表示项目进度的两种图形表示法。
(1) 条形图。又称甘特图法(Gantt Chart)，可以表示面向活动 的负责人是谁，以及活动的开始和结束时间。如下图所示的例 子。
里程碑的建立，可以描述软件开发活动一个过程的终结。在 每个里程碑，都有一个正式的可以提交给管理层的阶段性结果。 比如，一份报告。
里程碑报告的内容不拘，以能清楚说明阶段性结果为标准， 应能代表项目中一个特定逻辑意义上的阶段的终结。
要建立里程碑，软件过程就一定要分解成一系列相关的基本 活动，e而每个基本活动都要有相应的输出结果。如下图，是一 个需求描述中的活动，其中每个活动都有主要输出。
员和用户之间相互沟通、协调的窗口。
管理文档的组成：
管理文档有以下几个方面的作用：
项目开发计划
软件管理文档
测试计划 测试分析报告 开发进度报告 开发总结报告
软件开发 管理人员
软件开发人员
维护人员
软件管 理文档
软件操作 人员
用户
1
3. 项目里程碑与阶段性文档
软件文档写作--概述 ppt课件
观点：“如果不记下来，它就并不存在”。
PPT课件
15
1.2 软件文档的定义
软件文档写作是为了记录目标系统的定义、规划、分析、研究、设计、开 发、应用等各个阶段的设计思想和研究成果。
文档——某种数据媒体和其中所记录的数据。 文档具有永久性，并可供人或机器阅读，通常指专供人阅读的东西。 文档作为计算机软件的重要组成部分，告诉用户如何操作和维护系统，提 供关于未来改进和重新实施所需的信息，在开发人员、维护人员、管理人员、 用户与计算机之间起着重要的桥梁作用。
维护和修改建议
可行性研究与计 划
√
√
需求分 析
√ √ √ √
软件设 计
√ √ √ √
√
√
√
√
√
√
PPT课件
编码与单元测 集成与测 运行与维
试
试
护
√
√
√
√
√
√
√
√
√
23
软件文档最终需要回答读者关心的下列问题： 1. 为什么要开发、维护或修改这个软件？(Why) 2. 工作目标要满足哪些需求？(What) 3. 需求应如何实现？(How) 4. 开发、维护或修改的工作应由谁来完成？(Who) 5. 开发工作的时间如何安排？(When) 6. 开发工作在什么环境中实现，所需信息从何而来？(Where)
软件文档的编制是随着软件生存期各个阶段工作的开展而适时进行的。 其中，有的仅反映某一阶段的工作，有的则需要跨越多个阶段的工作。
PPT课件
22
表1 软件生存周期各个阶段与各种文档编制的关系
可行性研究报告 项目开发计划 软件需求说明书 数据要求说明书 测试计划 概要设计说明书
详细设计说明书
PPT课件
15
1.2 软件文档的定义
软件文档写作是为了记录目标系统的定义、规划、分析、研究、设计、开 发、应用等各个阶段的设计思想和研究成果。
文档——某种数据媒体和其中所记录的数据。 文档具有永久性，并可供人或机器阅读，通常指专供人阅读的东西。 文档作为计算机软件的重要组成部分，告诉用户如何操作和维护系统，提 供关于未来改进和重新实施所需的信息，在开发人员、维护人员、管理人员、 用户与计算机之间起着重要的桥梁作用。
维护和修改建议
可行性研究与计 划
√
√
需求分 析
√ √ √ √
软件设 计
√ √ √ √
√
√
√
√
√
√
PPT课件
编码与单元测 集成与测 运行与维
试
试
护
√
√
√
√
√
√
√
√
√
23
软件文档最终需要回答读者关心的下列问题： 1. 为什么要开发、维护或修改这个软件？(Why) 2. 工作目标要满足哪些需求？(What) 3. 需求应如何实现？(How) 4. 开发、维护或修改的工作应由谁来完成？(Who) 5. 开发工作的时间如何安排？(When) 6. 开发工作在什么环境中实现，所需信息从何而来？(Where)
软件文档的编制是随着软件生存期各个阶段工作的开展而适时进行的。 其中，有的仅反映某一阶段的工作，有的则需要跨越多个阶段的工作。
PPT课件
22
表1 软件生存周期各个阶段与各种文档编制的关系
可行性研究报告 项目开发计划 软件需求说明书 数据要求说明书 测试计划 概要设计说明书
详细设计说明书
软件文档管理指南76页PPT
55、 为 中 华 之 崛起而 读书。 ——周 恩来
谢谢！
51、 天 下 之 事 常成 于困约 ，而败 于奢靡 。——陆 游 52、 生 命 不 等 于是呼 吸，生 命是活 动。——卢 梭
53、 伟 大 的 事 业，需 要决心 ，能力 ，组织 和责任 感。 ——易 卜 生 54、 唯 书 籍 不 朽。——乔 特
软件文档管理指南
21、没有人陪你走一辈子，所以你要 适应孤 独，没 有人会 帮你一 辈子， 所以你 要奋斗 一生。 22、当眼泪流尽的时候，留下的应该 是坚Байду номын сангаас 。 23、要改变命运，首先改变自己。
24、勇气很有理由被当作人类德性之 首，因 为这种 德性保 证了所 有其余 的德性 。--温 斯顿． 丘吉尔 。 25、梯子的梯阶从来不是用来搁脚的 ，它只 是让人 们的脚 放上一 段时间 ，以便 让别一 只脚能 够再往 上登。
谢谢！
51、 天 下 之 事 常成 于困约 ，而败 于奢靡 。——陆 游 52、 生 命 不 等 于是呼 吸，生 命是活 动。——卢 梭
53、 伟 大 的 事 业，需 要决心 ，能力 ，组织 和责任 感。 ——易 卜 生 54、 唯 书 籍 不 朽。——乔 特
软件文档管理指南
21、没有人陪你走一辈子，所以你要 适应孤 独，没 有人会 帮你一 辈子， 所以你 要奋斗 一生。 22、当眼泪流尽的时候，留下的应该 是坚Байду номын сангаас 。 23、要改变命运，首先改变自己。
24、勇气很有理由被当作人类德性之 首，因 为这种 德性保 证了所 有其余 的德性 。--温 斯顿． 丘吉尔 。 25、梯子的梯阶从来不是用来搁脚的 ，它只 是让人 们的脚 放上一 段时间 ，以便 让别一 只脚能 够再往 上登。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
工作分解结构设计一
目标
般可以采用2种方法：
活动
活动
活动
1级
2级
活动
活动
活动
- 自上而下的方法。从 项目的目标开始， 逐步分解，直到具 体任务
… …
- 自下而上的方法。也
工作包
活动 m级
任务1 任务2 任务3 … 任务n
称集思广益法。即 从底层开始，逐层 集成，最后汇合后
完成目标
软件文档写作-第7讲管理文档(完整)
• 提供了管理人员、开发人员、操作人员和用户之间相互沟 通、协调的窗口
软件文档写作-第7讲管理文档(完整)
3
7.2 项目开发计划
项目开发计划又称软件定义文档，是和软件本身一样重要的 知识资产，是项目启动后第一件最重要的工作。
项目开发计划一般包括资源需求、工作分解、工作目标、开 发团队及人员安排、进度安排、内外接口约定、风险分析以及软 件质量控制机制等。
软件文档写作-第7讲管理文档(完整)
10
5. 运用图和表描述项目进度 项目进度可以采用图表工具更直观的表示任务分解、活动依赖
4
制定项目开发计划的过程被称为项目策划。
由于计划所具有的在时间上的提前性，项目开发 计划通常会经常性的修正，有些部分甚至会频繁的改 变！
而部分内容的变化，会影响开发计划的正确性和 符合性，使其越来越偏离项目实际，最后变得没有价 值。如随着项目需求的逐渐明确引起的项目计划细化、 项目可提供资源变化引起的项目计划的变化等。
6
工作分解结构主要有4个用途：
1. 思路工具：可以描述项目的整体思路，是一个计划和设 计的工具；
2. 结构设计工具：是项目工作的结构图，可以清晰表达项 目各项工作间的相互关系；
3. 计划工具：能够展示项目全貌，说明为完成项目所需完 成的各项活动；
4. 项目状态报告工具：可以作为项目状态报告的框架。随 着低一级项目活动的完成，项目由下而上不断整合，某 一项工作的完成将成为里程碑，所以，工作分解结构就 定义了里程碑事件。
软件管理文档
测试计划 测试分析报告 开发进度报告 开发总结报告
管理文档有以下几个方面的作用：
维护人员
软件开发 管理人员
软件开发人员
软件管 理文档
软件操作 人员
用户
软件文档写作-第7讲管理文档(完整)
2
• 管理文档的作用主要体现在三个方面
• 是软件开发各阶段工作成果的体现
• 把软件开发过程中的一些“不可见”的事物转换成“可见”的 文字资料
第七讲 软件管理文档
软件文档写作-第7讲管理文档(完整)
1
7.1 管理文档概述
工程化的软件生产方式是软件业界始终在不懈追求的目标。软 件项目管理方法适用与否，对软件项目的成败有着举足轻重的作 用。而软件项目管理方法改进的途径之一，就是建立行之有效、 可操作性强的软件管理文档。
管理文档的组成：
项目开发计划
软件文档写作-第7讲管理文档(完整)
7
3. 项目里程碑与阶段性文档
由于软件产品是无形的，因此，管理者需要通过文档的形式获 得信息，了解软件的开发状况，以作出管理的决定。
里程碑的建立，可以描述软件开发活动一个过程的终结。在 每个里程碑，都有一个正式的可以提交给管理层的阶段性结果。 比如，一份报告。
里程碑报告的内容不拘，以能清楚说明阶段性结果为标准， 应能代表项目中一个特定逻辑意义上的阶段的终结。
项目管理者要求估算完成各项活动所需的时间和资源，并将它 们严密的组织起来，以安排项目进度。不同的项目，具有不同的 项目开发进度。
初始的项目进度安排往往是不精确的，但随着项目进展信息 的不断增多，进度安排也会越来越接近项目实际进度，因此，必 须不断更新项目进度。
项目进度包括将一个项目分解为若干独立的活动，以及判断 完成这些活动所需的时间。通常，有些活动是可以并行的，项目 管理者应组织并协调这些并行的工作。项目进度过程见下图：
所以，在实际工作中，需要有明确的责任人和操 作原则，来对项目计划实施维护，并对项目计划的变 更实施必要的控制。
另一个重要的方面是，在组织文档时，就要考虑 到这种频繁变更的需要，使得当变更发生时，文档的 相应部分能够容易替换。
软件文档写作-第7讲管理文档(完整)
5
2. 工作分解结构
工作分解结构(work breakdown structure, WBS)是对整个 项目工作的分级描述，是项目计划开发的第一步。分解示意如 下图所示。
1. 项目开发计划书
项目开发计划书的具体内容随着项目和开发机构类型的不同而不同，一般
都会包括以下几个部分：
① 项目目标。简述项目目标，并列出影响管理的约束条件，如预算、时间…
② 开发团队及人员安排。阐述团队组织方式、人员构成及分工
③ 软硬件资源需求。分析和列出所需资源，注明估算的资源需要时间及价格
④ 工作分解。分解项目为一系列活动，确定项目里程碑及可交付文档
除了时间和人员、环境的变化，资源和预算也需要考虑适 当的余量。
恰当的估算方法是采用“理想－实际”方式。即先估算理 想值，然后逐步加入预计出现的状况、偶然因素致成的状况、 项目开发人员的素质和经验……
作为经验数据，一般在最初估算的基础上增加30%作为实 际可能发生的状况值，再预留20%的估算值给所谓不可预见 的其它问题，则进度估算的结果会较符合实际。
⑤ 项目进度。描述项目各活动之间的依赖关系、到达里程碑的时间等
⑥ 风险分析。分析项目可能存在的风险、发生的可能性及应对风险的策略
⑦ 监控机制。制定详细、可操作的项目监控机制，明确管理报告的递交时间
⑧ 开发估算。包括规模、工软作件量文档、写作成-第本7讲等管理的文估档(完算整，) 要求依据并积累历史数据
识别活动
识别活动 依赖关系
估算活动 的资源
为活动分 配资源
创建项目 图表
软件需求
活动图表及条形图
软件文档写作-第7讲管理文档(完整)
9
在进度ห้องสมุดไป่ตู้算时，管理者需要有一定的余量。
如项目难度大，则花费的时间也会较多。又如，项目个别 开发人员可能发生的变动，硬件环境的变化等，都是在估算 项目进度时必须考虑的因素。
要建立里程碑，软件过程就一定要分解成一系列相关的基本 活动，而每个基本活动都要有相应的输出结果。如下图，是一个 需求描述中的活动，其中每个活动都有主要输出。
可行性研究
需求分析
原型开发
设计研究
需求描述
可行性报告
用户需求 软件文档写估作-算第7报讲告管理文档(完整) 体系结构设计
系统需求
8
4. 项目进度