专业的作者，至少在红帽文档团队中，几乎总是独自编写文档。 但是您尝试过作为团队的一部分进行写作吗？ 在本文中，我将解释结对写作的一些好处。
什么是结对写作？
结对写作是指两位作者在同一房间内，实时处理同一份文稿。 这种方法可以提高文档质量，加快写作速度，并使作者之间相互学习。 结对写作的想法借鉴自结对编程。
在结对写作时，您和您的同事一起处理文稿，根据需要提出建议和问题。 同时，您在观察彼此的工作。 例如，当一个人写作时，另一位作者观察诸如结构或上下文之类的细节。 通常，围绕文档的讨论会变成分享经验和观点，以及对一般写作进行头脑风暴。
在任何时候，写作都只由一个人完成。 因此，您只需要一台计算机，除非您希望一位作者进行在线研究，而另一位作者进行写作。 文本工作流程与您独自工作时相同：文本编辑器、文档源文件、git 等。
结对写作的实践
我的同事 Aneta Steflova 和我花了 50 多个小时进行结对写作，处理红帽企业 Linux 系统管理文档和红帽身份管理文档。 我发现，与单独写作相比，结对写作
- 生产力相当甚至更高；
- 提高文档质量；
- 帮助作者分享技术专长；并且
- 更有趣。
速度
两位作者写一篇文稿？ 听起来生产力只有一半，对吗？ 错了。 （通常。）
结对写作可以帮助您更快地工作，因为两个人可以解决更多的问题，这意味着在此过程中受阻的可能性更小。 例如，有一次我们为身份管理编写了紧急 API 文档。 我至少了解 Web API、REST 协议等的基础知识，这帮助我们快速完成文档的这些部分。 如果单独工作，Aneta 将需要经常中断写作过程来学习这些主题。
质量
措辞或句子结构不佳、材料不一致等等，在四只眼睛的审视下更难幸存。 例如，我们的一份结对写作文档由一位极其挑剔的开发人员审阅，他以发现技术错误和不良结构而闻名。 在这次特别审查之后，他说：“完美。 非常感谢。”
分享专业知识
我们每个人都生活在自己的写作泡沫中，而且我们通常不知道其他人如何进行写作。 结对写作可以帮助您改进自己的写作过程。 例如，Aneta 向我展示了如何更好地处理开发人员提供了起始文本的任务（而不是作者使用自己对该主题的知识从头开始写作），而我没有这方面的经验。 此外，她对文档进行了彻底的结构化，我也开始这样做。
再举一个例子，我非常擅长 Vim，以至于 XML 编辑（例如，标签操作）是令人愉快的而不是痛苦的。 Aneta 看到我是如何使用 Vim 的，询问了它，经历了学习曲线，现在利用 Vim 的功能来帮助我。
结对写作特别适合帮助和指导新作者，并且是专业地（以及与同事一起享受乐趣）了解彼此的好方法。
结对写作的闪光点
除了我已经列出的好处之外，结对写作尤其适用于
- 使用 Bugzilla：Bugzilla 可能很麻烦并且会引起问题，特别是对于不擅长管理的人（像我一样）。
- 审查现有文档：当文档需要扩展或修复时，首先需要检查现有文档。
- 学习新技术：一位作家同事可能比工程师更是一位好老师。
- 向开发人员发送电子邮件/信息请求，其中包含精心选择的问题：此任务的难度与您正在记录的技术的难度成正比。
此外，通过结对写作，反馈是实时的、按需的和双向的。
不利的一面是，结对写作的节奏可能会更快，从而使作者花更少的时间来思考主题或措辞。 另一方面，通常在结对写作后不需要同行评审。
注意事项
为了充分利用结对写作
- 做好充分准备再开始项目，否则您可能会浪费同事的时间。
- 健谈的人需要专注于任务，否则他们最终会变成聊天而不是写作。
- 准备好接受直接反馈。 结对写作不适合对反馈过敏的作者。
- 谨防会话劫持者。 强势的个性可能会将结对写作变成单人写作，旁边有观众。 （但是，如果一个人有时接管，可以是好的，只要经验较少的合作伙伴从劫持者那里学习，或者经验更丰富的作者向劫持者提供反馈。）
结论
结对写作是一次会议，但您实际上可以在其中完成工作。 这项活动使作者可以专注于我们职业中不可或缺的一件事——写作。
这篇文章是在与 Aneta Steflova 结对写作的帮助下完成的。
1 条评论