awesome-docs

Documentation toolkit

A curated list of tools and best practices for documentation in software development

A curated list of awesome documentation tools

GitHub

574 stars
16 watching
46 forks
last commit: 3 months ago
awesomeawesome-listdocs

Awesome Docs / Accessibility

AXE-CLI 428 almost 4 years ago
Contrastchecker
Image Alt text best practices
Lumberjack 126 almost 2 years ago
Pa11y

Awesome Docs / AsciiDoc

Asciidoctor
AsciiDoc Alive
IntelliJ AsciiDoc Plugin
Asciidoc FX

Awesome Docs / API

API Guidelines
Bump.sh
Hoppscotch 66,110 2 months ago
json-schema-sensitivity-checker 2 over 1 year ago
oas
OpenAPI 3 CLI 967 2 months ago
Optic
Postman
RapiDoc
Redoc-Editor 14 about 2 years ago
ReDoc
Restish
Speccy 828 about 2 years ago
Spectral
Stoplight Studio
Swagger
swaggerui 83 10 months ago
Tips for better documentation with OpenAPI
What we can learn from UX professionals when designing APIs
widdershins 1,504 9 months ago
Zalando RESTful API and Event Guidelines

Awesome Docs / Browser Extensions

Grammarly
LanguageTool

Awesome Docs / Browser Testing

Nightwatch.js
Playwright
Puppeteer 89,083 2 months ago
Selenium

Awesome Docs / Editor

HackMD
Lapce 34,785 2 months ago
Mark Text 47,909 6 months ago
Swimm
Visual Studio Code
Zed
Zettlr

Awesome Docs / Feedback

Papercups 5,773 about 1 year ago

Awesome Docs / GitHub Actions

Alex Action 13 over 5 years ago
DOCtor-RST
Lighthouse CI Action 1,186 7 months ago
Run misspell with reviewdog
Spellcheck Action
TOC Generator 225 almost 2 years ago
TODO to Issue Action 642 2 months ago
Vale 204 3 months ago

Awesome Docs / Hosting

Doctave
Docs by Hashnode
GitBook
Mintlify
Netlify
Read The Docs

Awesome Docs / Knowledge Base

Logseq
Obsidian

Awesome Docs / Mockup

Animockup 1,657 over 2 years ago
Excalidraw
Markmap

Awesome Docs / Quality Assurance

Alex 4,823 3 months ago
brok 425 almost 2 years ago
Capitalize My Title
case-police 1,159 3 months ago
Doc Detective 64 4 months ago
Harper
HtmlTest 328 10 months ago
InnovationEngine 37 3 months ago
Linkspector 70 2 months ago
lychee 2,302 2 months ago
Readable
Rules example 21 2 months ago
Swimm
Vale
Woke
Your automated tester

Awesome Docs / Reading

A Guide to Creating Personas
API Handyman
API Knowledge
Automating Your Accessibility Tests
Awesome Documentation 43 almost 2 years ago
Become a better writer as a developer
Become a technical writer
Document Like a Scientist
Free Resources to Learn Technical Writing
Google - Technical Writing Courses
Grammarly Blog
Great Developer Documentation Examples
How Google, Twitter, and Spotify built a culture of documentation
How to write technical posts
Let's Get Intentional About Documentation
Mastering cURL
Maybe it’s time we re-think docs
Scottydocs.com
Semantic Line Breaks
Setting up the alex.js language linter in your project
Systematic approach to technical documentation authoring
Technical Documentation in Software Development
Technical Documentation Tool and Web Guide
User Guide Template
What nobody tells you about documentation
Why does inclusive language matter
Write good examples by starting with real code
Writing great documentation
Writing Technical Stuff for Non-Technical Readers

Awesome Docs / Screencast

Asciinema
Codio
Editly 4,805 7 months ago
Kap 18,175 3 months ago (macOS)
Peek 10,332 2 months ago
Screenity 13,064 3 months ago
Terminalizer 15,431 6 months ago

Awesome Docs / Screenshot

Carbon
Flameshot 25,218 3 months ago
shot-scraper 1,738 5 months ago
Shottr

Awesome Docs / Site Generators

11ty
Antora
Astro

Awesome Docs / Site Generators / Astro

Starlight

Awesome Docs / Site Generators

Document Node
Docus
Docusaurus
DocFX
Docsify
Docsite 66 6 months ago
Docz
Dokz
Gatsby Docs Kit 126 2 months ago
Gridsome
Log4brains 1,164 2 months ago
mdBook 18,568 3 months ago
MDX-GO 363 about 5 years ago
MkDocs
Nextra 12,002 2 months ago
Portray 862 over 1 year ago
Quartz 7,529 2 months ago
RcPress 193 about 2 years ago
Sphinx
VuePress
Zola

Awesome Docs / Site Generators / Docsify Extensions

docsify-themeable

Awesome Docs / Site Generators / Hugo Extensions

Hugo modules

Awesome Docs / Site Generators / MkDocs Extensions

Material for MkDocs
Tooltipster Links Plugin 8 over 2 years ago
pagefind

Awesome Docs / Site Generators / Sphinx Extensions

consoletest 253 6 months ago
Contentui 13 about 2 years ago
MyST
Sphinx Substitution Extensions 39 2 months ago
sphinx-design

Awesome Docs / Site Generators / Sphinx Themes

Furo 2,833 2 months ago
Sphinx Themes
The Sphinx Book Theme

Awesome Docs / Spelling

PySpelling

Awesome Docs / Style Guides

18F
Accessibility - MDN Web Docs
Accessible social media content
Aiven 61 about 1 year ago
Apple Style Guide
Atlassian
BBC
Buffer
CLI Guidelines
Container terminology
Datagrok
Developer Style Guide 16 about 1 year ago
DigitalOcean
Federal (US) plain language guidelines
GitHub 16,507 2 months ago
GitLab
Google
Guidelines for Inclusive Language
Human words for technical docs
Linode
Mailchimp
Markdown Guide
Michigan State University
Microsoft
MongoDB
Monzo
NC State University - IT Accessibility Handbook
Rackspace 9 8 months ago
Red Hat Guidelines
Red Hat Style Guide
Salesforce
Shopify
Splunk
Sprout
SUSE
The essential guide to conscious language
The Writer
United Nations
Web Content Accessibility Guidelines
Website Style Guide Resources
Write The Docs

Awesome Docs / Tool Collection

adr-tools 4,688 10 months ago
Awesome Design Tools 34,281 7 months ago
Bluehawk
Calculate max length for UI elements
Code Hike
CSS+JS Code snippets for enhancing online documentation
docToolchain 755 2 months ago
D2 Declarative Diagramming
DIV Table Generator
Driver.js 22,992 4 months ago
fixred 35 over 2 years ago
gatsby-theme-adr 13 10 months ago
Loom
Markdoc
markdown-doctest 167 over 4 years ago
Merge Docs Pro
Penpot
Playwright 67,755 2 months ago
Pocket Marketing List 154 over 1 year ago
readme.so
rstcheck 229 2 months ago
rundoc
Shepherd 13,069 2 months ago
Squoosh
Tables Generator
Tools for Technical Writers 194 3 months ago
vendir
Writerside

Awesome Docs / User Behavior Analytics

Clarity

Awesome Docs / Viewer

Glow - Render Markdown on the CLI 16,527 3 months ago
mdv 16 over 1 year ago

Awesome Docs / Watching

SmartBear

Awesome Docs / Writing

How to write a basic how-to
How to write a README
Words matter