当前位置:首页 > 工业技术
如何为用户写计算机文档手册
如何为用户写计算机文档手册

如何为用户写计算机文档手册PDF电子书下载

工业技术

  • 电子书积分:8 积分如何计算积分?
  • 作 者:秦笃烈译编
  • 出 版 社:中国科学院希望高级电脑技术公司
  • 出版年份:2222
  • ISBN:
  • 页数:118 页
图书介绍:
《如何为用户写计算机文档手册》目录

序言 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

相关图书
作者其它书籍
返回顶部