《软件手册编写指南》求取 ⇩

目录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