Skip to content

Add to our 'Links for technical writers' page #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 39 additions & 21 deletions website/library/reference/links-for-technical-writers.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,58 @@
# Links for technical writers


## Blogs

- [I'd Rather Be Writing](https://idratherbewriting.com/): Tom Johnson’s blog on technical writing, docs-as-code, and APIs.
- [Passo uno](https://passo.uno/): Fabrizio Ferri Benedetti’s blog on technical writing, documentation, and language.

## Community

- [Write the Docs](https://www.writethedocs.org/): a global community of people who care about documentation.
- [The Good Docs Project](https://www.thegooddocsproject.dev/): volunteers empowering developers to create good documentation.
- [Google Season of Docs](https://developers.google.com/season-of-docs): support for open source projects to improve their documentation.
- [The Good Docs Project](https://www.thegooddocsproject.dev/): volunteers empowering developers to create good documentation.
- [Top 5 Technical Writing Communities of 2024](https://hackmamba.io/blog/2024/03/top-5-technical-writing-communities-of-2024/): list of 2024's top 5 technical writing communities according to Hackmamba.
- [Write the Docs](https://www.writethedocs.org/): a global community of people who care about documentation.

## Training
## Frameworks

- [Google's Technical Writing Courses](https://developers.google.com/tech-writing): learn how to plan and author technical documents.
- [GOV.UK: Documenting APIs](https://www.gov.uk/guidance/how-to-document-apis): structuring, designing and publishing your API documentation.
- [Best Technical Writing Courses & Certificates](https://www.coursera.org/courses?query=technical%20writing): Selected list of technical writing courses from Coursera.
- [Become a Certified Technical Writer](https://technicalwriterhq.com): Technical Writer HQ specializes in providing courses for various types of writing certifications.
- [AsciiDoc](https://asciidoc.org/): a plain text markup language for writing technical content.
- [Docusaurus](https://docusaurus.io/): MDX-powered documentation publishing platform.
- [LaTeX](https://www.latex-project.org/): text-based markup for type setting, especially for scientific documentation.
- [Sphinx](https://www.sphinx-doc.org/en/master/index.html): use RST or MyST Markdown to author highly structured technical documents.

## Great documentation examples

- [Arch Linux wiki](https://wiki.archlinux.org/): community-driven in-depth articles on many aspects of Linux and open source.
- [Django documentation](https://docs.djangoproject.com/en/): a web framework developed to publish data-driven websites.
- [Google Workspace Learning Center](https://support.google.com/a/users/answer/9389764?visit_id=638775740206409702-380102409&hl=en&rd=1): collection of resources of Google's Learning Center.
- [Microsoft technical documentation](https://learn.microsoft.com/en-us/docs/): in-depth guides and articles organised by product.
- [Mozilla Developer Network](https://developer.mozilla.org/en-US/): documenting web technologies, including CSS, HTML, and JavaScript.
- [Stripe API documentation](https://docs.stripe.com/api): documentation for an efficient and correct use of Stripe API.

## Podcasts

- [API The Docs](https://apithedocs.org/podcast): podcast about API documentation and developer portals.
- [CherryLeaf](https://www.cherryleaf.com/podcast/): podcast on technical writing skills and interviews with technical writers.
- [The Not-Boring Tech Writer](https://thenotboringtechwriter.com/): podcast about the complexities of technical writing.
- [I'd Rather Be Writing](https://idratherbewriting.com/podcasts/): podcast about technical writing trends and best.practices

## Style and structure

- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/): writing style guide and terminology for all communication.
- [Google Style Guides](https://google.github.io/styleguide/): guides on style for languages from AngularJS to Vim script.
- [Diátaxis](https://diataxis.fr/): a systematic approach to technical documentation authoring.
- [Google Style Guides](https://google.github.io/styleguide/): guides on style for languages from AngularJS to Vim script.
- [Introduction to DITA](https://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/archSpec/base/introduction-to-dita.html#introduction-to-dita): an open standard and architecture for technical information.
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/): writing style guide and terminology for all communication.
- [Technical Writing Resources](https://developers.google.com/tech-writing/resources): resources and style guides from Google for developers.
- [What is a Technical Writer Style Guide? With Examples](https://document360.com/blog/technical-writer-style-guide/): guide with style examples from Document360.

## Frameworks
## Training

- [Become a Certified Technical Writer](https://technicalwriterhq.com): courses for various types of writing certifications.
- [Best Technical Writing Courses & Certificates](https://www.coursera.org/courses?query=technical%20writing): selected list of technical writing courses from Coursera.
- [Google's Technical Writing Courses](https://developers.google.com/tech-writing): learn how to plan and author technical documents.
- [GOV.UK: Documenting APIs](https://www.gov.uk/guidance/how-to-document-apis): learn about structuring, designing, and publishing your API documentation.



- [AsciiDoc](https://asciidoc.org/): a plain text markup language for writing technical content.
- [Docusaurus](https://docusaurus.io/): MDX-powered documentation publishing platform.
- [Sphinx](https://www.sphinx-doc.org/en/master/index.html): use RST or MyST Markdown to author highly structured technical documents.
- [LaTeX](https://www.latex-project.org/): text-based markup for type setting, especially for scientific documentation.

## Great documentation examples

- [Mozilla Developer Network](https://developer.mozilla.org/en-US/): documenting web technologies, including CSS, HTML, and JavaScript.
- [Django documentation](https://docs.djangoproject.com/en/): a web framework developed to publish data-driven websites.
- [Arch Linux wiki](https://wiki.archlinux.org/): community-driven in-depth articles on many aspects of Linux and open source.
- [Microsoft technical documentation](https://learn.microsoft.com/en-us/docs/): in-depth guides and articles organised by product.
- [Google Workspace Learning Center](https://support.google.com/a/users/answer/9389764?visit_id=638775740206409702-380102409&hl=en&rd=1): collection of resources of Google's Learning Center.
- [Stripe API documentation](https://docs.stripe.com/api): documentation for an efficient and correct use of Stripe API.