用户文档的写作【2025|PDF下载-Epub版本|mobi电子书|kindle百度云盘下载】

用户文档的写作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