BolajiAyodeji / repository

awesome-technical-writing

:books: A curated list of awesome resources: articles, books, videos, tools, podcasts about technical writing.

#awesome-list#content#documentation#open-source#resources#technical-writing

View Repository on GitHub ↗

REPOSITORY OVERVIEW

Live repository statistics

★ 2.3KStars

⑂ 365Forks

◯ 17Open issues

◉ 2.3KWatchers

README preview

Awesome Technical Writing

README image

This list is inspired by the awesome and 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

Community

Courses

Books

Docs for Developers: An Engineer’s Field Guide to Technical Writing by Jared Bhatti, Zach Corleissen, Jen Lambourne, David Nuñez, and Heidi Waterhouse.
The Developer's Guide to Content Creation by Stephanie Morillo.
The Developer's Guide to Creating a Successful Blog by Flavio Copes.
Everybody Writes: Your New and Improved Go-To Guide to Creating Ridiculously Good Content by Ann Handley.
Technical Writing for Dummies by Sheryl Lindsell-Roberts.
The Handbook of Technical Writing by Gerald J. Alre, Walter E. Oliu, and Charles T. Brusaw.
How To Write Usable User Documentation by Edmond H. Weiss.
Letting Go of the Words: Writing Web Content that Works by Janice Redish.
Docs Like Code: Collaborate and Automate to Improve Technical Documentation by Anne Gentle.
The Product is Docs: Writing Technical Documentation in a Product Development Group by Christopher Gales and Splunk Documentation Team.
Every Page Is Page One: Topic-Based Writing for Technical Communication and the Web by Mark Baker.
Modern Technical Writing: An Introduction to Software by Andrew Etter.
Software Technical Writing: A Guidebook by James Gallagher.

Style Guides

Useful Tools

Technical Writing Template - A sample template with guidelines for writing technical articles.
Paid Community Writer Programs - A list of companies that have paid developer community writer programs.
Who Pays Technical Writers? - A curated collection of active publishers, publications, and agencies that pay fair rates for high-quality technical content.
Diátaxis Documentation System - A systematic approach to creating better documentation.
HackMD - Real-time collaboration on technical documentation in markdown.
Dropbox Paper - A flexible workspace for collaborative document-editing.
Google Docs - Smart editing and styling tools to help you easily format text and paragraphs.
Notion - The all-in-one workspace for your notes, tasks, wikis and databases.
Notion AI - Leverage the limitless power of AI in any Notion page, write faster and augment your creativity.
Grammarly - a writing assistant that goes deeper than grammar to offer you comprehensive writing feedback.
Canva - A graphic design platform that allows you to create social media graphics and other visual content.
TinyPNG - Smart PNG and JPEG image compression.
Full Page Screen Capture - The simplest way to take a full page screenshot of your current browser window.
Awesome Screenshot: Screen Video Recorder - Screen Capture full page screenshot and recorder for screencast.
Readme Markdown Generator - CLI that generates beautiful README.md files.

Resources

Capture to a Gif - Record content of pages to an animated gif picture from browser.

Microsoft Word - Spelling, grammar, and intelligent suggestions to assist you across documents, email, and on the web.

Log4brains - Docs-as-code knowledge base to manage Architecture Decision Records (ADR) for your project and publish them automatically as a static website.

Antidote - The corrector analyses your text and flags any detections.

LanguageTool - Open-source writing assistant, an alternative to Grammarly.

HemingwayApp - Hemingway App makes your writing bold and clear. Helps fix long & complex sentences.

ChatGPT - A conversational chatbot that can generate human-like responses to natural language prompts.

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 - adoc Studio is an integrated writing environment for structured texts using AsciiDoc.

Crosspost - 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 - Screenshot automation for documentation with a visual element picker and theme-aware output.

EkLine - Documentation quality automation. Enforces style guides on PRs, validates links, flags outdated content, and helps draft new docs.

Technical Writing: Why and How?

[Minimalist Approa