A curated list of awesome real-life documentation examples
Once upon a time, I set out to find and share great examples of technical documentation over the web. But, couldn't find a single awesome community-curated resource that provided great examples of docs categoried according to their usecases. Well, look no further for the awesome-documenation list here! And, we are looking for even more examples.
Below, you can find the table of contents with each heading in the list corressponding to an actual section of the documentation. In each of the headings contains examples of documentation that is equal parts captivating, interesting and inspiring for the readers. If code for the repository is open-source, it would be linked right next to it.
- Getting Started
- Tutorials & Guides
- References
- Cookbooks
- API/SDK
- Neat ways of versioning the docs
- CLI
- Enterprise
- Great Discoverablity in Docs
- Focus on Accessiblity (a11y)
- Focus on Internationalization (i18n)
- Changelog
- Patterns & Best Practices
- Django Getting Started - https://github.com/django/django/tree/master/docs
- balena Getting Started - https://github.com/balena-io/docs
- Docker Getting Started - https://github.com/docker/docker.github.io/
- Need more suggestions, checkout issues and contribute yours.
- Stripe API Reference
- GitHub REST API Docs
- Need more suggestions, checkout issues and contribute yours.
- GitHub docs - Github Repository
- Need more suggestions, checkout issues and contribute yours.
- Need more suggestions, checkout issues and contribute yours.
- Need more suggestions, checkout issues and contribute yours.
- Need more suggestions, checkout issues and contribute yours.
- Need more suggestions, checkout issues and contribute yours.
- Need more suggestions, checkout issues and contribute yours.
- Need more suggestions, checkout issues and contribute yours.