# Awesome Technical Writing ![](https://repository-images.githubusercontent.com/221308953/36034800-6311-11ea-8418-8a1a03c97d81) [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) [![Made in Nigeria](https://img.shields.io/badge/Made%20in-Nigeria-008751.svg?style=flat-square)](https://github.com/BolajiAyodeji/awesome-technical-writing) [![All Contributors](https://img.shields.io/badge/all_contributors-41-orange.svg?style=flat-square)](#contributors-) *This list is inspired by the [awesome](https://github.com/sindresorhus/awesome) and [awesome-jamstack](https://github.com/bolajiayodeji/awesome-jamstack) lists.*
--- > [!TIP] > Technical writing is the writing of technical content used in technical and occupational fields, such as computer hardware and software, engineering, chemistry, aeronautics, robotics, finance, medical, biotechnology, etc. ~ [Wikipedia](https://en.wikipedia.org/wiki/Technical_writing) --- ## Table of Contents - [Community](#community) - [Style Guides](#style-guides) - [Courses](#courses) - [Books](#books) - [Podcasts](#podcasts) - [Conferences](#conferences) - [Speaker Decks](#speaker-decks) - [Useful Tools](#useful-tools) - [Resources](#resources) - [Videos](#videos) - [Technical Writers to Follow](#some-technical-writers-to-follow) --- ## Community * [Hashnode](https://hashnode.com) * [r/technicalwriting](https://reddit.com/r/technicalwriting) * [Google's Season of Docs](https://developers.google.com/season-of-docs) * [freeCodeCamp News](https://freecodecamp.org/news) * [ycombinator News](https://news.ycombinator.com) * [DEV](https://dev.to) * [Hackernoon](https://hackernoon.com) * [Write the Docs](https://writethedocs.org) * [The Good Docs Project](https://thegooddocsproject.dev) * [LinkedIn Technical Writing Community](https://linkedin.com/groups/13705342) * [Society for Technical Communication](https://stc.org) * [The Manuscript Academy](https://manuscriptacademy.com) ## Style Guides * [Microsoft Manual of Style](https://ptgmedia.pearsoncmg.com/images/9780735648715/samplepages/9780735648715.pdf) * [IBM Editorial Style Guide](http://ptgmedia.pearsoncmg.com/images/9780132101301/samplepages/0132101300.pdf) * [The Red Hat Style Guide](https://stylepedia.net/style) * [Google Developer Documentation Style Guide](https://developers.google.com/style) * [Chicago Manual of Style](https://chicagomanualofstyle.org/home.html) * [University of Oxford Style Guide](https://ox.ac.uk/sites/files/oxford/media_wysiwyg/University%20of%20Oxford%20Style%20Guide.pdf) * [Dutch Style Guide](https://github.com/lboshuizen/dutch-style-guide) ## Courses * [Google Technical Writing Courses](https://developers.google.com/tech-writing/overview) * [Tech Writing for Accessibility](https://developers.google.com/tech-writing/accessibility) * [Writing Helpful Error Messages](https://developers.google.com/tech-writing/error-messages) * [Technical Writing: Documentation on Software Projects](https://www.pluralsight.com/courses/technical-writing-software-documentation) * [Coding for Writers: Basic Programming](https://udemy.com/course/coding-for-writers-1-basic-programming) * [Class Central Technical Writing](https://classcentral.com/course/technical-writing-7117) * [Professional Technical Writing: Advance Your Writing Skills](https://udemy.com/technical-writing-and-editing) * [Technical Writing: Master Your Writing Career](https://udemy.com/technical-writing) * [English 305: Advanced Technical Writing](https://study.com/academy/course/technical-writing-course.html) * [Technical Communication Techniques and Principles for Project Managers](https://ce.uwec.edu/programs/technical-communication-techniques-and-principles-project-managers) * [Documenting APIs: A Guide for Technical Writers](https://idratherbewriting.com/learnapidoc) * [Technical Writing Certification Course](https://aptlearn.io/courses/technical-writing-certification-course) * [Tech: Write & Earn](https://startuptrybe.trainercentralsite.com/course/techwriteearn) * [Technical Writing Tutorials for Software Testing](https://tutorialsearch.io/browse/software-testing/technical-writing) ## Books * [Docs for Developers: An Engineer’s Field Guide to Technical Writing](https://amzn.to/3SjaMRR) by Jared Bhatti, Zach Corleissen, Jen Lambourne, David Nuñez, and Heidi Waterhouse. * [The Developer's Guide to Content Creation](https://www.stephaniemorillo.co/product-page/the-developer-s-guide-to-content-creation) by Stephanie Morillo. * [The Developer's Guide to Creating a Successful Blog](https://gumroad.com/l/successfulblog) by Flavio Copes. * [Everybody Writes: Your New and Improved Go-To Guide to Creating Ridiculously Good Content](https://amzn.to/3Z3EgVY) by Ann Handley. * [Technical Writing for Dummies](https://amzn.to/3XU6Bx1) by Sheryl Lindsell-Roberts. * [The Handbook of Technical Writing](https://amzn.to/3IHEXxN) by Gerald J. Alre, Walter E. Oliu, and Charles T. Brusaw. * [How To Write Usable User Documentation](https://amzn.to/3KpJtDr) by Edmond H. Weiss. * [Letting Go of the Words: Writing Web Content that Works](https://amzn.to/41tAV4C) by Janice Redish. * [Docs Like Code: Collaborate and Automate to Improve Technical Documentation](https://amzn.to/3kdNMHn) by Anne Gentle. * [The Product is Docs: Writing Technical Documentation in a Product Development Group](https://amzn.to/3m19xKL) by Christopher Gales and Splunk Documentation Team. * [Every Page Is Page One: Topic-Based Writing for Technical Communication and the Web](https://amzn.to/3KtMx1e) by Mark Baker. * [Modern Technical Writing: An Introduction to Software](https://amzn.to/3lYEq2H) by Andrew Etter. * [Software Technical Writing: A Guidebook](https://jamesg.blog/book.pdf) by James Gallagher. ## Podcasts * [The Manuscript Podcast](https://brenobarreto.co/the-manuscript-podcast/) - The intersection of writing and the development of technology products. * [The Manuscript Academy Podcast](https://manuscriptacademy.com/podcast) - Interviews with agents and editors, how-to tips, and behind-the-scenes looks at the creation of the Academy. * [Write the Docs Podcast](https://podcast.writethedocs.org/) - The Write the Docs Podcast publishes discussion-style podcasts focusing on topics related to the Write the Docs community. * [The Not-Boring Tech Writer](https://www.thenotboringtechwriter.com/) - The Not-Boring Tech Writer podcast introduces technical writers' skills used in the open data movement. ## Conferences * [Write the Docs Conferences](https://writethedocs.org/conf) * [The LavaCon Content Strategy Conference ](https://lavacon.org) * [API the Docs](https://apithedocs.org) * [Technical Communication UK Metro Conference](http://technicalcommunicationuk.com) * [MadWorld](https://www.madcapsoftware.com/madworld-conferences) * [WritersUA West Content Pro Conference](http://west.writersua.com) ## Speaker Decks * [Effective Documentation: The Key to Open Source Growth](https://slides.com/bolajiayodeji/effective-oss-docs) * [Technical Writing for Non-Writers](https://speakerdeck.com/taroth21/technical-writing-for-non-writers) * [Beyond The Editor: Automating Your Writing Process](https://slides.com/bolajiayodeji/beyond-the-editor)
## Useful Tools * [Technical Writing Template](https://github.com/BolajiAyodeji/technical-writing-template) - A sample template with guidelines for writing technical articles. * [Paid Community Writer Programs](https://github.com/malgamves/CommunityWriterPrograms) - A list of companies that have paid developer community writer programs. * [Who Pays Technical Writers?](https://whopaystechnicalwriters.com/?) - A curated collection of active publishers, publications, and agencies that pay fair rates for high-quality technical content. * [Diátaxis Documentation System](https://diataxis.fr) - A systematic approach to creating better documentation. * [HackMD](https://hackmd.io) - Real-time collaboration on technical documentation in Markdown. * [Dropbox Paper](https://dropbox.com/paper) - A flexible workspace for collaborative document editing. * [Google Docs](https://docs.google.com) - Smart editing and styling tools to help you easily format text and paragraphs. * [Notion](https://notion.so) - The all-in-one workspace for your notes, tasks, wikis and databases. * [Notion AI](https://otion.so/product/ai) - Leverage the limitless power of AI in any Notion page, write faster and augment your creativity. * [Grammarly](https://grammarly.com) - a writing assistant that goes deeper than grammar to offer you comprehensive writing feedback. * [Canva](https://canva.com) - A graphic design platform that allows you to create social media graphics and other visual content. * [TinyPNG](https://tinypng.com) - Smart PNG and JPEG image compression. * [Full Page Screen Capture](https://chrome.google.com/webstore/detail/full-page-screen-capture/fdpohaocaechififmbbbbbknoalclacl?hl=en) - The simplest way to take a full page screenshot of your current browser window. * [Awesome Screenshot: Screen Video Recorder](https://chrome.google.com/webstore/detail/awesome-screenshot-screen/nlipoenfbbikpbjkfpfillcgkoblgpmj?hl=en) - Screen capture full-page screenshot and recorder for screencast. * [Readme Markdown Generator](https://github.com/kefranabg/readme-md-generator) - CLI that generates beautiful README.md files. * [Capture to a Gif](https://chrome.google.com/webstore/detail/capture-to-a-gif/eapecadlmfblmnfnojebefkbginhggeh) - Record content of pages to an animated GIF picture from the browser. * [Microsoft Word](https://www.microsoft.com/en/microsoft-365/word) - Spelling, grammar, and intelligent suggestions to assist you across documents, email, and on the web. * [Log4brains](https://github.com/thomvaill/log4brains) - Docs-as-code knowledge base to manage Architecture Decision Records (ADR) for your project and publish them automatically as a static website. * [Antidote](https://www.antidote.info) - The corrector analyses your text and flags any detections. * [LanguageTool](https://languagetool.org) - Open-source writing assistant, an alternative to Grammarly. * [HemingwayApp](https://hemingwayapp.com) - Hemingway App makes your writing bold and clear. Helps fix long & complex sentences. * [ChatGPT](https://chat.openai.com) - A conversational chatbot that can generate human-like responses to natural language prompts. * [TextCraft](https://github.com/suncloudsmoon/TextCraft) - Add-in for Microsoft Word that seamlessly integrates essential AI tools, including text generation, proofreading, and more, directly into the user interface. * [adoc Studio](https://adoc-studio.app) - adoc Studio is an integrated writing environment for structured texts using AsciiDoc. * [Crosspost](https://trycrosspost.com) - Crosspost helps you write, import and publish articles to multiple platforms like Medium, Ghost, Hashnode, Dev.to and more at once. Write once, publish everywhere. * [Heroshot](https://github.com/omachala/heroshot) - Screenshot automation for documentation with a visual element picker and theme-aware output. * [EkLine](https://ekline.io) - Documentation quality automation. Enforces style guides on PRs, validates links, flags outdated content, and helps draft new docs. * [Tablesmit](https://tablesmit.com) - A minimalist table builder for analytical writing. Create, format, and export structured tables for technical documentation. Open source and free. * [Slopless](https://github.com/seochecks-ai/slopless) - Deterministic textlint preset and CLI to flag AI-generated and padded English prose without calling an LLM. * [ai-slop-detect](https://github.com/antydizajn/ai-slop-detect) - Free Python CLI that flags AI-generated text patterns in markdown and prose (em-dashes, ChatGPT phrases, punctuation density, zero-width Unicode). * [Slop-Gate](https://github.com/hwajongpark/slop-gate) - CLI that flags AI writing-tells (em-dashes and filler words like "delve" and "seamless") in prose before you publish, locally or in CI. * [NRG](https://github.com/nanolaba/readme-generator) - Multi-language README generator with widgets (CLI, Maven plugin, Java library). * [BeLikeNative Writing Assistant](https://github.com/theluckystrike/bln-writing-assistant) - Open-source writing quality analyzer with L1-aware grammar suggestions for non-native English speakers. * [unslop](https://github.com/MohamedAbdallah-14/unslop) - A Claude Code plugin that removes AI writing patterns from text — tricolons, em-dash pileups, hedging stacks, sycophancy openers, stock vocabulary. * [Sourcey](https://sourcey.com) - Open source documentation platform for OpenAPI specs and markdown. * [Trupeer](https://www.trupeer.ai/) - AI-powered tool that transforms screen recordings into polished product videos and step-by-step documentation. * [JustBlogged](https://justblogged.com) - A no-setup blogging platform with built-in SEO, custom domains, and beautiful themes. Sign up, pick a name, and start publishing technical content in minutes. * [ProseScore](https://prosescore.ckmtools.dev/) - Free browser-based readability analyser with 8 formulas, sentiment analysis, keyword extraction, and SEO scoring. Privacy-first, runs entirely client-side. * [Patina](https://github.com/devswha/patina) - Audits and rewrites AI-sounding technical writing while preserving meaning, claims, numbers, polarity, and causation. * [Excel to Markdown](https://exceltomd.com/excel-to-markdown) - Convert Excel, CSV, or pasted tables into Markdown locally in the browser. * [MacMD Viewer](https://macmdviewer.com) - Native macOS Markdown viewer with Mermaid diagram rendering, QuickLook extension, and syntax highlighting for 190+ languages.
## Resources * [The Ultimate Guide to Content Creation](https://blog.hubspot.com/marketing/content-creation) * [How to Create Great Content: A Step-by-Step Guide to Content Marketing That Delivers Real Results](https://inc.com/jeff-haden/how-to-create-great-content-a-step-by-step-guide-to-content-marketing-that-delivers-real-results.html) * [9 Tips to Become the Best Content Creator in Your Industry](https://weidert.com/blog/tips-to-make-you-the-best-content-creator-in-your-industry) * [Advice for Technical Writing](https://css-tricks.com/advice-for-technical-writing) * [Becoming a Technical Writer at Google](https://developers.google.com/tech-writing/becoming) * [15 Tips to Improve Your Technical Writing](https://thebestschools.org/magazine/technical-writing-tips) * [How to Become a Technical Writer: A Beginner’s Guide](https://www.instructionalsolutions.com/blog/become-a-technical-writer) * [How to Create Cover Images for Your Devblog Posts](https://townhall.hashnode.com/how-to-create-cover-images-for-your-devblog-posts-cjyo53edo000heys1p7iuylpw) * [Introducing Google Season of Docs](https://developers.google.com/season-of-docs/docs) * [How to Start a Software YouTube Channel](https://freecodecamp.org/news/how-to-start-a-software-youtube-channel) * [Starting a YouTube Channel as a Software Developer](https://claudiobernasconi.ch/2019/03/20/starting-a-youtube-channel-as-a-software-developer/0) * [How to Create a Programming YouTube Channel - Lessons From 5 Years and 1 Million Subscribers](https://freecodecamp.org/news/how-to-start-a-software-youtube-channel-video-course) * [Developers: The Why and How to Writing Technical Articles](https://freecodecamp.org/news/developers-the-why-and-how-to-writing-technical-articles-54e824789ef6) * [How to Improve the SEO of Your Devblog Articles](https://townhall.hashnode.com/how-to-improve-the-seo-of-your-devblog-articles-cjz3u8lk3003gavs1l071dzoz) * [How to Improve the SEO of Your Devblog](https://townhall.hashnode.com/how-to-improve-the-seo-of-your-devblog-cjz191c0e00380ks1nbtpwh8f) * [Technical Writing: Why and How?](https://medium.com/the-andela-way/technical-writing-why-and-how-599f18477cef) * [Minimalist Approach to Technical Documentation](https://utwente.nl/en/bms/ist/minimalism) * [A beginner’s guide to writing documentation](https://writethedocs.org/guide/writing/beginners-guide-to-docs) * [Crash Course in APIs for Technical Writers](https://medium.com/@patford12/crash-course-in-apis-for-technical-writers-694b274a2ad8) * [Technical Writing: What and How?](https://edidiongasikpo.com/technical-writing-what-and-how-ckastwm2705xq4us1l0cbvv2h) * [Write For Us: A List of Companies Who Pay Freelancers for Writing Tutorials](https://github.com/sixhobbits/technical-writing/blob/master/write-for-us.md) * [Technical Writing Books: A Curated Collection of Books to Help You Be a Better Technical Writer](https://github.com/sixhobbits/technical-writing/blob/master/resources.md) * [Everything Technical Writing: Tips and Techniques that'll Help You Thrive as a Technical Writer in the Software Industry](https://www.everythingtechnicalwriting.com) * [GitLab Technical Writing Fundamentals](https://about.gitlab.com/handbook/product/ux/technical-writing/fundamentals) * [AutoHotkey scripts for writing technical documentation](https://www.indoition.com/en/products/autohotkey-scripts-for-technical-documentation.htm) * [A Comprehensive Guide to Technical Writing](https://www.adoc-studio.app/blog/technical-writing-guide)
## Videos * [Content Creation Strategies: How To Create Content Online](https://www.youtube.com/watch?v=APQoWEqezFc) * [How to start a Coding YouTube channel (with tips from a bunch of successful creators!)](https://www.youtube.com/watch?v=AsTagX5tG4E) * [How To Start A Programming YouTube Channel With Coding Tutorials 360](https://www.youtube.com/watch?v=aeCRHv4XUPU) * [15 Technical Writing Tips](https://www.youtube.com/watch?v=Lw4TKCsIumQ) * [What is Technical Writing? | Writing Genre Fundamentals](https://www.youtube.com/watch?v=9SB4tfD0hxM) * [Meet Technical Writers at Google](https://www.youtube.com/watch?v=qnnkAWP55Ww) * [Technical Writing 101: Introduction to Technical Writing](https://www.youtube.com/watch?v=LTDsgd0ytbE&list=PL9RLbEIB-lv-bRTz14iEK4YSxRzxLQfdx) * [What do Technical Writers do? (Also, what is Technical Writing?)](https://www.youtube.com/watch?v=biocrCx5T_k) * [How to become a Technical Writer | Skills & Career Growth](https://www.youtube.com/watch?v=8l2KJXIBpB0) * [Writing technical documentation](https://www.youtube.com/watch?v=a4L9GhldTHo) * [Write The Docs Podcast & Meetups](https://www.youtube.com/channel/UCUI--N-VWjK93292AaaArCg) * [Write the Readable README](https://www.youtube.com/watch?v=2dAK42B7qtw) * [GitHub as a Landing Page](https://www.youtube.com/watch?v=fXMN4X9B8Rg&feature=youtu.be) * [Lessons Learned From Rebuilding a Developer Documentation Website](https://www.youtube.com/watch?v=s4kS-crtnlQ) * [A Balanced Diet of Documentation](https://www.youtube.com/watch?v=K-ACxb_Iy5k) * [Write your Docs like Nobody Reads Them](https://www.youtube.com/watch?v=ye-hCiJ5_Dg) * [The Developer's Guide to Technical Writing](https://drive.google.com/file/d/1a01iOLh_EYSTdukw_--mFJk-PD_IZXYh/view?fbclid=IwAR0D11PeXf_x4n8KlQJ2XCeY294QHyfnktrfk3cCW2VcSrTsh6zaYisLTqY) * [How to write technical blog posts](https://www.youtube.com/watch?v=YODPgBadj80) * [Technical Writing Portfolio](https://www.youtube.com/watch?v=68ddwfpXHrE) * [How to Document APIs Using Postman](https://youtu.be/d2WAKIKpKlE)
## Some Technical Writers to follow | Name | Link to Blog | Blog Niche | Link to Twitter | |-------------------|--------------------------------------------------------------------------|----------------------------------|-------------------------------------------------------| | Bolaji Ayodeji | https://blog.bolajiayodeji.com | Web/Data Engineering, JavaScript, Python, Machine Learning, and Ecommerce. | [@iambolajiayo](https://twitter.com/iambolajiayo) | | Angie Jones | https://angiejones.tech | Test Automation and Java. | [@techgirl1908](https://twitter.com/techgirl1908) | | Sarah Drasner | https://sarah.dev/writing | Web Development, Vuejs, and SVGs. | [@sarah_edo](https://twitter.com/sarah_edo) | | Prosper Otemuyiwa | https://medium.com/@unicodeveloper | All things Technical and Magical. | [@unicodeveloper](https://twitter.com/unicodeveloper) | | Ire Aderinokun | https://bitsofco.de | Frontend Development and JavaScript. | [@ireaderinokun](https://twitter.com/ireaderinokun) | | Tom Johnson | https://idratherbewriting.com | Technical Writing and API lessons. | [@tomjohnson](https://twitter.com/tomjohnson) | | Anne Gentle | https://justwriteclick.com | Doc as Code. | [@annegentle](https://twitter.com/annegentle) | | Kayce Basques | https://kayce.basqu.es/blog | Dev tools and Documentation. | [@kaycebasques](https://twitter.com/kaycebasques) | | Tania Rascia | https://taniarascia.com | Modern JavaScript, Node.js, and development. | [@taniarascia](https://twitter.com/taniarascia) | | SWYX | https://swyx.io/writing | Web Development, React and Tech. | [@swyx](https://twitter.com/swyx) | | Sean C Davis | https://cobwwweb.com/ | Web Development and Jamstack. | [@seancdavis29](https://twitter.com/seancdavis29) | | Alvaro Montoro | https://dev.to/alvaromontoro | CSS and HTML. | [@alvaro_montoro](https://twitter.com/alvaro_montoro) | | Linda Ikechukwu | https://everythingtechnicalwriting.com | Technical Writing and Developer Documentation. | [@_mslinda](https://twitter.com/_MsLinda)| | Amruta Ranade | https://www.youtube.com/c/AmrutaRanade | Technical Writing and Developer Documentation. | [@AmrutaRanade](https://twitter.com/AmrutaRanade) |
> [!TIP] > Check out my [blog](https://blog.bolajiayodeji.com), [newsletter](https://bawd.bolajiayodeji.com), or say hi on [X (Twitter)](https://x.com/iambolajiayo). ## Contributing ✨ Found an awesome resource, article, book, tool, video, technical writer, speaker deck, etc.? Please send in a pull request and follow the [contributors guidelines](/CONTRIBUTING.md). Thank you!
Bolaji Ayodeji
Bolaji Ayodeji

🖋 📖 🎨
prachford
prachford

📖
Jude J Obiejesi
Jude J Obiejesi

📖
Patrick Rachford
Patrick Rachford

📖
Didicodes
Didicodes

📖
browncrussell
browncrussell

📖
Gareth Dwyer
Gareth Dwyer

📖
Peter Thaleikis
Peter Thaleikis

📖
Genesis Gabiola
Genesis Gabiola

📖
Thomas Vaillant
Thomas Vaillant

📖
Rostyslav Sipakov
Rostyslav Sipakov

📖
Linda Ikechukwu
Linda Ikechukwu

📖
Sojin
Sojin

📖
Ezefizzy
Ezefizzy

👀
Colin Sheppard
Colin Sheppard

🐛
Bhupesh Varshney
Bhupesh Varshney

📖
DMoosh
DMoosh

📖
Boluwatife Victor
Boluwatife Victor

📖
neevcollege
neevcollege

📖
Marc Achtelig
Marc Achtelig

📖
Zion Ukpong
Zion Ukpong

📖
James
James

📖
suncloudsmoon
suncloudsmoon

📖
Konrad Talik
Konrad Talik

📖
MarvinBlome
MarvinBlome

📖
Leon Boshuizen
Leon Boshuizen

📖
Emeruche Ikenna Okpo
Emeruche Ikenna Okpo

📖
brimal-ekline
brimal-ekline

📖
Ondrej Machala
Ondrej Machala

📖
Hako
Hako

📖
CKMTools
CKMTools

📖
Kam
Kam

📖
Mohamed Abdallah
Mohamed Abdallah

📖
Michael Lip
Michael Lip

📖
alexander
alexander

📖
PariSh KhAn
PariSh KhAn

📖
Howard Park
Howard Park

📖
antydizajn
antydizajn

📖
Olayiwola Akinnagbe
Olayiwola Akinnagbe

📖
cser700
cser700

📖
Arthur
Arthur

📖
## License [Awesome Technical Writing](https://github.com/BolajiAyodeji/awesome-technical-writing) © 2019 by [Bolaji Ayodeji](https://bolajiayodeji.com) is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0) license.