The Wayback Machine - https://web.archive.org/web/20201116192445/https://github.com/vipulgupta2048/awesome-documentation
Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 

README.md

Awesome Documentation Awesome

A curated list of awesome real-life documentation examples

GitHub issues CC-0 license Open Source Love png1 HitCount

About

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.

Table of Contents


Getting Started

Tutorials & Guides

References

Cookbooks

  • Need more suggestions, checkout issues and contribute yours.

API/SDK

Neat ways of versioning the docs

CLI

Enterprise

  • Need more suggestions, checkout issues and contribute yours.

Great Discoverablity in Docs

  • Need more suggestions, checkout issues and contribute yours.

Focus on Accessiblity (a11y)

  • Need more suggestions, checkout issues and contribute yours.

Focus on Internationalization (i18n)

  • Need more suggestions, checkout issues and contribute yours.

Changelog

Patterns & Best Practices

  • Need more suggestions, checkout issues and contribute yours.

Releases

No releases published
You can’t perform that action at this time.