All Projects → RichardLitt → awesome-docs

RichardLitt / awesome-docs

Licence: CC0-1.0 License
An awesome list of awesome documentation and documentation resources

awesome-docs Awesome

An awesome list of awesome documentation and documentation resources. Documentation is part of what makes a resource, and in particular APIs, awesome. There are many ways of making good documentation, but very few frameworks are good at being awesome. Let's find them and list them here.

Contributing

Here are instructions on how to to open a PR and submit a link to any list. For this list, please follow the general style below, and add a comment for any link you add explaining why it is awesome. Please alphabetize links, too.

Awesome Docs

  • Django The Django docs are a good example of "narrative" style docs, while having great coverage of features and APIs. - @tcg
  • Meteor Custom, easy to edit (the team is pretty responsive about editing their docs), and on the whole, quite comprehensive.
  • Stripe This is how docs should look. Absolutely well done.
  • Twilio The Twilio docs are extremely full featured, with interactive examples, and code samples in various languages. - @tcg

Documentation Resources

  • Documentationjs This looks fairly good, and is starting to mature. Their integrations look pretty fantastic, too. Only for js.
  • ExDoc ExDoc produces HTML and online documentation for Elixir projects. They are from my knowledge the best auto generated docs any language has. Example. ~@Dignifiedquire
  • Readme.io This company focuses on making your docs as beautiful as possible, and as easy as possible. They're responsive and I find that their examples are well thought out.
  • Swagger.io Brilliant resources to help make your in-code comments turn into beautiful docs by having an interoperable standard. A huge community has been built around them, too.
  • Write The Docs "Write the Docs is a place where the art and science of documentation can be practiced and appreciated. There are a lot of people out there who write docs, but there isn’t a good place to go to find information, ask questions, and generally be a member of a community of documentarians." Arguably the best resource for documentation, in general. - @RichardLitt

Articles about best practices

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].