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: almost 2 years ago
awesomeawesome-listdocs

Awesome Docs / Accessibility

AXE-CLI428over 5 years ago
Contrastchecker
Image Alt text best practices
Lumberjack126over 3 years ago
Pa11y

Awesome Docs / AsciiDoc

Asciidoctor
AsciiDoc Alive
IntelliJ AsciiDoc Plugin
Asciidoc FX

Awesome Docs / API

API Guidelines
Bump.sh
Hoppscotch66,110almost 2 years ago
json-schema-sensitivity-checker2almost 3 years ago
oas
OpenAPI 3 CLI967almost 2 years ago
Optic
Postman
RapiDoc
Redoc-Editor14over 3 years ago
ReDoc
Restish
Speccy828over 3 years ago
Spectral
Stoplight Studio
Swagger
swaggerui83over 2 years ago
Tips for better documentation with OpenAPI
What we can learn from UX professionals when designing APIs
widdershins1,504over 2 years ago
Zalando RESTful API and Event Guidelines

Awesome Docs / Browser Extensions

Grammarly
LanguageTool

Awesome Docs / Browser Testing

Nightwatch.js
Playwright
Puppeteer89,083almost 2 years ago
Selenium

Awesome Docs / Editor

HackMD
Lapce34,785almost 2 years ago
Mark Text47,909about 2 years ago
Swimm
Visual Studio Code
Zed
Zettlr

Awesome Docs / Feedback

Papercups5,773over 2 years ago

Awesome Docs / GitHub Actions

Alex Action13almost 7 years ago
DOCtor-RST
Lighthouse CI Action1,186about 2 years ago
Run misspell with reviewdog
Spellcheck Action
TOC Generator225over 3 years ago
TODO to Issue Action642almost 2 years ago
Vale204almost 2 years ago

Awesome Docs / Hosting

Doctave
Docs by Hashnode
GitBook
Mintlify
Netlify
Read The Docs

Awesome Docs / Knowledge Base

Logseq
Obsidian

Awesome Docs / Mockup

Animockup1,657about 4 years ago
Excalidraw
Markmap

Awesome Docs / Quality Assurance

Alex4,823almost 2 years ago
brok425over 3 years ago
Capitalize My Title
case-police1,159almost 2 years ago
Doc Detective64almost 2 years ago
Harper
HtmlTest328over 2 years ago
InnovationEngine37almost 2 years ago
Linkspector70almost 2 years ago
lychee2,302almost 2 years ago
Readable
Rules example21almost 2 years ago
Swimm
Vale
Woke
Your automated tester

Awesome Docs / Reading

A Guide to Creating Personas
API Handyman
API Knowledge
Automating Your Accessibility Tests
Awesome Documentation43over 3 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
Editly4,805about 2 years ago
Kap18,175almost 2 years ago(macOS)
Peek10,332almost 2 years ago
Screenity13,064almost 2 years ago
Terminalizer15,431about 2 years ago

Awesome Docs / Screenshot

Carbon
Flameshot25,218almost 2 years ago
shot-scraper1,738almost 2 years 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
Docsite66about 2 years ago
Docz
Dokz
Gatsby Docs Kit126almost 2 years ago
Gridsome
Log4brains1,164almost 2 years ago
mdBook18,568almost 2 years ago
MDX-GO363over 6 years ago
MkDocs
Nextra12,002almost 2 years ago
Portray862about 3 years ago
Quartz7,529almost 2 years ago
RcPress193over 3 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 Plugin8about 4 years ago
pagefind

Awesome Docs / Site Generators / Sphinx Extensions

consoletest253about 2 years ago
Contentui13over 3 years ago
MyST
Sphinx Substitution Extensions39almost 2 years ago
sphinx-design

Awesome Docs / Site Generators / Sphinx Themes

Furo2,833almost 2 years ago
Sphinx Themes
The Sphinx Book Theme

Awesome Docs / Spelling

PySpelling

Awesome Docs / Style Guides

18F
Accessibility - MDN Web Docs
Accessible social media content
Aiven61over 2 years ago
Apple Style Guide
Atlassian
BBC
Buffer
CLI Guidelines
Container terminology
Datagrok
Developer Style Guide16over 2 years ago
DigitalOcean
Federal (US) plain language guidelines
GitHub16,507almost 2 years 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
Rackspace9about 2 years 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-tools4,688over 2 years ago
Awesome Design Tools34,281about 2 years ago
Bluehawk
Calculate max length for UI elements
Code Hike
CSS+JS Code snippets for enhancing online documentation
docToolchain755almost 2 years ago
D2 Declarative Diagramming
DIV Table Generator
Driver.js22,992almost 2 years ago
fixred35over 4 years ago
gatsby-theme-adr13over 2 years ago
Loom
Markdoc
markdown-doctest167almost 6 years ago
Merge Docs Pro
Penpot
Playwright67,755almost 2 years ago
Pocket Marketing List154about 3 years ago
readme.so
rstcheck229almost 2 years ago
rundoc
Shepherd13,069almost 2 years ago
Squoosh
Tables Generator
Tools for Technical Writers194almost 2 years ago
vendir
Writerside

Awesome Docs / User Behavior Analytics

Clarity

Awesome Docs / Viewer

Glow - Render Markdown on the CLI16,527almost 2 years ago
mdv16almost 3 years ago

Awesome Docs / Watching

SmartBear

Awesome Docs / Writing

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