A curated list of awesome real-life documentation examples
Once upon a time, I set out to find a single awesome community-curated resource that provided great examples of docs available all over the web. I couldn't find one and neither could my friend, Justin. So I created one and you are welcome! That's how awesome-documentation began.
🎯 Each item is categorized according to sections. 👌 Focused on providing concrete examples & great inspiration to fellow documentarians. 📄 Some items feel they need to be there in other sections as well just because of how good they are but I want to keep duplicates to a minimum. 👂 Looking forward to any and all suggestions!
Each of the headings listed below corresponds to an actual section of documentation. Each heading contains examples of docs that are equal parts captivating, interesting, and inspiring for the readers. If the code for the documentation site is open-source, please do update it by putting a link right next to it.
- Getting Started
- Tutorials & Guides
- References
- Cookbooks
- API/SDK
- Neat ways of versioning the docs
- CLI
- Enterprise
- Great Discoverablity in Docs
- Keeping it Super Simple (KISS)
- Focus on Accessiblity (a11y)
- Focus on Internationalization (i18n)
- Changelog
- Others
🌟 The best of the best overall 🌟
- Gitlab - Gitlab's accurate docs coupled with the flow of information and scale they handle sets them apart to be a prime example for technical, non-technical as well as internal documentation. Their handbook, guides, tutorials are extremely well done. Look no further.
- Looking forward to reviewing & adding more to the list below, Hit me up!! or make a pull request of your own! It's all good!
- 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/
- Prisma Getting Started
- Create React App
- Gatsby tutorials
- DigitalOcean tutorials
- Twilio guides
- Repl.it tutorials
- Webflow tutorials - Special mention to the Webflow for the work they have put into their tutorials. These form a prime example of a quote I like which goes like.
The difference between good work and great work is just a little extra effort & attention to detail. Something as a documentarian we should always try to look out for.
- spaCy code examples as well as spaCy Guides
- Vercel Guides
- GitHub docs - Github Repository
- Need more suggestions, checkout issues and contribute yours.
Docs having pretty as heck, landing pages intelligently leaking details about the product, getting started, ways ahead, guides, maybe even their CLI, integrations, SDK, or API.
- Need more suggestions, checkout issues, and contribute yours.
- GatherContent
- Todoist changelogs
- Notion Changelogs - Incredible example of dogfooding.