├── .github └── FUNDING.yml └── README.md /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | 4 | ko_fi: stephaniemorillo 5 | github: rubymorillo 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # The Pocket Technical Writing List 🗂 2 | A small but formidable list of technical writing resources for software developers. 3 | 4 | --- 5 | ## Courses and Other Resources 👨🏾‍💻 6 | - [Write the Docs](https://www.writethedocs.org) 7 | - [WtD Learning Resources](https://www.writethedocs.org/about/learning-resources/) 8 | - [WtD Slack Community](https://www.writethedocs.org/slack/) 9 | - [Google's Technical Writing Courses](https://developers.google.com/tech-writing) 10 | - [UC San Diego's Technical Communication I Course](https://extension.ucsd.edu/courses-and-programs/technical-communication-i) 11 | - [Society for Technical Communication Online Technical Writing Courses](https://www.stc.org/education/online-courses/) 12 | - [Ritza's free Writing for Coders Intensive](https://ritza.co/writing-for-coders-coding-for-writers-course.html) 13 | - [Sample Technical Writing Template by Bolaji Ayodeji](https://github.com/BolajiAyodeji/technical-writing-template) 14 | - [RunDOC, a library for generate docs by Richard Schneeman](https://github.com/schneems/rundoc) 15 | - [How to Document APIs Guide](https://idratherbewriting.com/learnapidoc/) 16 | 17 | 18 | ## Articles 📰 19 | - [A Brief Introduction to Technical Writing](https://www.stephaniemorillo.co/post/a-brief-introduction-to-technical-writing) 20 | - [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) 21 | - [4 ways to keep distractions out of screenshots](https://ddbeck.com/hide-distractions-in-screenshots/) 22 | 23 | ## Books 📕 24 | - [_How to Make Sense of Any Mess_ by Abby Covert](https://www.amazon.com/How-Make-Sense-Any-Mess/dp/1500615994) 25 | - [_The Product is Docs_ by Christopher Gales and the Splunk Docs team](https://www.amazon.com/Product-Docs-technical-documentation-development/dp/1973589400) 26 | - [_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) 27 | - [_Technical Communication Today_ by Richard Johnson-Sheehan](https://www.amazon.com/gp/product/0205171192/ref=dbs_a_def_rwt_bibl_vppi_i6) 28 | - [_Technical Communication, 13th Edition_ by Mike Markel et. al](https://www.macmillanlearning.com/college/us/product/Technical-Communication/p/1319245005) 29 | - [_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) 30 | 31 | ## Documentation Style Guides 📝 32 | - [README Checklist](https://github.com/ddbeck/readme-checklist/blob/main/checklist.md) by Daniel Beck 33 | - [MDN Web Docs Style Guide](https://developer.mozilla.org/en-US/docs/MDN/Guidelines/Writing_style_guide) 34 | - [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse) 35 | - [Divio's documentation system](https://documentation.divio.com/) 36 | - [Microsoft's Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/) 37 | - [Google's Developer Documentation Style Guide](https://developers.google.com/style) 38 | - [DigitalOcean's Technical Writing Guidelines](https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines) 39 | - [GitLab's Documentation Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html) 40 | - [Checklist for Technical Writing (PDF)](http://emlab.utep.edu/pdfs/Checklist%20for%20Technical%20Writing.pdf) 41 | 42 | ## Paid Writing Opportunities😎 43 | - [Tech Community Writing Programs compiled by Daniel Madalitso Phiri](https://github.com/malgamves/CommunityWriterPrograms) 44 | 45 | --- 46 | List compiled by [Stephanie Morillo](https://www.stephaniemorillo.co/links). Found it useful? [Consider becoming a GitHub Sponsor!](https://www.github.com/sponsors/rubymorillo) 47 | --------------------------------------------------------------------------------