软件手册编写指南PDF电子书下载

目录 1

序 1

引 言 1

本书的写作目的 1

好的手册是软件成功的关键 1

国内软件手册的现状和问题 1

好手册特征 3

本书的读者 3

本书的内容组织 4

第一部分软件手册的编写过程 7

第一章软件手册的写作过程 7

1.1软件手册写作模型 7

1.1.1计划阶段 7

1.1.3校对阶段 8

1.1.2写作阶段 8

1.1.4审核阶段 9

1.1.5发行阶段 9

1.1.6维护阶段 9

1.2软件手册写作流程举例 9

1.2.1计划阶段各工作步骤 10

1.2.2写作阶段各工作步骤 10

1.2.3生产阶段各工作步骤 11

1.3软件手册写作过程与软件开发过程的关系 11

第二章软件手册的写作控制 13

2.1制定软件手册写作计划 13

2.1.1制定软件手册整体写作计划 13

2.1.2制定每种手册具体写作计划 15

2.1.3软件手册写作计划示例 21

2.2制定手册写作进度时间表 22

3.1.1 页成分 25

3.1手册版面设计 25

第三章软件手册的设计 25

3.1.2简单版面设计 27

3.1.3复杂版面设计 27

3.2写作风格设计 35

第四章软件手册写作技巧 37

4.1 写作角度 37

4.2语言技巧 43

4.3段落组织 44

4.4专题论述 47

4.4.1如何划分概念 47

4.4.2如何定义概念 47

4.4.3如何写描述 48

4.4.4如何写操作过程 49

4.4.5如何选择实例 49

4.5技巧积累 50

4.4.6如何使用类比 50

第五章软件手册的图例设计 55

5.1 图例设计可能存在的问题 55

5.2建立图例索引 56

5.3图例设计过程 56

5.3.1拟定图例设计目标 57

5.3.2决定图例表现内容 57

5.3.3选择适当图例形式 58

5.3.4考虑媒体的影响 63

5.3.5绘制图例 63

5.3.6评估图例设计 65

5.3.7制作图例 65

5.4 图例介绍 65

5.4.1显示物品或事物的图例 65

5.4.2显示操作次序的图例 68

5.4.3显示系统组织结构的图例 77

5.4.4图标和视觉符号 80

5.5图例使用注意事项 82

第六章软件手册的信息检索机制 83

6.1软件手册的组成 83

6.2软件手册的检索机制 98

6. 2.1 目录 98

6.2.2图例索引和表格索引 99

6.2.3 引言 99

6.2.4段章标签 99

6.2.5页眉和页尾 99

6.2.6页号 99

6.2.7标题 100

6.2.8图例标题 101

6.2.9交叉引用 101

6.2.11词汇表 102

6.2.10附录 102

6.2.12索引 103

6.2.13快速参考卡片 104

第七章软件手册的校对审核及维护 105

7.1校对审核的工作重点 105

7.2校对审核版本的准备 105

7.3校对审核结果的处理 106

7.4软件手册可用性测试 110

7.5软件手册的维护 111

7.5.1改错处理 111

7.5.2 内容增删 112

7.5.3新版改写 112

8.3软件教程的内容结构 115

8.1软件教程的主要内容 115

8.2软件教程写作指南 115

第八章软件教程的组织 115

第二部分 软件手册的内容组织 115

8.4联机教程和印刷教程的比较 116

8.5教程范例 116

8.5.1印刷教程范例 116

8.5.2联机教程范例 126

第九章操作指南的组织 133

9.1操作指南写作指南 133

9.2操作指南的内容结构 133

9.3操作指南范例 134

第十章参考手册的组织 141

10.1参考手册写作指南 141

10.2参考手册的内容结构 141

10.3参考手册范例 142

11.2快速参考手册范例 156

11.1快速参考手册写作指南 156

第十一章快速参考手册的组织 156

第十二章 联机求助系统和屏幕信息的组织 164

12.1 联机手册的优点和缺点 164

12.2联机手册屏幕设计原则 165

12.3联机求助系统设计指南 165

12.4联机求助系统的基本信息 166

12.5联机求助系统范例 166

附录手册写作计划信息要览 175

A.1软件描述表 175

A.2手册资料来源 176

A.3手册用户描述表 177

A.4手册描述表 178

A.5手册版式说明书 179

A.6手册写作组 181

图例索引 182

表格索引 183