科技文档写作实务PDF电子书下载

1概述篇 1

1.1什么是技术文档 2

1.1.1技术文档的定义 2

1.1.2技术文档的范畴 2

1.1.3技术文档的特征 4

1.1.4技术文档的多种形式 4

1.2技术文档写作的国际国内现状 5

1.3技术文档写作的重要意义 6

2基础篇 7

2.1技术文档写作流程 8

2.1.1需求分析 9

2.1.2架构设计 10

2.1.3文档写作 10

2.1.4质量控制 11

2.1.5文档发布 12

2.1.6文档交付 12

2.1.7文档维护 12

2.2需求分析 13

2.2.1信息收集 13

2.2.2简化归类 15

2.2.3分析需求 18

2.2.4确定文档开发任务 20

2.3架构设计 21

2.3.1架构前的准备和学习 21

2.3.2设计架构 22

2.3.3架构检查 25

2.4文档写作 26

2.4.1写作的逻辑 26

2.4.2写作6步法 28

2.4.3写作黄金法则 28

2.5质量控制 31

2.5.1质量控制活动 31

2.5.2高质量文档三要素 34

3进阶篇 37

3.1实用性 38

3.1.1安全第一 39

3.1.2内容准确 41

3.1.3面向任务 45

3.1.4合理组织 49

3.1.5内容完整 58

3.2可读性 61

3.2.1易读 62

3.2.2易理解 75

3.3舒适性 85

3.3.1文档获取便捷 86

3.3.2内容检索高效 87

3.3.3阅读感受舒适 92

4实战篇 101

4.1如何写需求说明书 102

4.1.1需求说明书简介 102

4.1.2需求说明书内容框架 102

4.1.3需求说明书写作流程 104

4.1.4需求说明书写作实例 106

4.1.5需求说明书写作要点 111

4.1.6需求说明书常见问题 111

4.2如何写概要设计文档 112

4.2.1概要设计文档简介 112

4.2.2概要设计文档内容框架 113

4.2.3概要设计文档写作流程 114

4.2.4概要设计文档写作实例 117

4.2.5概要设计文档写作要点 121

4.2.6概要设计文档常见问题 121

4.3如何写软件模块详细设计文档 123

4.3.1软件模块详细设计文档简介 123

4.3.2软件模块详细设计文档内容框架 123

4.3.3软件模块详细设计文档写作流程 124

4.3.4软件模块详细设计文档写作方法 125

4.3.5软件模块详细设计文档写作要求 131

4.4如何编写测试用例 144

4.4.1测试用例简介 144

4.4.2测试用例内容框架 144

4.4.3测试用例写作流程 146

4.4.4测试用例写作实例 148

4.4.5测试用例写作要点 152

4.4.6测试用例常见问题 152

4.5如何写使用指导文档 155

4.5.1使用指导文档简介 155

4.5.2使用指导文档内容框架 155

4.5.3使用指导文档写作流程 156

4.5.4使用指导文档写作实例 157

4.5.5使用指导文档写作要点 171

4.5.6使用指导文档常见问题 171

4.6如何写故障处理文档 173

4.6.1故障处理文档简介 173

4.6.2故障处理文档内容框架 173

4.6.3故障处理文档写作流程 174

4.6.4故障处理文档写作实例 177

4.6.5故障处理文档写作要点 179

4.6.6故障处理文档常见问题 179

5附录 主题类型 183

5.1概念（Concept） 184

5.2任务（Task） 185

5.3参考（Reference） 186