~/alternatives / technical-writer
any2.video 与招聘技术文档工程师对比：同一个覆盖率问题的两种答案
一位好的技术文档工程师，是软件公司投入产出比最高的招聘之一，这里没有任何反对招聘的意思。书面文档和经验证的视频，回答的是覆盖率问题的不同两半；在两者之间做选择，实际上是在问：眼下出问题的是哪一半。
每种方案能证明什么
| 问题 | 技术文档工程师 | any2.video |
|---|---|---|
| 产出什么 | 可搜索、可链接、可修正的文字。 | 任务完成过程的录像，外加一份图文指南。 |
| 回答“按钮在哪里” | 用文字回答，读者得自己把文字对应到屏幕上。 | 直接展示出来。 |
| 回答“为什么会有这个” | 非常好。这正是文字的用武之地。 | 很差。视频不擅长做参考资料。 |
| 覆盖速度 | 写文字很快，凡是需要截屏的内容都很慢。 | 每个任务两天，分批进行。 |
| 在哪里能被找到 | 您的文档站点，以及搜索引擎。 | YouTube 和 AI 助手，也就是人们提出产品问题的地方。 |
| 保持最新 | 取决于团队纪律和审核流程。 | 版本标签，加上每次发版触发的重跑。 |
什么时候该选技术文档工程师
- 您的文档不完整、自相矛盾，或者没人用心维护。先解决这个问题。在糟糕的文档之上做视频，只会让错误传播得更广。
- 内容属于参考资料：参数、API 接口、限制、概念说明。
- 读者需要搜索、复制和链接。没有人会从视频里复制命令。
- 您需要让内容成为发版流程的一部分，而不是游离在流程之外。
什么时候不该选
- 文字步骤已经写好，用户却还是会做错，这通常说明屏幕上的样子和文字描述对不上。
- 问题是“它到底能不能用”，这一点文字解决不了，屏幕上的证据可以。
- 您的买家正在 YouTube 上形成看法，而您的文档不会出现在那里。
- 您招来的技术文档工程师整周都在截图，而不是在写作。
先后顺序
先做文档。如果书面的操作流程是错的，把这个错误流程拍成视频，只会得到一个更有说服力的错误流程。我们曾因此拒绝过项目，以后也还会这样做。
文档一旦正确，缺的就不再是信息，而是证明和辨认。一个读过步骤却仍然找不到那个开关的用户，不需要再读一遍那句话。他们需要看到屏幕。
每个实操演示都附带文字
这就是为什么图文指南和排障记录包含在内，而不是作为增购项另外出售。每次经验证的运行都会按顺序产出实际奏效的确切步骤，以及失败的尝试和对应的解决方法。这份产出往往比文档里原有的内容更好，因为它来自一次运行，而不是凭记忆写成，您的技术文档工程师可以直接把它搬进文档。
文档撰写人能得到什么
截屏是技术文档工程师所做的工作中价值最低的一项，却占掉了他们整周的时间。一次经验证的运行会交给他们一份带时间戳的日志，记录实际发生了什么，而这正是他们原本要靠手工重建的原始素材。
常见问题
我们应该招技术文档工程师，还是买视频？
如果文档有错或者缺失，先招技术文档工程师。建立在不准确文档之上的视频，会让错误成倍放大。如果文档扎实，用户却仍然卡住，那么缺的是证明而不是信息，而这正是经验证的实操演示所提供的。
视频会取代我们的文档吗？
不会，也不应该取代。文字可搜索、可复制，修正成本低。视频不擅长做参考资料，擅长展示任务完成。
我们会得到技术文档工程师能用的东西吗？
会。每个实操演示都附带实际奏效的确切步骤和失败的尝试，均根据运行日志生成。大多数团队会直接把它粘贴进自己的文档。