序言

目录

用户文档应该做些什么

第一部分　写作之前

第一子部 获得背景信息

第一章　理解计算机系统

＊和程序员交谈

＊阅读功能说明

＊阅读程序说明

＊进一步参考

＊了解所涉及的技术

第二章　理解用户

＊确定用户范围

＊确定用户需要

＊和用户交谈

＊确定文档的用途

＊确定文档的范围

＊确定文档的语言

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

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

＊列出清单

＊对你的了解进行反思

第二子部 设计用户文档

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

＊是否是培训手册？

＊是否是参考手册？

＊是否是综合手册？

＊是否是在线用户文档？

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

＊确定可能的组织类型

＊初步设计内容表

＊确定所用的组织方式

第六章　选择表达方式

＊直叙式

＊菜谱方式

＊编号指教式

＊剧本式

＊四步法

＊综合式

＊进一步参考

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

＊确定格式

＊确定版面设计

＊进一步参考

第八章　使用约定和标准

＊使用约定

＊使用标准

第二部分　写作之中

第三子部　使用正确的文风

第九章　使用简洁的语言

＊采用会话方式

＊采用前后一致的语言

＊使用缩写要谨慎

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

＊避免使用计算机术语

＊进一步参考

第十章　采用主动语态动词

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

＊尽量使用主动态动词

＊用主动态动词构造句

＊把被动态改为主动态

＊进一步参考

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

＊要懂得语法

＊使用连接词

＊有选择地使用逗号

＊有选择地使用分号

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

＊进一步参考

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

第十二章　写序言

＊限定范围

＊要有总的介绍

第十三章　写输入指令说明

＊规定职责

＊指导文档的使用

＊解释约定

＊使用研究实例

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

＊举例说明

＊提供输入步骤指示

＊进一步参考

第十四章　写操作指令说明

＊解释命令

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

＊要包括实例

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

第十五章　写输出说明

＊附加例子

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

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

第十六章　写附录

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

＊写出词汇表

＊开列各种命令及函数

＊提供指导

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

第十七章　目录定稿

＊编制索引

＊要在形式上体现层次

＊使目录和标题相匹配

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

＊包括举例和插图的清单

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

第十八章　使用例子

＊使用研究实例

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

＊断例要分明

＊要有高质量底稿（图）

＊使例子更醒目

＊缩小质量要好

第十九章　使用框图和插图

＊使用处理步骤的框图

＊使用表格

＊使用插图

＊利用可用资源制作插图

第六子部　手册打字

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

＊把框图放在最有用之处

＊每个框图要加标题

＊由打字员打手稿

＊口授手册

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

＊瞭解功能

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

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

＊利用文档处理器

第三部分　写作之后

第七子部　完善文档

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

＊校对文档

＊编辑文档

第二十三章　评审文档

＊确定评审人

＊需要多层次评审人

＊确定评审后修改的步骤

＊修改的部分也要送审

＊准备好审稿者的签名表

＊定出审稿的步骤

第二十四章　文档测试

＊提交用户测试

＊作者自行测试

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

＊活页形式

＊进一步参考

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

＊书籍形式

第二十六章　准备定稿

＊确定页号

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

＊复制手册

＊利用本单位排印设备

＊准备把手册送印刷厂

＊加入一封卷头信

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

第四部分　文档完成之后

第九子部　发行文档

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

第二十八章　举办培训班

＊制订培训计划

＊利用培训手册

＊利用参考手册

＊利用手册中的例子

＊进一步参考

第十子部　更新文档

＊注明修改日期

第二十九章　制订更新步骤

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

＊使用修改线

＊加入卷头信

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

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

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

＊对卷头信编号

＊发表当前内容检查单

＊检查手册