matheusfelipeog /beautiful-docs

Pointers to useful, well-written, and otherwise beautiful documentation.

★ 9,556⑂ 602👁 228⑃ 151● 34▤ 0
MITCreated 2012-01-04
+1
Daily
9,556
stars
602
forks
228
watchers
151
prs
34
issues
0
releases

README

Beautiful Docs

I love documentation. If you work with/are writing code intended for usage and consumption by more than one person, you should love it, too. Documentation and other resources will make or break the success of your project. And the more open and collaborative you want development to be, the more crucial docs become.

With that in mind, here's a list of docs and other developer resources that myself and others find particularly useful, well-written, and otherwise "beautiful." May they serve to inspire you when writing and designing yours. Thanks to various contributors, we now also have sections dedicated to Writing about Documentation and Tools for Generating Docs.

This should be updated fairly regularly. As usual, pull requests are encouraged. 
 If you're contributing a link, be sure to include a few words on why you're adding it and some sort of self-attribution so that people can know from whom it came.
 All docs are listed in the order they were added. Keep this order when submitting your PR. 

Mark

 And Now For The Docs 

 Redis Commands - Most of the Redis docs are exceptional, but this section really epitomizes the combination of good design and usability. And all the individual command pages give you the ability to test things out without leaving the page. Pretty close to perfect.
 GitHub Developer Docs - I don't always get excited about accordion-based navigation, but when I do...
 Dropwizard - Beautiful and concise; another Bootstrap joint. (contributed by mrtazz).
 Riak Pipe README - The simplicity of READMEs means that you can't obscure shitty content with flashy design. This one is written by my Basho colleague Bryan Fink and should be committed to memory as an excellent example of how to write READMEs.
 Learn You Some Erlang (contributed by @lenary) (It should also be noted that LYSE was inspired by Miran Lipovača's Learn You A Haskell.)
 Django Documentation - (contributed by @bretthoerner)
 Clojuredocs.org (contributed by @mrb_bk)
 FreeBSD Handbook - Clean and direct documentation of an OS. (contributed by @mrtazz)
 Ruby on Rails Guides - (contributed by @seancribbs)
 Stripe Documentation and Full API Documentation - Multiple languages, example code, good detail on the API; especially love how the API docs show examples for curl and their supported client libraries. (contributed simultaneously by @tnm and @technoweenie)
 Librato Developer Docs (archived) - Archived REST API documentation preserved after the original URL became a product-retirement page. (contributed by @josephruscio)
 CoffeeScript - (contributed by @joedevivo)
 Why's (Poignant) Guide to Ruby - (contributed by @joedevivo)
 Twitter Bootstrap - Documented the project using the project. (contributed by @kylewest)
 hogan.js - Simple and Beautiful. (contributed by @kylewest)
 Scala Documentation - Beautifully-styled Scala documentation site. (Contributed by David M. Lee)
 Linode Guides and Tutorials (contributed by @davidmatas)
 Symfony Docs (contribute

Top issues

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON