mirror of
https://github.com/testthedocs/awesome-docs.git
synced 2026-07-16 06:12:41 -05:00
0f86629cd3
Created comprehensive pages for all sections referenced in navigation: - writing.md: Writing tools, editors, knowledge bases, mockup tools, screenshots, screencasts, and learning resources - style-guides.md: Complete collection of style guides from government, tech companies, and specialized domains - reading.md: Essential articles, guides, and resources organized by topic (strategy, skills, APIs, UX, accessibility, etc.) - github-actions.md: GitHub Actions for documentation validation, content generation, and quality assurance with workflow examples - tools.md: Additional specialized tools covering AsciiDoc, browser testing, accessibility, hosting, utilities, and analytics Updated VitePress config: - Added all new pages to navigation menus - Organized tools into logical categories - Fixed 404 errors for previously missing routes Content migration status: - All major sections from README.md now have dedicated pages - Navigation links properly connected to existing content - Structured content with clear categories and descriptions - Cross-references between related sections This completes the content migration from the original README.md structure to a comprehensive VitePress documentation site.
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
- Spelling
- Style Guides
- Tool Collection
- User Behavior Analytics
- Viewer
- Watching
- Writing
Accessibility
AsciiDoc
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
Browser Testing
Editor
Feedback
GitHub Actions
- Alex Action
- DOCtor-RST
- Lighthouse CI Action
- Run misspell with reviewdog
- Spellcheck Action
- TOC Generator
- TODO to Issue Action
- Vale
Hosting
Knowledge Base
Mockup
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
- A simple technique for evaluating content
- An examination of translating text to make it as accessible as possible
- 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
- Documentation That Developers Actually Read: The Netflix Approach
- 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
- Where to start with analytics for 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
Screenshot
Site Generators
- 11ty
- Antora
- Astro
- Document Node
- Docus
- Docusaurus
- DocFX
- Docsify
- Docsite
- Dokz
- Fumadocs
- Gatsby Docs Kit
- Gridsome
- Log4brains
- mdBook
- MDX-GO
- MkDocs
- Nextra
- Portray
- Quartz
- RcPress
- Sphinx
- VitePress
- Vocs
- VuePress
- xyd
- Zola
Docsify Extensions
Hugo Extensions
MkDocs Extensions
Search
Sphinx Extensions
Sphinx Themes
Spelling
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
- 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