想象一下，一个房间里充满了聪明、有趣和古怪的人，他们都热爱文档、技术……和美食。将所有这些结合在一起，你就得到了 Write the Docs (WTD) 波特兰大会——一个文档编写者聚在一起讨论我们最热爱的事物的社区会议。
Read the Docs 的直接后裔
WTD 是 Read the Docs 的直接后裔，这是一个托管开源软件文档的网站。由于它起源于开源运动，WTD 向各种关心文档和清晰沟通的职位开放。今年，我们有质量保证人员、图书管理员、软件开发人员，当然还有技术作家和编辑，以及一些用户体验 (UX) 人员。
去年是我第一次参加会议，感觉就像走进了一个满是我最亲密朋友的房间。在某个地方如此迅速地感到舒适真令人震惊。这种舒适感很大程度上归功于会议的吃豆人规则：如果你站在一群人中，总是在你的圈子里留出空间，让另一个人加入进来。像吃豆人一样站着，准备好邀请新朋友加入并受到欢迎。
“始终为新朋友留出空间。”
WTD Portland 2017 大会发生了什么
像编写代码一样编写文档
2017 年会议的热门短语是像编写代码一样编写文档。这实际上意味着什么？它是多种事物的组合——部分意味着使用 Git 存储库或类似的代码管理系统来处理和格式化你的原始文本；这也意味着，在理想的世界中，如果你像编写代码一样编写文档，那么文档和代码存在于相同的存储库中。开发人员和专业作家都可以轻松改进和贡献文档，从而消除两个世界之间的障碍。
正如 Jodie Putrino 在她的演讲 像对待代码一样对待文档：一个实践帐户 中所说：“我们现在都是文档编写者了。”
改进技术文档编写的 3 个技巧
在 WTD Portland 2017 大会上，我们也听到了很多关于如何改进文档的建议。以下是三个重要技巧
- 使用技术写作技巧，如极简主义和任务分析，使你的文档更清晰更好。
- 加强你与支持人员的关系，以改进你的文档和他们的生活。
- 了解你的读者并为他们写作。
在最后一点中，Amelia Abreu 的 关怀系统：作为关怀的文档，触及了我最喜欢的两个主题：人种学用户访谈和可用性测试。作为一名人类学家和经验丰富的用户体验 (UX) 顾问，我强烈推荐这两种技术！
4 个推荐的演讲
查看 YouTube 上的 Write the Docs 2017 频道上的所有精彩演讲。我最喜欢的几个是
- 错误消息：保持谦逊、人性化和乐于助人，作者 Kate Voss。她解释了如何定制你的错误消息，使其周到且真正有用。
- 甚至命名这个演讲也很难，作者 Ruthie BenDor。她举例说明了她在工程师职业生涯中遇到的一些糟糕、可怕、不好、非常糟糕的名称，并讨论了我们如何改进命名。
- 从任务开始，而不是从端点开始，作者 Sarah Hersh。她提出了一个案例研究，介绍了通过采访客户和进行调查来创建面向任务的 API 文档的过程，并最终迭代了文档设计。
- 众人拾柴火焰高：开放组织中众包极简主义，作者是我。我在 Red Hat 的部门正在众包写作评论，以此来推广新的文档编写方法。我的演讲描述了我们的方法，并解释了众包和极简主义。
为出色的志愿者鼓掌
今年我做了演讲，并且不得不处理技术难题，然而 WTD 志愿者们齐心协力使我的演讲得以进行的方式是惊人的。他们牺牲了自己来使我的演讲成为可能。Nik Blanchet，会议主持人，在我演讲的大部分时间里都跪着像柔术演员一样弯腰为我翻页。多么令人惊叹的一群人！
评论已关闭。