awesome-docs

Awesome Docs

A curated list of awesome documentation tools, guides and good practice.

If you see a package or project here that is no longer maintained or is not a good fit, please submit a pull request to improve this file. Thank you!

Contributing

Please take a quick gander at the contribution guidelines first.

Thanks to all contributors; you rock!

Contents

• Accessibility
• AsciiDoc
• API
• Browser Extensions
• Browser Testing
• Editor
• Feedback
• GitHub Actions
• Hosting
• Knowledge Base
• Mockup
• Quality Assurance
• Reading
• Screencast
• Screenshot
• Site Generators
  • Docsify Extensions
  • Hugo Extensions
  • MkDocs Extensions
  • Search
  • Sphinx Extensions
  • Sphinx Themes
• Spelling
• Style Guides
• Tool Collection
• User Behavior Analytics
• Viewer
• Watching
• Writing

Accessibility

• AXE-CLI
• Contrastchecker
• Image Alt text best practices
• Lumberjack
• Pa11y

AsciiDoc

• Asciidoctor
• AsciiDoc Alive
• IntelliJ AsciiDoc Plugin
• Asciidoc FX

API

• API Guidelines
• Bump.sh
• Hoppscotch
• json-schema-sensitivity-checker
• oas
• OpenAPI 3 CLI
• Optic
• Postman
• RapiDoc
• Redoc-Editor
• ReDoc
• Restish
• Speccy
• Spectral
• Stoplight Studio
• Swagger
• swaggerui
• Tips for better documentation with OpenAPI
• What we can learn from UX professionals when designing APIs
• widdershins
• Zalando RESTful API and Event Guidelines

Browser Extensions

• Grammarly
• LanguageTool

Browser Testing

• Nightwatch.js
• Playwright
• Puppeteer
• Selenium

Editor

• HackMD
• Lapce
• Mark Text
• Swimm
• Visual Studio Code
• Zed
• Zettlr

Feedback

• Papercups

GitHub Actions

• Alex Action
• DOCtor-RST
• Lighthouse CI Action
• Run misspell with reviewdog
• Spellcheck Action
• TOC Generator
• TODO to Issue Action
• Vale

Hosting

• Doctave
• Docs by Hashnode
• GitBook
• Mintlify
• Netlify
• Read The Docs

Knowledge Base

• Logseq
• Obsidian

Mockup

• Animockup
• Excalidraw
• Markmap

Quality Assurance

• Alex
• brok
• Capitalize My Title
• case-police
• Doc Detective
• Harper
• HtmlTest
• InnovationEngine
• Linkspector
• lychee
• Readable
• Rules example
• Swimm
• Vale
• Woke
• Your automated tester

Reading

• A Guide to Creating Personas
• API Handyman
• API Knowledge
• Automating Your Accessibility Tests
• Awesome Documentation
• 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

Screencast

• Asciinema
• Codio
• Editly
• Kap (macOS)
• Peek
• Screenity
• Terminalizer

Screenshot

• Carbon
• Flameshot
• shot-scraper
• Shottr

Site Generators

• 11ty
• Antora
• Astro
  • Starlight
• Document Node
• Docus
• Docusaurus
• DocFX
• Docsify
• Docsite
• Docz
• Dokz
• Gatsby Docs Kit
• Gridsome
• Log4brains
• mdBook
• MDX-GO
• MkDocs
• Nextra
• Portray
• Quartz
• RcPress
• Sphinx
• VuePress
• Zola

Docsify Extensions

• docsify-themeable

Hugo Extensions

• Hugo modules

MkDocs Extensions

• Material for MkDocs
• Tooltipster Links Plugin

Search

• pagefind

Sphinx Extensions

• consoletest
• Contentui
• MyST
• Sphinx Substitution Extensions
• sphinx-design

Sphinx Themes

• Furo
• Sphinx Themes
• The Sphinx Book Theme

Spelling

• PySpelling

Style Guides

• 18F
• Accessibility - MDN Web Docs
• Accessible social media content
• Aiven
• Apple Style Guide
• Atlassian
• BBC
• Buffer
• CLI Guidelines
• Container terminology
• Datagrok
• Developer Style Guide
• DigitalOcean
• Federal (US) plain language guidelines
• GitHub
• 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
• 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

Tool Collection

• adr-tools
• Awesome Design Tools
• Bluehawk
• Calculate max length for UI elements
• Code Hike
• CSS+JS Code snippets for enhancing online documentation
• docToolchain
• D2 Declarative Diagramming
• DIV Table Generator
• Driver.js
• fixred
• gatsby-theme-adr
• Loom
• Markdoc
• markdown-doctest
• Merge Docs Pro
• Penpot
• Playwright
• Pocket Marketing List
• readme.so
• rstcheck
• rundoc
• Shepherd
• Squoosh
• Tables Generator
• Tools for Technical Writers
• vendir
• Writerside

User Behavior Analytics

• Clarity

Viewer

• Glow - Render Markdown on the CLI
• mdv

Watching

• SmartBear

Writing

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

This site is open source. Improve this page.