结构化的技术写作与内容管理PDF电子书下载

第1章 技术写作与技术内容 1

1.1 技术写作的定义 1

1.2 历史和现在 2

1.3 技术写作的目的 4

1.4 技术写作创建技术内容 6

1.4.1 技术内容与市场内容 10

1.4.2 设计良好的技术内容成就高效沟通 12

1.4.3 技术内容是企业和组织的宝贵资产 14

1.4.4 什么样的技术内容才最有价值 22

第2章 结构化的技术写作与内容管理 29

2.1 什么是结构 29

2.2 什么是结构化写作 34

2.2.1 结构化写作的定义 34

2.2.2 结构化写作的特征 38

2.2.3 为什么要采用结构化的内容写作和管理 39

2.2.4 结构化技术写作对技术作者的影响与要求 49

第3章 内容结构的设计 52

3.1 转换思路 52

3.1.1 看到结构 53

3.1.2 提升组织的技术内容思路 55

3.2 结构化思维方法 58

3.3 考虑UPC＋M设计出有效的技术内容 65

3.3.1 U以用户为中心的写作 65

3.3.2 P产品和服务 72

3.3.3 C参考你的同行竞争对手 78

3.3.4 M要有管理内容的思路 79

3.4 设计内容结构的时候我们在设计什么 84

第4章 结构化技术写作的流程 92

4.1 第一阶段：研究阶段 95

4.1.1 研究用户 95

4.1.2 产品与服务体系 104

4.1.3 研究现有内容情况 109

4.2 第二阶段：设计阶段 113

4.2.1 设计技术内容体系和文档类型 113

4.2.2 创建每个文档的内容模型 115

4.2.3 基于产品的详细功能和用户任务设计内容模块 122

4.2.4 抽取已有内容的结构 127

4.2.5 内容模块的两个视图 132

4.2.6 内容模块的复用 136

4.2.7 结构化的内容定义 139

4.3 第三阶段：结构评审阶段 142

4.4 第四阶段：结构标准化阶段 144

4.4.1 将结构进行标准化 144

4.4.2 结构不是一成不变的 147

4.5 第五阶段：进行写作 149

4.5.1 写作原则 150

4.5.2 常见文档内容结构与写作方法 168

4.5.3 对内容的视觉辅助 195

4.5.4 嵌入式的信息辅助 206

4.6 第六阶段 结构化的内容评审 220

第5章 多渠道多形式的技术内容 223

5.1 技术内容渠道建设的重要性 223

5.2 梳理技术内容的渠道 224

5.3 常见的技术内容渠道 225

第6章 基于XML的结构化写作 235

6.1 XML简要介绍 236

6.1.1 元数据 239

6.1.2 XML文档的构成 242

6.1.3 DTD和Schema-XML的语义约束 245

6.1.4 XML的样式表 251

6.2 XML带来的好处以及变化 254

6.2.1 XML带来的好处 254

6.2.2 你的公司或所工作的组织是否需要XML 259

6.2.3 基于XML写作的方式需要作者什么样的能力 260

6.3 基于XML的结构化内容管理系统 263

6.4 常见的DTD—DITA 266

6.4.1 DITA概述 266

6.4.2 DITA的主题 274

6.4.3 DITA Map 281

6.4.4 DITA的复用 285

6.4.5 由传统写作转成DITA写作 289

6.5 其他常见DTD介绍 290

6.5.1 Docbook介绍 290

6.5.2 ATA100介绍 296

6.5.3 S1000D介绍 298

附录A 对《答辩攻略》的结构化修改 301

附录B 极简主义 308

结束语 310