Awesome Technical Communication

A curated list of awesome resources about technical communication, including but not limited to technical writing, technical translation, UX & UI, content strategy, content marketing, DevRel (developer relations), developer marketing, open source, and community.

Table of Contents:

• Resources in English
  • 🏫 Organizations
  • 📚 Books and Guides
  • 🌐 Blogs and Websites
  • 🎓 Courses and Training
  • 📻 Podcasts
  • 📰 Journals
• Resources in Chinese 中文资源
• Stargazers over time

Resources in English

This section lists the selected resources in English.

🏫 Organizations

• Write the Docs
  • Write the Docs · YouTube channel: conference videos

• STC (Society for Technical Communication)
  • STC Summit 2022 session topics
• tcworld
  • tcworld China
  • tcworld India
• tekom Europe
• ACM SIGDOC (ACM's Special Interest Group on Design of Communication)
• Content Wrangler
• IEEE PCS (IEEE Professional Communication Society)

📚 Books and Guides

• IBM or IBM Press
  • The IBM Style Guide
  • Developing Quality Technical Information
  • DITA Best Practices
  • IBM Design
    • Design Philosophy
    • Enterprise Design Thinking (activities and courses)
  • IBM Design Language
  • IBM Carbon Design System Content Guidelines
• Google
  • Google Developer Documentation Style Guide (cn)
  • Google Material Design Writing Guidelines
  • Material's Communication Principles: Intro to UX Writing (Google Developers Codelabs)
• Microsoft
  • Microsoft Writing Style Guide
  • Microsoft Localization Style Guides for Different Languages
    • Microsoft Chinese (Simplified) Style Guide
  • Microsoft Manual of Style for Technical Publications
  • Windows Admin Center UI text and design style guide
  • Azure docs Markdown templates
• Apple
  • Apple Style Guide
  • Human Interface Guidelines | Apple Developer Documentation

• Red Hat supplementary style guide for product documentation
• GitLab Documentation Style Guide
• Mailchimp Content Style Guide
• MongoDB Documentation Style Guide
• The Chicago Manual of Style (Online)
• ASD Simplified Technical English (ASD-STE100)
• Documentation Framework
  • Documentation System | Diátaxis, by Daniele Procida
    • Four forms of documentation: tutorials, how-to guides, technical reference, and explanation.
    • divio/documentation-framework: a popular and transformative documentation authoring framework.
    • evildmp/diataxis-documentation-framework: a systematic approach to creating better documentation.
  • Documentation topic types (CTRT) | GitLab
    • Four primary topic types: concept, task, reference, troubleshooting.
• Docs Like Code
  • About Docs Like Code
  • Docs Like Code Articles
• Technical Writer Roadmap | roadmap.sh
• The Handbook of Technical Writing
• Technical Communication: A reader-centered approach
• Living Documentation: Continuous Knowledge Sharing by Design
• Technical Translation: Usability Strategies for Translating Technical Documentation
• DITA for Print: A DITA Open Toolkit Workbook
• Design Thinking in Technical Communication: Solving Problems through Making and Collaboration
• Style: Lessons in Clarity and Grace
• The Elements of Style: Classic Edition (2018)
• Oxford Guide to Plain English
• The Product is Docs: Writing Technical Documentation in a Product Development Group
• Docs for Developers: An Engineer’s Field Guide to Technical Writing
• API Stylebook: API Design Guidelines of some companies and government agencies
• Software Technical Writing: A Guidebook (epub, discussions on Hacker News)
• Microcopy: The Complete Guide
• Laws of UX
  • Book: Laws of UX: Using Psychology to Design Better Products & Services
• Strategic Writing for UX: Drive Engagement, Conversion, and Retention with Every Word
• The User's Journey: Storymapping Products That People Love
• User Story Mapping: Discover the Whole Story, Build the Right Product
• Change by Design: How Design Thinking Transforms Organizations and Inspires Innovation
• GOV.UK Service Manual and Content Design
• DevRel
  • Ask Your Developer: How to Harness the Power of Software Developers and Win in the 21st Century
• Open source
  • The Cathedral & the Bazaar: Musings on Linux and Open Source by an Accidental Revolutionary
  • Hackers & Painters: Big Ideas from the Computer Age
• Community
  • The Art of Community: Building the New Age of Participation
  • People Powered: How Communities Can Supercharge Your Business, Brand, and Teams
  • Superfans: The Easy Way to Stand Out, Grow Your Tribe, and Build a Successful Business (Companion Course)

🌐 Blogs and Websites

• I'd Rather Be Writing
• Content Wrangler
• DeveloperRelations.com
• TechWhirl
• ClickHelp Technical Writing Blog
• Scriptorium Blog
• James' Blog
• ffeathers
• indoition Technical Documentation Tool and Web Guide

🎓 Courses and Training

• Google Technical Writing Courses for Engineers
• GitLab Technical Writing Fundamentals Course
• Certified Professional Technical Communicator (CPTC™): a certification scheme developed by APMG on behalf of the Society for Technical Communication (STC)
• tcworld TCTrainNet Training Program with Certification
• API Documentation Course | I'd Rather Be Writing: a guide for technical writers and engineers
• Technical Writer HQ
• Technical Writing Essentials (Alison Course)

📻 Podcasts

• Tech Comm

  • Write the Docs Podcast
  • Writers of Silicon Valley
  • The Content Strategy Podcast
  • I'd Rather Be Writing Podcast
  • The Cherryleaf Podcast
  • The Content Strategy Experts Podcast
  • Wireframe (Adobe)
  • The Not-Boring Tech Writer Podcast
  • 10-Minute Tech Comm
  • Content Content Podcast
  • Instrktiv's Insane Instructions Show
  • Knowledgebase Ninjas
  • The Manuscript
  • Grammar Girl

• Tech

  • Software Engineering Daily

    The World Through the Lens of Software

  • Kubernetes Podcast from Google

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

  • The a16z Podcast (simplecast)

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

📰 Journals

• Technical Communication (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 (PDF)

• ACM Communication Design Quarterly Review
• Technical Communication Quarterly

Resources in Chinese 中文资源

• 社区或个人资源
  • 技术传播那些事儿 (by 李琳 Lilian Lee · lilin90)
    • 微信公众号 (ID: tc_fun)
    • 知乎专栏
  • 技术传播李琳：微信公众号 (ID: TC-Lilin) by 李琳 Emma
  • TC 互联技术传播与技术写作社区
    • 官网
    • 微信公众号：infomagic技术传播与技术写作 (ID: infomagic123)
  • tcworld 中国技术传播大会
    • 大会官网：中文版，英文版
    • 微信公众号：tcworld技术传播大会 (ID: tcworld-china)
  • 中国技术传播：微信公众号 (ID: CTCA_CHINA)
  • 技术传播沙龙
    • 讨论前沿技术，分享行业动态
    • 形式：线上线下结合
  • 北京大学技术传播协会：微信公众号 (ID: pkutca)
  • 科多思技术传播社区：微信公众号 (ID: kudoschina)
  • 技术文档写作·知乎专栏 by Joy 思烤
  • 中文技术文档写作风格指南（GitHub 仓库）by yikeke
  • zhLint 中文技术文档检查工具
  • GitHub 新手指南：极简教程教你如何给开源仓库提 PR (by ran-huang & CharLotteiu)
    • Git 与 GitHub 基础概念
    • 如何创建一个 Pull Request (PR)
    • 跟进 PR 的后续操作
    • 批量接受 review 建议和处理 CI 检查
• 书籍
  • 《活文档：与代码共同演进》（译自英文版）
  • 《英语技术写作精要》（复旦大学出版社，但正文语言为英文）
  • 《科技文档写作实务》（人民邮电出版社）
• 课程
  • 重庆邮电大学《英语技术写作》慕课
• 开课高校
  • 开设技术传播或技术写作课程的中国高校

Stargazers over time