https://github.com/rubymorillo/pocket-tech-writing-list
A small but formidable list of technical writing resources for developers
https://github.com/rubymorillo/pocket-tech-writing-list
Last synced: 17 days ago
JSON representation
A small but formidable list of technical writing resources for developers
- Host: GitHub
- URL: https://github.com/rubymorillo/pocket-tech-writing-list
- Owner: rubymorillo
- Created: 2020-05-09T00:06:10.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-01-05T10:54:24.000Z (over 1 year ago)
- Last Synced: 2025-03-25T03:48:52.449Z (21 days ago)
- Size: 49.8 KB
- Stars: 704
- Watchers: 22
- Forks: 56
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- jimsghstars - rubymorillo/pocket-tech-writing-list - A small but formidable list of technical writing resources for developers (Others)
README
# The Pocket Technical Writing List 🗂
A small but formidable list of technical writing resources for software developers.
---
## Courses and Other Resources 👨🏾💻
- [Write the Docs](https://www.writethedocs.org)
- [WtD Learning Resources](https://www.writethedocs.org/about/learning-resources/)
- [WtD Slack Community](https://www.writethedocs.org/slack/)
- [Google's Technical Writing Courses](https://developers.google.com/tech-writing)
- [UC San Diego's Technical Communication I Course](https://extension.ucsd.edu/courses-and-programs/technical-communication-i)
- [Society for Technical Communication Online Technical Writing Courses](https://www.stc.org/education/online-courses/)
- [Ritza's free Writing for Coders Intensive](https://ritza.co/writing-for-coders-coding-for-writers-course.html)
- [Sample Technical Writing Template by Bolaji Ayodeji](https://github.com/BolajiAyodeji/technical-writing-template)
- [RunDOC, a library for generate docs by Richard Schneeman](https://github.com/schneems/rundoc)
- [How to Document APIs Guide](https://idratherbewriting.com/learnapidoc/)
## Articles 📰
- [A Brief Introduction to Technical Writing](https://www.stephaniemorillo.co/post/a-brief-introduction-to-technical-writing)
- [7 Pieces of Information to Include in Technical Blog Posts](https://www.stephaniemorillo.co/post/7-pieces-of-information-to-include-in-technical-blog-posts)
- [4 ways to keep distractions out of screenshots](https://ddbeck.com/hide-distractions-in-screenshots/)
## Books 📕
- [_How to Make Sense of Any Mess_ by Abby Covert](https://www.amazon.com/How-Make-Sense-Any-Mess/dp/1500615994)
- [_The Product is Docs_ by Christopher Gales and the Splunk Docs team](https://www.amazon.com/Product-Docs-technical-documentation-development/dp/1973589400)
- [_Information Architecture for the Web and Beyond_ by Louis Rosenfeld et. al.](https://www.amazon.com/dp/B015D78JV6/ref=cm_sw_r_tw_dp_U_x_VfYSEbV3F80K4)
- [_Technical Communication Today_ by Richard Johnson-Sheehan](https://www.amazon.com/gp/product/0205171192/ref=dbs_a_def_rwt_bibl_vppi_i6)
- [_Technical Communication, 13th Edition_ by Mike Markel et. al](https://www.macmillanlearning.com/college/us/product/Technical-Communication/p/1319245005)
- [_Technical Editing, 5th Edition_ by Carolyn D. Rude and Angela Eaton](https://www.amazon.com/Technical-Editing-Allyn-Seriesin-Communication/dp/0205786715/ref=pd_lpo_14_t_0/134-4344360-0879020?_encoding=UTF8&pd_rd_i=0205786715&pd_rd_r=41904240-3355-4fdb-b6da-60fd33075a91&pd_rd_w=4dINj&pd_rd_wg=pBam8&pf_rd_p=7b36d496-f366-4631-94d3-61b87b52511b&pf_rd_r=AT3FGPAN9H34TFK18QQT&psc=1&refRID=AT3FGPAN9H34TFK18QQT)
## Documentation Style Guides 📝
- [README Checklist](https://github.com/ddbeck/readme-checklist/blob/main/checklist.md) by Daniel Beck
- [MDN Web Docs Style Guide](https://developer.mozilla.org/en-US/docs/MDN/Guidelines/Writing_style_guide)
- [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse)
- [Divio's documentation system](https://documentation.divio.com/)
- [Microsoft's Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/)
- [Google's Developer Documentation Style Guide](https://developers.google.com/style)
- [DigitalOcean's Technical Writing Guidelines](https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines)
- [GitLab's Documentation Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html)
- [Checklist for Technical Writing (PDF)](http://emlab.utep.edu/pdfs/Checklist%20for%20Technical%20Writing.pdf)
## Paid Writing Opportunities😎
- [Tech Community Writing Programs compiled by Daniel Madalitso Phiri](https://github.com/malgamves/CommunityWriterPrograms)
---
List compiled by [Stephanie Morillo](https://www.stephaniemorillo.co/links). Found it useful? [Consider becoming a GitHub Sponsor!](https://www.github.com/sponsors/rubymorillo)