Links for technical writers

Blogs

• I’d Rather Be Writing: Tom Johnson’s blog on technical writing, docs-as-code, and APIs.

• Passo uno: Fabrizio Ferri Benedetti’s blog on technical writing, documentation, and language.

Community

• The Good Docs Project: volunteers empowering developers to create good documentation.

• Top 5 Technical Writing Communities of 2024: list of 2024’s top 5 technical writing communities according to Hackmamba.

• Write the Docs: a global community of people who care about documentation.

Frameworks

• AsciiDoc: a plain text markup language for writing technical content.

• Docusaurus: MDX-powered documentation publishing platform.

• LaTeX: text-based markup for type setting, especially for scientific documentation.

• Sphinx: use RST or MyST Markdown to author highly structured technical documents.

Great documentation examples

• Arch Linux wiki: community-driven in-depth articles on many aspects of Linux and open source.

• Django documentation: a web framework developed to publish data-driven websites.

• Google Workspace Learning Center: collection of resources of Google’s Learning Center.

• Microsoft technical documentation: in-depth guides and articles organised by product.

• Mozilla Developer Network: documenting web technologies, including CSS, HTML, and JavaScript.

• Stripe API documentation: documentation for an efficient and correct use of Stripe API.

Podcasts

• API The Docs: podcast about API documentation and developer portals.

• CherryLeaf: podcast on technical writing skills and interviews with technical writers.

• The Not-Boring Tech Writer: podcast about the complexities of technical writing.

• I’d Rather Be Writing: podcast about technical writing trends and best.practices

Style and structure

• Diátaxis: a systematic approach to technical documentation authoring.

• Google Style Guides: guides on style for languages from AngularJS to Vim script.

• Introduction to DITA: an open standard and architecture for technical information.

• Microsoft Writing Style Guide: writing style guide and terminology for all communication.

• Technical Writing Resources: resources and style guides from Google for developers.

• What is a Technical Writer Style Guide? With Examples: guide with style examples from Document360.

Training

• Become a Certified Technical Writer: courses for various types of writing certifications.

• Best Technical Writing Courses & Certificates: selected list of technical writing courses from Coursera.

• Google’s Technical Writing Courses: learn how to plan and author technical documents.

• GOV.UK: Documenting APIs: learn about structuring, designing, and publishing your API documentation.