春节前查资料时候,我的浏览器又慢成树懒了。打开收藏夹一看, 果然不出所料,我随手收藏的网页又变成一堆一堆的了。
为什么是“又”? 在改用 Microsoft Edge 之前,我已经用废了一个搜狗浏览器了。
收藏夹塞得满满当当,但启动特别慢。删不得又用不了,所以它至今还在我的电脑桌面上玩葛优躺呢!总不能再装一个浏览器吧?
如果把这些资料的名称、网址以链接的形式收集起来,再分门别类地整理到文件里,每次需要用时只要点链接就好了,岂不是比收藏夹还方便? 要想跨设备同步,只要把文件做成在线文档就行,比如有道云笔记、腾讯文档。
原本我打算在有道云笔记里整理这些资料。可整理到一半的时候,我转念一想:“既然花了这么多时间,为什么不把它们分享出来呢? 可能有人正在查找这些资料呢!如果有人喜欢,还可以一起维护。”
于是,我先调查了一下 GitHub 上技术写作类资源库的大致情况,发现我收藏的资源和分类整理的思路与现有的资源库都不一样。然后,我就创建了一个自己的 GitHub 存储库,还制作了一个小网站。
技术写作类 GitHub 资源库概况
目前,GitHub 上共有 311 个公开存储库标记了 “technical-writing”(话题标签)。按星数 (Star) 排名前十位的存储库中,有 4 个资源(收集)库。
排名第一位的《文档汇编》 (The Documentation Compendium) 以收集代码库中常用的各类文档模板为主,比如 readme 模板、拉取请求模板 (pull requests) 和问题模板 (issues) 等。
其余 3 个都是以收集学习资料为主,但收集的资料种类和对资料的分类方式略有差别。
两个 Awesome 系列的资源库按照资源的类型或媒介形式分类,比如课程、书籍、视频、音频(播客)等。《神奇的技术写作》 (Awesome Technical Writing) 创建时间最早、星数最多。《神奇的技术传播》 (Awesome Technical Communication) 专门为中文资源设置了一个大类。
《技术写作资源》 (Technical Writing Resources) 按照资源的用途分类,比如技术写作入门、文档类型(即编写API 文档、入门教程、博客文章等不同类型文章的资源子类)、软件工具等。《技术写作资源》创建时间较晚,但星数增长较快,极具流行潜力。
我的 GitHub 资源库
从 GitHub 上现有的技术写作资源库可以看出,每个资源库都琳琅满目。虽然各个库之间难免有些资源是雷同的,但仍然各具特色。
由于技术写作这个话题有些冷门,各个库中参与贡献的人都不多,主要靠创建者自己维护。因此,资源库的特色主要源自创建者的专业领域、成长路径和个人偏好。
作为一个在工业制造领域有多年工作经验的技术文档工程师,我创建的资源库里除了入门课程和各类技术写作指南等常规资源,还搜罗了工业产品技术文档中必不可少的技术插图、大中型技术文档常用的架构标准 (DITA 和 S1000D) 以及批量处理等方面的资源。
在对资源进行分类时,我主要考虑两个因素:用途和难度。无论是大类还是子类,都按照由浅入深、先易后难的原则排序。每个类别、每项资源都配有通俗易懂、言简意赅的简介,即使零基础的读者也能在点开链接前对资源有个大致的了解。
差点忘了最重要的一点,所有资源都是免费的,除了极个别特别经典的书籍(比如 IBM 出版的那几本骨灰级教科书)和商用软件(市场上压根儿没有免费版的)。
GitHub 存储库:Awesome Technical Writing Learning
网站:Awesome Technical Writing Learning
贡献指南
如今,技术写作涉及的领域越来越广,新的知识、新的资源每天都在产生。
我现在创建的资源库,只是一个起点,以后会不断上新。
如果你有优质资源,不管是你的原创、你的私藏还是你的发现,欢迎来和我一起分享。
资源库《神奇的技术写作研习路》(Awesome Technical Writing Learning) 会和公众号@技术传播百态说一起,让更多人看见你的作品、你的专业积累和你的分享精神。
如果你对资源库的分类、管理和筛选标准等方面有任何想法,可以在讨论区 (Disccussions) 发贴讨论。
你还可以将讨论区作为一个咨询求助中心。如果遇到任何与技术写作相关的问题或困难,来发个贴试一下,说不定会碰上哪个路过的大神帮忙指点迷津呢!
新库开张,急需背书。如果你也喜欢这个资源库,顺便去 GitHub 点个星呗!