awesome-documentation
github.com/pengqun/awesome-documentation ↗📃 A curated and up-to-date list of resources on software documentation templates, tools, guides, examples, etc.
Use this list with your AI agent
Add the Context Awesome MCP server to Claude, Cursor, or any MCP client, then ask:
"Show me code documentation resources from awesome-documentation"
Installation instructions →What's inside
Documentation Types
- 101 to 404s: How to write great error messagesCode Documentation
Even the shortest error message can evoke far stronger, negative emotions in your end users than the majority of your documentation.
- API ConsoleAPI Documentation
An interactive REST console based on RAML/OAS files.
- apiDocAPI Documentation
RESTful web API Documentation Generator.
- API Reference templateAPI Documentation
Open-source template provided by The Good Docs Project.
- arc42Architectural Documentation
Write, structure, visualize and manage software architecture documentation in a lean way using appropriate documentation tools, including arc42.
- A Step-by-Step Guide to Creating a Powerful Performance Summary ReportTest Documentation
Discuss the best practices for creating a performance test summary report and the key components that should be included in it, with a full example.
More Topics
- 9 Great API and Developer Documentation ExamplesExamples
Cover common areas of documentation, plus some areas you might not typically see called docs.
- AntoraFormats
A modular documentation site generator that helps you organize and publish content written in AsciiDoc to the web.
- AsciiDocFormats
A modular documentation site generator that helps you organize and publish content written in AsciiDoc to the web.
- AsciidoctorFormats
A fast, open source, Ruby-based text processor for parsing AsciiDoc and converting it to output formats such as HTML 5, DocBook 5, manual pages, PDF, EPUB 3, and other formats.
- Awesome Documentation | vipulgupta2048Examples
vipulgupta2048 - A curated list of awesome real-life documentation examples.
- Awesome Open Source DocumentsExamples
A curated list of awesome open source or open source licensed documents, guides, books.
General Tools
- AFFiNEKnowledge Base
A next-gen knowledge base that brings planning, sorting and creating all together.
- alexChecker & Formatter
Catch insensitive, inconsiderate writing.
- AnimockupMultimedia
A web-based tool that helps you create animated mockups for your product teasers.
- asciinemaMultimedia
A command-line tool for recording terminal sessions.
- Awesome GitHub WikisWiki Builder
A curated list of awesome GitHub Wikis, including examples, tips and tricks.
- bookdownSite Builder
Authoring Books and Technical Documents with R Markdown.
Showing a sample of 249 resources. View the full list on GitHub →