Foreword
之前在 Technical Writer 不只是写产品说明书的中列举了一些进入 Technical Writer 或 Technical Communicator 这一行很可能会接触到的一些文档类型，让大家有了一个初步的印象。
这一篇将直观而具体地说一说 8 种常见的技术文档类型，即 Technical Writer 可能提供的交付物。本文结构如下：
- 文档交付物的多种介质
- STC 对技术传播文档类型的划分
- 深入了解几种常见的技术文档类型
文档交付物的多种介质
或许有些小伙伴对 Technical Writer 这一职业的认识还停留在只是写写文字的层面，但事实不是这样的。公司对文档的需求早已多样化，文档交付也有多种介质。
当然，不同的 Technical Writer 可能各有分工，不是每个人都能接触到多种交付形式。但还是应该多了解一下~
从技术传播的角度来看，Technical Writer 提供的文档交付物至少包含以下几种介质：
- 在线文档
- 打印的文档
- 视频
- 音频
其中，在线文档最为便捷，制作成本也最低，更新起来操作简单。视频音频的制作需要较高的时间和人力成本，而且不便于后续的更新修改，但在某些场景下效果很好。
选择哪种介质需要根据实际需求，结合时间和人力成本等因素来综合判断。
STC 对技术传播文档类型的划分
STC 全称为 Society for Technical Communication，是致力于推进技术传播的艺术与科学的个人会员组织，也是技术传播领域该类组织中最大的一个。
STC 官网：https://www.stc.org/
STC 将 Technical Communicator 可交付的文档类型分成了四大类：
- 讲解产品、服务和政策的文档。例如：帮助文档、技术支持网站、使用指南、服务指南、参考资料，以及政策和程序等材料。
- 分享基础的科技信息的文档。例如：技术报告、科学文章、会议演示文稿，以及长如写一本书的项目等。
- 帮助用户提高技能的培训文档。例如：在线教程、快速查阅，以及面对面的教室或虚拟教室中使用的材料。
- 协助产品营销和服务的文档。例如：提案、营销网站、白皮书、产品目录、宣传册和简报等。
深入了解几种常见的技术文档类型
技术传播的文档种类众多，这里跟大家分享 8 种常见的文档类型。
通常，在大公司里，每一种文档类型都有专门的团队来负责；而在创业公司里，可能一个小团队要输出多种类型的文档。
- User Guide
- Administrator Guide
- Troubleshooting
- FAQs
- How To Guide
- Release Notes
- Case Studies
- Whitepaper
1. User Guide
从字面意义上来讲，User Guide 可以说是最符合他人对 Technical Writer 的认知了。确实，User Guide 是 Technical Writer 工作中最重要的、最常见的文档之一。不过，这可不是全部哦~
Wikipedia 对 "user guide" 的解释如下：
A user guide or user's guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system. It is usually written by a technical writer, although user guides are written by programmers, product or project managers, or other technical staff, particularly in smaller companies.
User Guide 对应的中文有：用户文档、用户指南、使用指南、用户手册等。
我们平时说到“用户文档”时，一般是指某个产品全部的用户文档，即面向各种用户的文档，此时也将 FAQ，Troubleshooting，Administrator Guide，How-to Guide 等包含在内。本文为了区分，在下文将这些文档类型单独作为一个类别。
在实际写文档和设计文档架构的时候，考虑到不同的用户受众，有时就会在文档架构上区分。此时若是 User Guide 和 Administrator Guide 并列，那这里的 User Guide 一般用来指面向普通用户的使用指南，Administrator Guide 则是面向管理员的使用指南，例如数据库管理员。
一般在大部分公司的英文官网上，你会看到菜单栏有 "DOCS" 或 "Docs" 或 "Documentation" 这一项，点进去就是你想找的用户文档了。
2. Administrator Guide
Administrator Guide，一般指面向管理员或运维人员的文档。对于数据库产品来说，这类文档是必须的。Oracle 将其叫做 Administrator’s Guide，Redis 将其叫做 Administrator Guide 和 Operations and Administration Guide。
如果在导航栏或文档目录里显示的时候，除了 Administrator Guide 之外，还有 Administration、Administering 等多种选择。
无论选词如何，不同公司在设计自己产品的文档目录时也存在差异，比如 Administrator Guide 里面应该包含哪些内容。
3. Troubleshooting
Troubleshooting 是指故障诊断的文档。例如，在使用数据库时遇到的问题该如何解决。与之相比，下文提到的 FAQs 则是用户常问的一些问题，更有针对性更为具体，种类也更丰富。
在导航栏或文档目录里显示时，这类文档可以是 Troubleshooting，也可以使用更为简洁的 Troubleshoot。
4. FAQs
FAQ 即 Frequently Asked Questions，指用户常问到一些问题和解答，可以理解为一系列的 Questions and Answers (Q&A)。
在导航栏或文档目录里显示时，可以直接使用 FAQs 或 FAQ，或者为了避免少数用户不了解缩写的意思，使用 Frequently Asked Questions。
5. How To Guide
How To Guide，顾名思义，是一系列用户如何操作、使用某个产品的 topic。这类文档收集了用户常见操作，跟 User Guide 相比，让用户查找起来更便捷。
当然，How To Guide 中的文档内容不一定是重新从头写的，完全可以重用其它类型的现有文档里的内容。例如，直接设置跳转链接。
6. Release Notes
Release Notes，中文叫“版本发布说明”，指的是对产品某个版本的说明，主要是与之前版本相比做了哪些改进。
这也是 Technical Writer 工作中经常接触到的一类文档，通常会由开发人员提供源内容，Technical Writer 调整语言表述、规范表达、标点和格式等。此外如有需求，还需进行不同语言之间的翻译，以提供多种语言版本。
7. Case Studies
Case Studies 或者叫 Success Stories，通常是一些典型的、具有代表性的、成功的用户案例。这些用户案例对于其它对该产品感兴趣的用户有极大的参考意义，也会增强潜在用户对产品的信心。
在官网的菜单栏或者底部导航栏里，常会见到 CUSTOMERS 这一项，里面会放一些用户案例或产品典型的适用场景。这些用户案例就是 Case Studies 或 Success Stories。
8. Whitepaper
Whitepaper 或者分开写做 White Paper 均可，中文叫白皮书，也是产品必不可少的文档之一。这类文档既可以帮助用户快速而宏观地了解一个产品，也可以帮助用户快速了解该产品的适用场景是否符合自己的需求。
拿数据库产品的白皮书来举例：
- 有的产品的白皮书是按行业分类的，撰写自己产品适用于各个行业的白皮书，用户可以根据自己的行业有选择地阅读相应的白皮书；
- 有的白皮书是从产品功能的角度来撰写的，可以让用户快速了解最新的产品特性；
- 还有的白皮书是按照不同的受众角色来划分的。
在官网的菜单栏或者底部导航栏里，Whitepaper 通常会放在 RESOURCES 这一项里面，通常使用复数形式 Whitepapers 或 White Papers。一般官网都支持下载其白皮书，有的需要填写一下个人信息。
那么，白皮书一般都长啥样呢？
一般都有一个封面，正文内容会加入直观形象的一些图表和图片，整体看起来比较高大上。
来看下 MongoDB 的白皮书吧：
还有 Databricks 的白皮书，风格差异比较明显：
Afterword
以上就是较为常见的 8 种技术文档类型，大部分类型笔者在工作中都接触过，还没写的也在计划中。
如果你正打算进入这一行，可以先提前关注下这些文档类型。Technical Writer 的工作也可以丰富多彩，也可以很有意思，并不只是每天重复处理类似的文字。
如果你也是一枚 Technical Writer，一定写过上面某种文档吧~ 期待听到你对技术文档类型的见解，欢迎留言交流哦~
References:
- https://www.tcbok.org/wiki/producing-information/products/
- https://techwhirl.com/what-is-technical-writing/
- https://cloud.google.com/spanner/docs/
- https://www.cockroachlabs.com/
- https://www.mongodb.com/
- https://databricks.com/
- https://redislabs.com/
你可能想读：
技术文档诞生记 | 完整的技术写作流程是怎样的？
Technical Writer 日常工作中好用的小工具
技术翻译需要有 Technical Writer 的 sense
深度解析关于技术翻译的六个认知误区
如何让你的内容输出更加专业更有设计感？
书单 | 有哪些技术传播从业者必知必看的书籍？
有哪些适合技术传播从业者关注的优质博客？（一）
有哪些适合技术传播从业者关注的优质博客？（二）
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议（上篇）
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议（下篇）
英语技术文档的标题到底该大写还是小写？
如何使用正则表达式批量添加和删除字符？
Markdown：写技术文档、个人博客和读书笔记都很好用的轻量级标记语言
如何为 Markdown 文件自动生成目录？
技术写作实例解析 | 简洁即是美
两分钟趣味解读 Technical Writer
若脱离理解，直译得再正确又有何意？
优质译文不应止于正确，还要 Well-Organized
写在入职技术型创业公司 PingCAP 一个月之后
揭秘 Technical Writer 的工作环境 | 加入 PingCAP 五个月的员工体验记
-END-