用户文档的写作PDF电子书下载

第一章 用户文档的心理学 1

1.1 对问题的衡量 1

1.2 考虑读者的立场 3

1.3 确定书的正确结构 5

1.4 减轻读者的疑惑 7

第二章 一个优秀技术作者应具备的素质 10

第三章 调查——通往成功的必经之路 14

3.1 调查的程度 14

3.2 考虑读者的需要 14

3.3 确定最合适的篇幅 16

3.4 深入系统 18

3.5 开始调查 21

3.6 确定书的题目和类型 22

3.7 避开陷阱 22

3.8 结论 24

第四章 纸制品还是电子产品——现代技术的得失与联机手册的发展 25

4.1 阅读的原因和方法 25

4.2 联机文本的简历 26

4.3 选择文档介质 28

第五章 准备提纲和风格指南——写作与设计的协调 29

5.1 关于提纲 29

5.2 考虑的不同角度 30

5.3 写作风格、创作意图及对象 30

5.4 正文前的材料 30

5.5 正文 32

5.5.1 结构 32

5.5.2 标页号 33

5.5.3 章 33

5.5.4 使用问答的方法 34

5.6 标题 36

5.7 阅读指南的准备 36

5.8 准备示范样品 39

第六章 文件编辑的基本知识 43

6.1 统一的标准 43

6.2 考虑用户的环境 44

6.3 和作者一起工作 44

6.4 设计的创新 44

6.4.1 书页的尺寸 44

6.4.2 布局的协调平衡 45

6.4.3 栏／格 45

6.4.4 字体 46

6.4.5 页楣和注脚 47

6.4.6 符号和图表 49

6.4.7 其他 49

6.5 总结 49

第七章 获得图表与组合成书 50

7.1 屏幕显示和报告 50

7.1.1 收集好的例子 50

7.1.2 根据资料内容使用合理版式 51

7.1.3 图像显示 52

7.2 其他的图解性内容 52

7.3 图表的注释 53

7.4 书籍的“组装” 54

第八章 初稿、复稿、终稿——达到完美结果的三个步骤 56

8.1 初稿 56

8.2 哪些人将介入初稿审阅 58

8.3 从审稿人那里，你希望获得什么批注 58

8.4 如何给一个正在开发的系统写文档 59

8.5 如何解决面临更换审稿人的问题 59

第九章 创作有效文本的准则 61

9.1 我需要什么工具 61

9.2 开始写作 61

9.3 写作风格 63

9.3.1 选择你的词汇 63

9.3.2 使文本短小可读 64

9.3.3 使用符号和插图 64

9.3.4 保持风格的协调一致 67

9.4 书写正文前的材料准备 67

9.4.1 版权声明和版权书 68

9.4.2 责任书 68

9.4.3 保证书 69

9.4.4 商标 69

9.4.5 欢迎使用的信息或序言 69

9.4.6 目录 70

9.5 正文之后的材料 71

9.5.1 词汇表 71

9.5.2 索引 72

9.5.3 附录 73

9.6 个人编辑 74

9.7 处理作者的初稿 75

9.8 生产率 76

第十章 编辑——必要然而十分困难的工作 77

10.1 编辑工作的背景 77

10.2 谁来作编辑 78

10.3 初审 78

10.4 编辑外观及布局 79

10.5 专业编辑 80

10.6 “文字质量”或“英文编辑” 81

10.7 由谁来做修改工作 82

10.8 编辑的注释标记 82

10.9 总结 85

第十一章 如何使雇主一直信任你 86

11.1 最初的磋商 86

11.2 审定文档 87

11.3 审稿人注意事项 87

11.4 提纲与格式处理设计 88

11.4.1 审阅要点 88

11.5 初稿 88

11.5.1 审阅要点 89

11.6 复稿 89

11.6.1 审阅要点 90

11.7 终稿 90

11.8 索引 90

11.8.1 审阅要点 90

11.9 结论 90

第十二章 文档写作过程的管理 91

12.1 确定成书过程的各阶段 92

12.2 制定计划 92

12.3 安慰受伤的自我 95

12.4 与设计人、图解者、桌面印刷操作人员一起的工作 95

12.5 与雇主及其代表们的协作和联系 97

12.6 审稿人的人事变动 97

12.7 结束语 98

第十三章 文档制作过程中的基本问题——如何把最好的书放到书架上 99

13.1 可采取的不同方式 99

13.1.1 印刷方式 99

13.1.2 装订类型 100

13.1.3 选用的材料 101

13.2 注意事项 101

13.2.1 数量要求 102

13.2.2 更新图书 102

13.2.3 公司形象 102

13.2.4 读者 103

13.2.5 结论 103

13.3 选择印刷者时的注意事项 104

13.4 公司内部印刷还是送到外面印刷 104

13.5 监督印刷工作 104

第十四章 翻译写作——语言是唯一的问题吗？ 106

14.1 语言问题 106

14.2 翻译中的注意事项 108

14.3 如何翻译 109

14.3.1 术语准备 110

14.3.2 译者所在地的影响 110

14.3.3 回译 110

14.4 如何翻译采用桌面印刷的书籍 111

14.5 图例的翻译 112

14.6 制定翻译计划 112

第十五章 结束语 113

词汇 115