Links for technical writers¶
Community¶
Write the Docs: a global community of people who care about documentation.
The Good Docs Project: volunteers empowering developers to create good documentation.
Google Season of Docs: support for open source projects to improve their documentation.
Top 5 Technical Writing Communities of 2024: list of 2024’s top 5 technical writing communities according to Hackmamba.
Training¶
Google’s Technical Writing Courses: learn how to plan and author technical documents.
GOV.UK: Documenting APIs: structuring, designing and publishing your API documentation.
Best Technical Writing Courses & Certificates: Selected list of technical writing courses from Coursera.
Become a Certified Technical Writer: Technical Writer HQ specializes in providing courses for various types of writing certifications.
Style and structure¶
Microsoft Writing Style Guide: writing style guide and terminology for all communication.
Google Style Guides: guides on style for languages from AngularJS to Vim script.
Diátaxis: a systematic approach to technical documentation authoring.
Introduction to DITA: an open standard and architecture for technical information.
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.
Frameworks¶
AsciiDoc: a plain text markup language for writing technical content.
Docusaurus: MDX-powered documentation publishing platform.
Sphinx: use RST or MyST Markdown to author highly structured technical documents.
LaTeX: text-based markup for type setting, especially for scientific documentation.
Great documentation examples¶
Mozilla Developer Network: documenting web technologies, including CSS, HTML, and JavaScript.
Django documentation: a web framework developed to publish data-driven websites.
Arch Linux wiki: community-driven in-depth articles on many aspects of Linux and open source.
Microsoft technical documentation: in-depth guides and articles organised by product.
Google Workspace Learning Center: collection of resources of Google’s Learning Center.
Stripe API documentation: documentation for an efficient and correct use of Stripe API.