Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lilin90/awesome-technical-communication

😎 A curated list of awesome resources about technical communication
https://github.com/lilin90/awesome-technical-communication

List: awesome-technical-communication

communication content-marketing content-strategy developer-documentation developer-experience developer-relations devrel documentation tech-writer technical-communication technical-documentation technical-documents technical-translation technical-writers technical-writing user-documentation writing

Last synced: about 1 month ago
JSON representation

😎 A curated list of awesome resources about technical communication

Awesome Lists containing this project

README 

        

# Awesome Technical Communication [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)



A curated list of awesome resources about [technical communication](https://en.wikipedia.org/wiki/Technical_communication), including but not limited to [technical writing](https://en.wikipedia.org/wiki/Technical_writing), [technical translation](https://en.wikipedia.org/wiki/Technical_translation), [UX](https://en.wikipedia.org/wiki/User_experience) & [UI](https://en.wikipedia.org/wiki/User_interface_design), [content strategy](https://en.wikipedia.org/wiki/Content_strategy), [content marketing](https://en.wikipedia.org/wiki/Content_marketing), [DevRel (developer relations)](https://developerrelations.com/what-is-developer-relations), [developer marketing](https://developerrelations.com/what-is-b2d-or-developer-marketing), [open source](https://en.wikipedia.org/wiki/Open_source), and community.



**Table of Contents:**



+ [Resources in English](#resources-in-english)

  - [🏫 Organizations](#-organizations)

  - [📚 Books and Guides](#-books-and-guides)

  - [🌐 Blogs and Websites](#-blogs-and-websites)

  - [🎓 Courses and Training](#-courses-and-training)

  - [📻 Podcasts](#-podcasts)

  - [📰 Journals](#-journals)

+ [Resources in Chinese 中文资源](#resources-in-chinese-中文资源)

+ [Stargazers over time](#stargazers-over-time)



## Resources in English



This section lists the selected resources in English.



### 🏫 Organizations



- [Write the Docs](https://www.writethedocs.org/)

- [STC](https://www.stc.org/) (Society for Technical Communication)

  - [STC Summit 2022 session topics](https://summit.stc.org/wp-content/uploads/2022/05/SummitProgram22_Print.pdf)

- [tcworld](http://www.tcworld.info/)

  - [tcworld China](https://www.tcworld-china.cn/en/)

  - [tcworld India](https://tcworld-india.com/)

- [tekom Europe](https://www.technical-communication.org/)

- [ACM SIGDOC](http://sigdoc.acm.org/) ([ACM](https://www.acm.org/)'s Special Interest Group on Design of Communication)

- [Content Wrangler](http://www.thecontentwrangler.com/)

- [IEEE PCS](https://procomm.ieee.org/) (IEEE Professional Communication Society)



### 📚 Books and Guides



+ IBM or IBM Press

  - [The IBM Style Guide](https://www.amazon.com/IBM-Style-Guide-Conventions-Writers-ebook/dp/B005Z09FOC)

  - [Developing Quality Technical Information](https://www.amazon.com/Developing-Quality-Technical-Information-Handbook/dp/0133118975)

  - [DITA Best Practices](https://www.amazon.com/DITA-Best-Practices-Roadmap-Architecting/dp/0132480522)

  + [IBM Design](https://www.ibm.com/design/)

    - [Design Philosophy](https://www.ibm.com/design/approach/design-philosophy/)

    - [Enterprise Design Thinking](https://www.ibm.com/design/thinking) (activities and courses)

  - [IBM Design Language](https://www.ibm.com/design/language/)

  - [IBM Carbon Design System Content Guidelines](https://www.carbondesignsystem.com/)

+ Google

  - [Google Developer Documentation Style Guide](https://developers.google.com/style/) ([cn](https://developers.google.cn/style/))

  - [Google Material Design Writing Guidelines](https://material.io/design/communication/writing.html#principles)

  - [Material's Communication Principles: Intro to UX Writing](https://codelabs.developers.google.com/codelabs/material-communication-guidance#0) (Google Developers Codelabs)

+ Microsoft

  - [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/)

  + [Microsoft Localization Style Guides](https://www.microsoft.com/en-us/language/styleguides) for Different Languages

    - [Microsoft Chinese (Simplified) Style Guide](http://download.microsoft.com/download/4/c/a/4ca95933-3496-4793-9d77-a89b60a8312c/zho-chn-styleguide.pdf)

  - [Microsoft Manual of Style for Technical Publications](https://www.amazon.com/Microsoft-Manual-Style-Technical-Publications/dp/0735617465)

  - [Windows Admin Center UI text and design style guide](https://learn.microsoft.com/en-us/windows-server/manage/windows-admin-center/extend/guides/ui-text-style-guide)

  - [Azure docs Markdown templates](https://github.com/MicrosoftDocs/azure-docs/tree/main/markdown%20templates/aml-templates)

+ Apple

  - [Apple Style Guide](https://help.apple.com/applestyleguide/)

  - [Human Interface Guidelines | Apple Developer Documentation](https://developer.apple.com/design/human-interface-guidelines)

- [Red Hat supplementary style guide for product documentation](https://redhat-documentation.github.io/supplementary-style-guide/)

- [GitLab Documentation Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide/)

- [Mailchimp Content Style Guide](https://styleguide.mailchimp.com/)

- [MongoDB Documentation Style Guide](https://www.mongodb.com/docs/meta/style-guide/)

- [The Chicago Manual of Style](https://www.amazon.com/Chicago-Manual-Style-16th/dp/0226104206) ([Online](https://www.chicagomanualofstyle.org/home.html))

- [ASD Simplified Technical English (ASD-STE100)](http://www.asd-ste100.org/request.html)

- [Docs Like Code](https://www.docslikecode.com/book/)

  - [About Docs Like Code](https://www.docslikecode.com/about/)

  - [Docs Like Code Articles](https://www.docslikecode.com/articles/)

- [The Handbook of Technical Writing](https://www.amazon.com/Handbook-Technical-Writing-Gerald-Alred-dp-1319058523/dp/1319058523/)

- [Technical Communication: A reader-centered approach](https://www.amazon.com/Technical-Communication-reader-centered-approach-8th/dp/113330981X/)

- [Living Documentation: Continuous Knowledge Sharing by Design](https://www.amazon.com/Living-Documentation-Cyrille-Martraire/dp/0134689321)

- [Technical Translation: Usability Strategies for Translating Technical Documentation](https://www.amazon.com/Technical-Translation-Strategies-Translating-Documentation-ebook-dp-B000UJBJLA/dp/B000UJBJLA/)

- [DITA for Print: A DITA Open Toolkit Workbook](https://www.amazon.com/DITA-Print-Toolkit-Workbook-Second/dp/1937434540)

- [Design Thinking in Technical Communication: Solving Problems through Making and Collaboration](https://www.amazon.com/Design-Thinking-Technical-Communication-Collaboration/dp/0367478218)

- [Style: Lessons in Clarity and Grace](https://www.amazon.com/Style-Lessons-Clarity-Grace-12th/dp/0134080416/)

- [The Elements of Style: Classic Edition (2018)](https://www.amazon.com/Elements-Style-Classic-Editors-Chapters/dp/1643990004)

- [Oxford Guide to Plain English](https://www.amazon.com/Oxford-Guide-Plain-English-Martin/dp/0198844611/)

- [The Product is Docs: Writing Technical Documentation in a Product Development Group](https://www.amazon.com/Product-Docs-technical-documentation-development/dp/B085KK6G8F)

- [Docs for Developers: An Engineer’s Field Guide to Technical Writing](https://www.amazon.com/Docs-Developers-Engineers-Technical-Writing/dp/1484272161)

- [API Stylebook: API Design Guidelines of some companies and government agencies](http://apistylebook.com/design/guidelines/)

- [Software Technical Writing: A Guidebook](https://jamesg.blog/book.pdf) ([epub](https://jamesg.blog/book.epub), [discussions on Hacker News](https://news.ycombinator.com/item?id=38865416))

- [Microcopy: The Complete Guide](https://www.microcopybook.com/)

- [Laws of UX](https://lawsofux.com/)

  - Book: [Laws of UX: Using Psychology to Design Better Products & Services](https://www.amazon.com/Laws-UX-Principles-Persuasive-Products/dp/149205531X)

- [Strategic Writing for UX: Drive Engagement, Conversion, and Retention with Every Word](https://www.goodreads.com/book/show/44144500-strategic-writing-for-ux)

- [The User's Journey: Storymapping Products That People Love](https://www.amazon.com/Users-Journey-Storymapping-Products-People/dp/1933820314)

- [User Story Mapping: Discover the Whole Story, Build the Right Product](https://www.amazon.com/User-Story-Mapping-Discover-Product/dp/1491904909)

- [Change by Design: How Design Thinking Transforms Organizations and Inspires Innovation](https://www.goodreads.com/book/show/6671664-change-by-design)

- GOV.UK [Service Manual](https://www.gov.uk/service-manual) and [Content Design](https://www.gov.uk/guidance/content-design)

- DevRel

  - [Ask Your Developer: How to Harness the Power of Software Developers and Win in the 21st Century](https://www.amazon.com/Ask-Your-Developer-Software-Developers/dp/0063018292/)

- Open source

  - [The Cathedral & the Bazaar: Musings on Linux and Open Source by an Accidental Revolutionary](https://www.amazon.com/Cathedral-Bazaar-Musings-Accidental-Revolutionary/dp/0596001088/)

  - [Hackers & Painters: Big Ideas from the Computer Age](https://www.amazon.com/Hackers-Painters-Big-Ideas-Computer/dp/1449389554)

- Community

  - [The Art of Community: Building the New Age of Participation](https://www.amazon.com/Art-Community-Building-New-Participation/dp/1449312063/)

  - [People Powered: How Communities Can Supercharge Your Business, Brand, and Teams](https://www.amazon.com/People-Powered-Communities-Supercharge-Business/dp/1400214882/)

  - [Superfans: The Easy Way to Stand Out, Grow Your Tribe, and Build a Successful Business](https://www.amazon.com/Superfans-Stand-Tribe-Successful-Business/dp/1949709469) ([Companion Course](https://courses.smartpassiveincome.com/p/superfans-companion))



### 🌐 Blogs and Websites



- [I'd Rather Be Writing](http://idratherbewriting.com/)

- [Content Wrangler](http://www.thecontentwrangler.com/)

- [DeveloperRelations.com](https://developerrelations.com/)

- [TechWhirl](https://techwhirl.com/)

- [ClickHelp Technical Writing Blog](https://clickhelp.com/clickhelp-technical-writing-blog/)

- [Scriptorium Blog](https://www.scriptorium.com/blog/)

- [James' Blog](https://jamesg.blog/)

- [ffeathers](https://ffeathers.wordpress.com/)

- [indoition Technical Documentation Tool and Web Guide](https://www.indoition.com/tools-websites-technical-documentation.htm)



### 🎓 Courses and Training



- [Google Technical Writing Courses for Engineers](https://developers.google.com/tech-writing)

- [GitLab Technical Writing Fundamentals Course](https://about.gitlab.com/handbook/engineering/ux/technical-writing/fundamentals/)

- [Certified Professional Technical Communicator (CPTC™)](https://apmg-international.com/product/cptc): a certification scheme developed by APMG [on behalf of the Society for Technical Communication](https://www.stc.org/certification/foundation-certification/) (STC)

- [tcworld TCTrainNet Training Program with Certification](https://www.technical-writing-training-and-certification.com/)

- [API Documentation Course](https://idratherbewriting.com/learnapidoc/) | I'd Rather Be Writing: a guide for technical writers and engineers

- [Technical Writer HQ](https://technicalwriterhq.com/technical-writing-certification-courses/)

- [Technical Writing Essentials](https://alison.com/course/technical-writing-essentials) (Alison Course)



### 📻 Podcasts



+ Tech Comm



  - [Write the Docs Podcast](https://podcast.writethedocs.org/)

  - [Writers of Silicon Valley](https://www.writersofsiliconvalley.com/)

  - [The Content Strategy Podcast](https://www.contentstrategy.com/podcast)

  - [I'd Rather Be Writing Podcast](https://idratherbewriting.com/category-podcasts/)

  - [The Cherryleaf Podcast](https://www.cherryleaf.com/podcast/)

  - [The Content Strategy Experts Podcast](https://www.scriptorium.com/content-strategy-experts-podcast/)

  - [Wireframe (Adobe)](https://podcasts.apple.com/us/podcast/wireframe/id1437677219)

  - [The Not-Boring Tech Writer Podcast](https://www.thenotboringtechwriter.com/)

  - [10-Minute Tech Comm](https://www.stitcher.com/podcast/uah-technical-writing/10minute-tech-comm)

  - [Content Content Podcast](http://edmarsh.com/content-content-podcast/)

  - [Instrktiv's Insane Instructions Show](https://open.spotify.com/show/0OqluDn7YSjc1cdAULPOB8)

  - [Knowledgebase Ninjas](https://document360.io/blog/category/knowledgebase-ninjas/)

  - [The Manuscript](https://podcasts.apple.com/podcast/the-manuscript/id1501843799)

  - [Grammar Girl](https://www.quickanddirtytips.com/grammar-girl)



+ Tech

  - [Software Engineering Daily](https://softwareengineeringdaily.com/category/all-episodes/exclusive-content/Podcast/)



    The World Through the Lens of Software



  - [Kubernetes Podcast from Google](https://kubernetespodcast.com/)



    A weekly news and interview show with insight from the Kubernetes community



  - [The a16z Podcast](https://a16z.com/a16z-podcast/) ([simplecast](https://a16z.simplecast.com/))



    Tech and culture trends, news, and the future – especially as "software eats the world"



### 📰 Journals



+ [Technical Communication](https://www.stc.org/techcomm/) (Journal of the Society for Technical Communication)

  - [Who Are China’s Technical Communicators? A Survey on the State of Diversity, Equity,

and Inclusion of the Profession](https://doi.org/10.55177/tc583549) ([PDF](/resources/Dong&Gao-TechComm%20Journal-2023%20with%20covers.pdf))

- [ACM Communication Design Quarterly Review](https://dl.acm.org/newsletter/sigdoc-cdqr)

- [Technical Communication Quarterly](https://www.tandfonline.com/loi/htcq20)



## Resources in Chinese 中文资源



+ 社区或个人资源

  + 技术传播那些事儿 (by [李琳 Lilian Lee · lilin90](https://github.com/lilin90))

    - [微信公众号](https://res.cloudinary.com/lilian-photos/image/upload/v1585391408/cover/wechat-qrcode-scan-to-follow.jpg) (ID: tc_fun)

    - [知乎专栏](https://zhuanlan.zhihu.com/tc-fun)

  + 技术传播李琳：微信公众号 (ID: TC-Lilin) by 李琳 Emma

  + TC 互联技术传播与技术写作社区

    - [官网](http://www.tc-china.org/)

    - 微信公众号：infomagic技术传播与技术写作 (ID: infomagic123)

  + tcworld 中国技术传播大会

    - 大会官网：[中文版](https://www.tcworld-china.cn/)，[英文版](https://www.tcworld-china.cn/en/)

    - 微信公众号：tcworld技术传播大会 (ID: tcworld-china)

  + 中国技术传播：微信公众号 (ID: CTCA_CHINA)

  + [技术传播沙龙](https://techcommsalon.com/index.html)

    - 讨论前沿技术，分享行业动态

    - 形式：线上线下结合

  + 北京大学技术传播协会：微信公众号 (ID: pkutca)

  + 科多思技术传播社区：微信公众号 (ID: kudoschina)

  + [技术文档写作·知乎专栏](https://www.zhihu.com/column/c_168580756) by Joy 思烤

  + [zh.md](https://zh.md/) (by [WPH95](https://github.com/WPH95) & [yikeke](https://github.com/yikeke))

    - [中文技术文档写作风格指南](https://zh-style-guide.readthedocs.io/zh_CN/latest/)（[GitHub 仓库](https://github.com/yikeke/zh-style-guide/blob/master/README.md)）

    - [zhLint 中文技术文档检查工具](https://github.com/tidb-incubator/zh.md)

  + [GitHub 新手指南：极简教程教你如何给开源仓库提 PR](https://www.bilibili.com/video/BV1h5411E7pM) (by [ran-huang](https://github.com/ran-huang) & [CharLotteiu](https://github.com/CharLotteiu))

    - [Git 与 GitHub 基础概念](https://www.bilibili.com/video/BV1h5411E7pM?p=1)

    - [如何创建一个 Pull Request (PR)](https://www.bilibili.com/video/BV1h5411E7pM?p=2)

    - [跟进 PR 的后续操作](https://www.bilibili.com/video/BV1h5411E7pM?p=3)

    - [批量接受 review 建议和处理 CI 检查](https://www.bilibili.com/video/BV1h5411E7pM?p=4)

+ 书籍

  - [《活文档：与代码共同演进》](https://book.douban.com/subject/35372829/)（译自英文版）

  - [《英语技术写作精要》](https://book.douban.com/subject/35286166/)（复旦大学出版社，但正文语言为英文）

  - [《科技文档写作实务》](https://book.douban.com/subject/25784432/)（人民邮电出版社）

+ 课程

  - [重庆邮电大学《英语技术写作》慕课](https://www.xueyinonline.com/detail/227533004)

+ 开课高校

  - [开设技术传播或技术写作课程的中国高校](https://github.com/galty687/tc-universities)



## Stargazers over time



[![Stargazers over time](https://starchart.cc/lilin90/awesome-technical-communication.svg)](https://starchart.cc/lilin90/awesome-technical-communication)