《如何为用户写计算机文档手册》求取 ⇩

序言1

目录1

用户文档应该做些什么6

第一部分　写作之前6

第一子部 获得背景信息6

第一章　理解计算机系统7

＊和程序员交谈8

＊阅读功能说明8

＊阅读程序说明18

＊进一步参考19

＊了解所涉及的技术19

第二章　理解用户20

＊确定用户范围20

＊确定用户需要22

＊和用户交谈22

＊确定文档的用途23

＊确定文档的范围23

＊确定文档的语言24

第三章　把你对系统的了解和用户对系统的7解加以比较24

＊确定用户能了解程序的哪些部分24

＊列出清单25

＊对你的了解进行反思26

第二子部 设计用户文档26

第四章　确定要写何种用户文档26

＊是否是培训手册？27

＊是否是参考手册？27

＊是否是综合手册？27

＊是否是在线用户文档？28

第五章　对用户文档进行组织28

＊确定可能的组织类型29

＊初步设计内容表31

＊确定所用的组织方式31

第六章　选择表达方式35

＊直叙式35

＊菜谱方式35

＊编号指教式36

＊剧本式37

＊四步法38

＊综合式39

＊进一步参考39

第七章　确定格式和版面设计39

＊确定格式39

＊确定版面设计40

＊进一步参考42

第八章　使用约定和标准42

＊使用约定42

＊使用标准44

第二部分　写作之中46

第三子部　使用正确的文风46

第九章　使用简洁的语言46

＊采用会话方式48

＊采用前后一致的语言49

＊使用缩写要谨慎50

＊采用正确的前后一致的大写法50

＊避免使用计算机术语51

＊进一步参考51

第十章　采用主动语态动词52

＊识别主动和被动语态动词52

＊尽量使用主动态动词53

＊用主动态动词构造句54

＊把被动态改为主动态55

＊进一步参考56

第十一章　使用有效的语法规则和标点56

＊要懂得语法56

＊使用连接词57

＊有选择地使用逗号58

＊有选择地使用分号59

＊谨慎地使用引号和下划线59

＊进一步参考60

第四子部　如何写文档的各个部分60

第十二章　写序言61

＊限定范围61

＊要有总的介绍61

第十三章　写输入指令说明62

＊规定职责62

＊指导文档的使用62

＊解释约定62

＊使用研究实例62

＊利用对计算机系统的理解63

＊举例说明64

＊提供输入步骤指示65

＊进一步参考68

第十四章　写操作指令说明68

＊解释命令69

＊要有按运行顺序的指令说明70

＊要包括实例72

＊对输出的每一部分作出解释73

第十五章　写输出说明73

＊附加例子75

＊对平衡收支和其它控制步骤进行解释76

＊对编辑报表或出错清单进行解释77

第十六章　写附录77

＊解释出错信息及纠错方法77

＊写出词汇表79

＊开列各种命令及函数79

＊提供指导79

＊要包括文档中出现的全部标题和副标题80

第十七章　目录定稿80

＊编制索引80

＊要在形式上体现层次81

＊使目录和标题相匹配81

＊使用小写罗马数字作页号81

＊包括举例和插图的清单81

第五子部　使用例子，框图和插图82

第十八章　使用例子82

＊使用研究实例82

＊使例子和说明文字尽量靠近83

＊断例要分明85

＊要有高质量底稿（图）85

＊使例子更醒目85

＊缩小质量要好86

第十九章　使用框图和插图86

＊使用处理步骤的框图86

＊使用表格88

＊使用插图89

＊利用可用资源制作插图90

第六子部　手册打字90

第二十章　手稿打字前的准备工作90

＊把框图放在最有用之处90

＊每个框图要加标题90

＊由打字员打手稿91

＊口授手册91

第二十一章　利用拥有的自动化工具92

＊瞭解功能93

＊利用词或正文处理器进行修改93

＊利用词或正文处理器编制索引94

＊利用文档处理器95

第三部分　写作之后95

第七子部　完善文档95

第二十二章　校对和编辑文档96

＊校对文档96

＊编辑文档97

第二十三章　评审文档98

＊确定评审人99

＊需要多层次评审人99

＊确定评审后修改的步骤99

＊修改的部分也要送审99

＊准备好审稿者的签名表99

＊定出审稿的步骤100

第二十四章　文档测试101

＊提交用户测试101

＊作者自行测试102

第二十五章　确定文档的装订形式105

＊活页形式105

＊进一步参考105

第八子部　为发行文档作准备105

＊书籍形式106

第二十六章　准备定稿106

＊确定页号107

＊搞好艺术加工和图形处理107

＊复制手册107

＊利用本单位排印设备107

＊准备把手册送印刷厂108

＊加入一封卷头信109

第二十七章　将手册送交用户109

第四部分　文档完成之后109

第九子部　发行文档109

＊保存所有手册拥有者的名单110

第二十八章　举办培训班110

＊制订培训计划111

＊利用培训手册112

＊利用参考手册112

＊利用手册中的例子112

＊进一步参考112

第十子部　更新文档112

＊注明修改日期113

第二十九章　制订更新步骤113

＊每当作出影响用户使用的修改就发更新通知113

＊使用修改线114

＊加入卷头信114

＊把修改材料送给每个手册拥有者115

第三十章　如何确定文档是否更新115

＊对每次更新发送新的目录115

＊对卷头信编号116

＊发表当前内容检查单117

＊检查手册118