技术传播那些事儿技术文档写作

书单 | 有哪些技术传播从业者必知必看的书籍？

2017-09-24  本文已影响70人  Lilian_Lee

如果你是一个 Technical Writer/Communicator，或者对技术传播/技术写作特别感兴趣，那太好了！我们可以交流下看法心得，分享下自己认为比较有价值的行业书籍。

对于技术传播行业的书籍，要保持一个开放的态度。这个行业在国外已经很成熟，只是国内起步较晚，阅读一些专业书籍有助于对这个行业形成系统性的全局认识，熟悉国际通用的一些规范。

技术传播行业相关的书有很多，今天我先跟大家分享 10 本，如有必要，之后会继续跟大家分享。

有些 Style Guide 勘称卷帙浩繁，完全可以当词典来用。并不是说一定要去严格遵守某个 Style Guide，而是可以结合实际的产品和工作需求，选择和制定一些适用的规范。一旦制定，在组织内部就要遵守，保证文档输出风格的一致性。

另外，说到规范，我想起最近看的一本书中的一句话，比较认同，即 Robin Williams 在 The Non-Designer’s Design Book 这本书中关于打破规则的观点:

You must know what the rule is before you can break it.

所以，就算你任性地决定不遵守规则，那也要先知道都有哪些规则。如此便可以说，你是深思熟虑后根据实际情况决定放弃某些不需要、不匹配的规则。

好啦，下面是严肃的书籍分享时间~

1. Developing Quality Technical Information

书名：Developing Quality Technical Information: A Handbook for Writers and Editors

作者：Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, Elizabeth Wilde

出版社：IBM Press

对技术传播/技术写作稍有了解的小伙伴肯定都知道这本书，也应该知道这本书的三大块核心内容：Easy to use, Easy to understand, Easy to find。

这本书比较系统地、具体地结合实例讲解了一些基本的写作规范，在业内认可度也比较高，强烈推荐。本书受众是 writer、editor 和 reviewer，其中 reviewer 包括信息开发过程中的以下角色：

内容概览：

2. DITA Best Practices

书名：DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA

作者：Laura Bellamy, Michelle Carey, and Jenifer Schlotfeldt

出版社：IBM Press

DITA 即 Darwin Information Typing Architecture，专门用于支持基于 topic 的写作。那么，什么是 topic 呢？本书中的这句话很容易理解：

A topic is a self-contained unit of information. An effective topic covers only one subject. Each topic is long enough to make sense on its own, but short enough to stick to one point without expanding into other subjects.

DITA 主要提供三种类型的 topic：concept、task 和 reference。简单理解，也就是 How、What 和其它。这三种 topic 的用途和区别如下：

  • A task topic describes one procedure.
  • A concept topic defines what something is or how a process works.
  • A reference topic contains one type of reference information that users might need as they perform tasks.

我之前做过蛮长一段时间的 DITA 写作，用的工具是 Arbortext，各种标签，轻便易上手。如果你想了解 DITA 的话，推荐这本书。

内容概览：

3. The IBM Style Guide

书名：The IBM Style Guide: Conventions for Writers and Editors

作者：Francis DeRespinis, Peter Hayward, Jana Jenkins, Amy Laird, Leslie McDonald, Eric Radzinski

出版社：IBM Press

这本书的内容特别详细，几乎涵盖了在技术写作中可能遇到的各种细节问题。写作时遇到有疑惑的地方不知道如何处理时，可以查阅一下此书作为参考。

关于这本书，我的建议是不必奢求一口气看完全记住。实践证明，这本书细到让你很快体会到头大的感觉，而且有些内容前后有一定的交叉重复。

更便捷更实用的使用方式是，掌握这本书的框架结构，哪个部分讲了什么内容，当你想查找某个问题的时候，能很快找到。当然，有些常用的基本规范还是要记住的。

先来看下章节目录感受一下吧~

内容概览：

  1. Language and grammar
  2. Punctuation
  3. Formatting and organization
  4. Structure
  5. References
  6. Numbers and measurements
  7. Computer interfaces
  8. Writing for diverse audiences
  9. Glossaries
  10. Indexes

4. The Chicago Manual of Style

书名：The Chicago Manual of Style: The Essential Guide for Writers, Editors, and Publishers

作者：University of Chicago Press Staff

出版社：University Of Chicago Press

这是一本相当大部头的书，同样具备字典属性，比 The IBM Style Guide 还要细。只 Punctuation 这一部分的目录就有三页之多。不要有压力，先来看下结构目录（以下二级目录只列了 Part Two 示例）：

内容概览：

5. Microsoft Manual of Style for Technical Publications

书名：Microsoft Manual of Style for Technical Publications

作者：Microsoft Corporation Editorial Style Board

出版社：Microsoft Press

顾名思义，这本书是 Microsoft 的 Style Guide。当然，跟 IBM 的类似，也很详细。这本书的 Part 1 包含 12 章；Part 2 是个 Usage Dictionary，即用词规范。例如：

canceled, canceling One l, but use two l’s in the noun cancellation.

内容概览：

6. Information Development

书名：Information Development: Managing Your Documentation Projects, Portfolio, and People

作者：JoAnn T. Hackos, PhD

出版社：Wiley Publishing, Inc.

Information Development 是 Technical Writing 的另一种说法。这本书从管理的角度出发，阐述了如何对文档项目进行管理。

其中涵盖了一些最佳实践，如 Best Practices in Information Development Management，Best Practices in Developing Effective Teams。如果你想了解文档的管理，可以看下此书。

内容概览：

7. Technical Translation

书名：Technical Translation: Usability Strategies for Translating Technical Documentation

作者：Jody Byrne

出版社：Springer

在实际工作中，Technical Communicator 经常需要将技术文档从一种语言翻译为另一种语言。

我在技术写作实例解析 | 若脱离理解，直译得再正确又有何意？这篇文章中结合实例分享了技术翻译中理解的重要性。如果你想系统地了解下技术翻译，推荐此书。

内容概览：

8. Style: Lessons in Clarity and Grace

书名：Style: Lessons in Clarity and Grace

作者：Joseph M. Williams; Revised by Joseph Bizup

出版社：Pearson

这本书基于这样一种观点："it is good to write clearly, and anyone can do it." "Everything that can be said can be said clearly. —Ludwig Wittgenstein"

写作一定要足够简洁清晰，不要一味堆砌貌似华丽的辞藻，搞得可读性很差，失去了写作的意义。简洁清晰即是美。要进行英语写作的小伙伴，这本书值得一看。

内容概览：

9. Technical Communication

书名：Technical Communication: A Reader-Centered Approach

作者：Paul V. Anderson

出版社：Wadsworth

这本书的书名就是技术传播，也是一本很系统的书。作为一个 Technical Communicator，这本书还是有必要读一下，有助于提升 writing 和 design 技能。本书 Part 6 就是关于 Visual Elements 的，特别详细，包含很多条实用的 guideline，只 reader-centered graphics 就讲了 11 种。

内容概览：

10. Handbook of Technical Writing

书名：Handbook of Technical Writing

作者：Gerald J. Alred, Charles T. Brusaw, Walter E. Oliu

出版社：Bedford/St. Martin’s

这本书中有一句对 Technical Writing 的概括描述，很到位：

Successful writing on the job is not the product of inspiration, nor is it merely the spoken word converted to print; it is the result of knowing how to structure information using both text and design to achieve an intended purpose for a clearly defined audience.

书中讲到 Five Steps to Successful Writing：

其中 Research 这部分的核心是："The only way to be sure that you can write about a complex subject is to thoroughly understand it."

我在技术写作实例解析 | 若脱离理解，直译得再正确又有何意？这篇文章中的实例分享就是关于这一点。如果你想了解如何做 Technical Writing，此书建议一读。

内容概览：

好啦，这次分享的 10 本书到此为止，有问题请随意留言。书的海洋那么大，有空去看看吧！

你可能想读：
若脱离理解，直译得再正确又有何意？
写在入职技术型创业公司 PingCAP 一个月之后

-END-

上一篇 下一篇

猜你喜欢

热点阅读