Skip to content

Commit 6a028ed

Browse files
authored
Merge pull request #212 from preethys26/coda-205
Add to our 'Links for technical writers' page
2 parents a656cf8 + ea51926 commit 6a028ed

File tree

1 file changed

+38
-21
lines changed

1 file changed

+38
-21
lines changed

website/library/reference/links-for-technical-writers.md

Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,57 @@
11
# Links for technical writers
22

3+
4+
## Blogs
5+
6+
- [I'd Rather Be Writing](https://idratherbewriting.com/): Tom Johnson’s blog on technical writing, docs-as-code, and APIs.
7+
- [Passo uno](https://passo.uno/): Fabrizio Ferri Benedetti’s blog on technical writing, documentation, and language.
8+
39
## Community
410

5-
- [Write the Docs](https://www.writethedocs.org/): a global community of people who care about documentation.
611
- [The Good Docs Project](https://www.thegooddocsproject.dev/): volunteers empowering developers to create good documentation.
7-
- [Google Season of Docs](https://developers.google.com/season-of-docs): support for open source projects to improve their documentation.
812
- [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.
13+
- [Write the Docs](https://www.writethedocs.org/): a global community of people who care about documentation.
914

10-
## Training
15+
## Frameworks
1116

12-
- [Google's Technical Writing Courses](https://developers.google.com/tech-writing): learn how to plan and author technical documents.
13-
- [GOV.UK: Documenting APIs](https://www.gov.uk/guidance/how-to-document-apis): structuring, designing and publishing your API documentation.
14-
- [Best Technical Writing Courses & Certificates](https://www.coursera.org/courses?query=technical%20writing): Selected list of technical writing courses from Coursera.
15-
- [Become a Certified Technical Writer](https://technicalwriterhq.com): Technical Writer HQ specializes in providing courses for various types of writing certifications.
17+
- [AsciiDoc](https://asciidoc.org/): a plain text markup language for writing technical content.
18+
- [Docusaurus](https://docusaurus.io/): MDX-powered documentation publishing platform.
19+
- [LaTeX](https://www.latex-project.org/): text-based markup for type setting, especially for scientific documentation.
20+
- [Sphinx](https://www.sphinx-doc.org/en/master/index.html): use RST or MyST Markdown to author highly structured technical documents.
21+
22+
## Great documentation examples
23+
24+
- [Arch Linux wiki](https://wiki.archlinux.org/): community-driven in-depth articles on many aspects of Linux and open source.
25+
- [Django documentation](https://docs.djangoproject.com/en/): a web framework developed to publish data-driven websites.
26+
- [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.
27+
- [Microsoft technical documentation](https://learn.microsoft.com/en-us/docs/): in-depth guides and articles organised by product.
28+
- [Mozilla Developer Network](https://developer.mozilla.org/en-US/): documenting web technologies, including CSS, HTML, and JavaScript.
29+
- [Stripe API documentation](https://docs.stripe.com/api): documentation for an efficient and correct use of Stripe API.
30+
31+
## Podcasts
32+
33+
- [API The Docs](https://apithedocs.org/podcast): podcast about API documentation and developer portals.
34+
- [CherryLeaf](https://www.cherryleaf.com/podcast/): podcast on technical writing skills and interviews with technical writers.
35+
- [The Not-Boring Tech Writer](https://thenotboringtechwriter.com/): podcast about the complexities of technical writing.
36+
- [I'd Rather Be Writing](https://idratherbewriting.com/podcasts/): podcast about technical writing trends and best.practices
1637

1738
## Style and structure
1839

19-
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/): writing style guide and terminology for all communication.
20-
- [Google Style Guides](https://google.github.io/styleguide/): guides on style for languages from AngularJS to Vim script.
2140
- [Diátaxis](https://diataxis.fr/): a systematic approach to technical documentation authoring.
41+
- [Google Style Guides](https://google.github.io/styleguide/): guides on style for languages from AngularJS to Vim script.
2242
- [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.
43+
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/): writing style guide and terminology for all communication.
2344
- [Technical Writing Resources](https://developers.google.com/tech-writing/resources): resources and style guides from Google for developers.
2445
- [What is a Technical Writer Style Guide? With Examples](https://document360.com/blog/technical-writer-style-guide/): guide with style examples from Document360.
2546

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

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

33-
## Great documentation examples
3457

35-
- [Mozilla Developer Network](https://developer.mozilla.org/en-US/): documenting web technologies, including CSS, HTML, and JavaScript.
36-
- [Django documentation](https://docs.djangoproject.com/en/): a web framework developed to publish data-driven websites.
37-
- [Arch Linux wiki](https://wiki.archlinux.org/): community-driven in-depth articles on many aspects of Linux and open source.
38-
- [Microsoft technical documentation](https://learn.microsoft.com/en-us/docs/): in-depth guides and articles organised by product.
39-
- [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.
40-
- [Stripe API documentation](https://docs.stripe.com/api): documentation for an efficient and correct use of Stripe API.

0 commit comments

Comments
 (0)