Write the Docs:连接技术文档人的全球社区,附海量学习资源

Write the Docs Prague 2019

Foreword

知道 Write the Docs 这个活跃的技术文档社区,还得感谢我的同事 Calvin 的推荐。Calvin 是一位有多年技术文档写作经验的 Technical Writer,还是一位专业跑者。他平时酷爱跑步,经常去北京奥林匹克森林公园跑个十几公里,周末甚至二十几公里,很是佩服。

这不,就在 11 月 3 日,Calvin 再一次参加了 2019 北京全程马拉松,还一不小心刷新了个人最好记录。用他的话来说,就是 PB 了。Calvin 第一时间跟我们部门的小伙伴分享好消息。然而,对于我们这些圈外人来讲,大家一脸懵,PB 是啥?解释之后,得知 PB 原来是 Personal Best 的缩写。

其实嘛,这个事情完全可以用技术写作领域的知识来解释:考虑受众,以及专业术语第一次出现时要写明全称 😃

言归正传,本文结构如下:

  1. Write the Docs 是什么
  2. Write the Docs 对你有哪些帮助
    • 丰富的社区学习资源
    • 及时专业的社区解答
  3. 如何加入 Write the Docs

Write the Docs 是什么

Write the Docs 是一个由关心文档的人群组成的全球社区,专注于软件文档。在该社区里,有时会将 Write the Docs 缩写为 WTD。

每年的 Write the Docs 大会将所有写文档的人聚集在一起,互相交流学习。平时也会在 40 多个城市举办 Meetup。参与者包括程序员、Tech Writer、支持人员、设计师等等。

Write the Docs 官网:http://www.writethedocs.org/

2019 年 9 月 15 日 ~ 17 日,Write the Docs 大会在捷克布拉格举行。附上两张大会图片,大家感受一下:

Docs or it didn't happen!

蛮赞同这句话。很多时候,开发了一个新 feature,就需要写文档,无论是影响用户的操作类文档,还是解释技术实现的参考或博客类文档。要让他人知道,让用户能用,才算真正 happen 了。

Write the Docs Prague 2019

Write the Docs 对你有哪些帮助

自了解 Write the Docs 以来,我有两点很直观的感受:一是这个社区的资源好丰富;二是这个社区好活跃。接下来具体聊一聊 Write the Docs 对我们有什么帮助,如何通过这个社区的资源来提升自己。

1. 丰富的社区学习资源

1)大会视频资源

  • 方式一:在 Write the Docs 官网上观看。

    Write the Docs 官网收录了自 2015 年起历年大会上的演讲视频,并附有对演讲的内容简介以及演讲者的个人信息。地址:http://www.writethedocs.org/videos/

    以 2019 年 9 月份在布拉格的大会为例:


    write-the-docs-2019-video-2.png

其中,很喜欢这个演讲的标题,感觉取得很巧妙:101 to 404s: How to write great error messages

  • 方式二:在 YouTube 上观看。

    Write the Docs 官网上的播放源也是 YouTube。如果你习惯使用 YouTube,可以直接订阅 Write the Docs 的 YouTube 官方 channel,可方便地观看并查看更新。

C​hannel 主页:​

2)Podcast 资源

Write the Docs 的 Podcast 收录了社区成员分享各种活动中的一些讨论和故事。地址:https://podcast.writethedocs.org/

2. 及时专业的社区解答

Write the Docs 的官方 Slack channel 里聚集了来自世界各地关心文档的人。如果在日常工作或学习中遇到技术文档写作相关的问题,可以去里面提问,经常会很快有人回复,有一种与业内专业人士实时聊天探讨的感觉。

很多工作的小伙伴可能已熟悉 Slack,它是一个即时消息传递平台,整合了聊天群组、各种工具、统一搜索等。PC 端和移动端均可下载,有需要的小伙伴可以了解一下。

如何加入 Write the Docs

Write the Docs 官网首页即提供了加入 Slack 的入口,也可以订阅社区的 Monthly Newsletter 等。感兴趣的小伙伴可以去试一下~

如果你想去现场参加 Write the Docs 年度大会,可以关注 Conferences 页面的大会信息。

如果无法去现场也没关系,大会一般都有现场直播,关注下相应大会的网页信息即可。最近的大会是 11 月 14 日 ~ 15 日在澳大利亚悉尼的这个,可以关注下。

Afterword

Write the Docs 官网还有个 Job Board 专门发布 Tech Writer 类的招聘信息,以海外为主,也有支持 Remote 的职位。

此外,官网 Slack space 里也有一个专门发布全球业内招聘信息的 channel,会经常发布招聘信息,也主要是海外的。这些对于留在海外的小伙伴更有价值,国内找工作的同学大概只能关注下其中的 Remote 职位了。

我最近在看 Write the Docs Prague 2019 大会的视频,对有些分享很感兴趣,大概因为那是我在工作中也遇到过或思考过的问题。看看全球的同行们正在关注什么,正在解决什么问题,与他们进行一些探讨,有利于避免自己孤身探索的迷茫与困惑。

附:Write the Docs Prague 2019 大会图片合集

-END-

猜你想读

什么样的人适合做 Technical Writer?
技术文档诞生记 | 完整的技术写作流程是怎样的?
Technical Writer 可提供的交付物有哪些?
GitHub + Markdown 的新轻型技术写作模式速览
GitHub + Markdown 的技术文档方案深度解析
Technical Writer 日常工作中好用的小工具
技术传播人士应该知道的色彩搭配常识
如何使用颜色来提高技术文档的可读性?
Technical Writer 如何 Review 技术文档?| 重细节+全局观
技术翻译需要有 Technical Writer 的 sense
深度解析关于技术翻译的六个认知误区
如何让你的内容输出更加专业更有设计感?
书单 | 有哪些技术传播从业者必知必看的书籍?
有哪些适合技术传播从业者关注的优质博客?(一)
有哪些适合技术传播从业者关注的优质博客?(二)
行业动态 | 国内有哪些高校开设了技术传播或技术写作课程?
IEEE ProComm 2019 国际传播大会上,中国代表团有哪些精彩分享?
优质免费资源推荐 | 9 期技术写作短视频教程带你从入门到进阶
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(上篇)
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(下篇)
Technical Writer 想参与开源项目为文档做贡献,需提前掌握哪些知识?
Technical Writer 如何参与开源项目的文档,以不断提升专业技能?
技术传播沙龙精彩分享 | 高校老师与行业大牛谈“互联网技术写作”
经验分享 | 对用户文档进行伤筋动骨式的重构是怎样一种体验?
英语技术文档的标题到底该大写还是小写?
不同阶段如何应对 Technical Writer 的职业顾虑或烦恼?
如何使用正则表达式批量添加和删除字符?
英语技术文档中如何正确使用时态?
英语技术文档中如何正确使用人称?
英语技术文档中如何正确使用无序列表和有序列表?
Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级标记语言
如何为 Markdown 文件自动生成目录?
技术写作实例解析 | 简洁即是美
两分钟趣味解读 Technical Writer
若脱离理解,直译得再正确又有何意?
优质译文不应止于正确,还要 Well-Organized
Technical Writer 需要 Technical 到会写代码吗?
如何利用 GitHub Pages 和 Hugo 轻松搭建个人博客?
写在入职技术型创业公司 PingCAP 一个月之后
揭秘 Technical Writer 的工作环境 | 加入 PingCAP 五个月的员工体验记

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,454评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,553评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,921评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,648评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,770评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,950评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,090评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,817评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,275评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,592评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,724评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,409评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,052评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,815评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,043评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,503评论 2 361
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,627评论 2 350

推荐阅读更多精彩内容