PharkMillups/beautiful-docs

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.

Mark

And Now For The Docs (in no particular order)

• 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.
• BrightBox Developer Docs - Clean design, easy to navigate, very in-depth.
• GitHub Developer Docs - I don't always get excited about accordion-based navigation, but when I do...
• Dropwizard - Beautiful and concise; another Bootstrap joint. (Coda Hale's Metrics Library uses the same design and is equally as deserving of developer adoration (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.)
• CoreOS Primary-colored goodness and a distributed system to boot (contributed by @lucperkins)
• Django Documentation (contributed by @bretthoerner)
• Erldocs.com (contributed by @bradfordw)
• 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)
• Pow Annotated Source - Built with docco. (contributed by @BonzoESC)
• 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 - Librato's RESTful API documentation. (contributed by @josephruscio)
• CoffeeScript (contributed by @joedevivo)
• Why's (Poignant) Guide to Ruby (contributed by @joedevivo)
• A Beginner's Guide To HTML and CSS
• Twitter Bootstrap and v2 - 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 Library (contributed by @davidmatas)
• Brighter Planet API along with live examples, methodology statements for calculations, and calculation methodology source narratives (contributed by Derek Kastner)
• Symfony2 Docs (contributed by Rodney Keeling)
• Ruby on Rails Tutorial (contributed by Paul Stefen Ort)
• Pyramid Documentation (contributed by csenger)
• Number Laundry API - Fun design, simple examples. (contributed by @jmhobbs)
• Backbone.js and Underscore.js - Simple, clean, single page. (contributed by @twe4ked)
• Qt - Very comprehensive documentation with tutorials and guides and great examples. (contributed by @nikhilcutshort)
• CasperJS - CasperJS is a navigation scripting & testing utility for PhantomJS, written in Javascript. (contributed by @n1k0)
• Leaflet - Simple and elegant single page docs. (contributed by @mourner)
• rubyamqp.info - A number of in-depth guides that cover Ruby amqp gem but also try to explain AMQP 0.9.1 features, why they exist and how they are supposed to be used. (contributed by Michael Klishin)
• Savon.rb (contributed by Mathias Meyer)
• Mozilla Developer Networks (contributed by Rajeev N B @rBharshetty)
• Android Developer Documentation (contributed by Rajeev N B @rBharshetty)
• ØMQ - The Guide - Exciting documentation for an exciting lib. Concise working code examples available in multiple languages. Concepts are explained clearly. (contributed by kindkid)
• Postmark Developer Docs - Simple, easy to navigate, informative.
• Twitter Developers Docs - In-depth and very well organized. (contributed by @tsantero)
• GitHub Styleguide - Pragmatic styleguide with sections on Ruby, JavaScript and CSS. By the guys at @github (contributed by @lenary)
• Moment.js - Thorough, well-designed, and excellent use of top-nav. (contributed by @joshuapoehls)
• Solarized - Beautiful documentation about a color scheme, using the color scheme from Ethan Schoonover. (contributed by @seancribbs)
• Ember.js - The overall navigation could be done a bit better but the presentation and readability is quite nice. (contributed by @cmeik)
• DotCloud Platform Docs - Responsive, focused, simple, and all-around useable.
• Mashape API Docs - Clean auto-generated documentations for APIs
• Basho Docs - Well-designed, excellent use of versioning, integrated search, and much more.
• Go By Example - Clean, simple, and extensive. These docs that make you want to learn Go just because they make it so straightforward.
• 99s Ranch User Guide - Pretty clear and thorough user guide. (contributed by @lenary)
• gevent API Docs - Clean, polished docs for gevent. (contributed by rubik)
• httpkit - I dare you to tell me these docs aren't straight sex.
• CodernityDB - Clean, extensive, useful. I also love the fact that the day the software was released the documentation was this extensive.
• Riemann - Great design, easy to read, and very thorough with introductory and advanced topics.
• Pretty RFC - Reworked IETF documents for easier viewing.
• Vagrant - Well organized, easy to read, attractive design. (@clstokes)
• Wolfram Language - Nice top-level navigation in a grid layout. Topics grouped by color, each with a relevant graphic and on-click menu of sub-topics. (contributed by troytop)
• Lisp Flavored Erlang: Quick Start - Attractive presentation, nice jumpstart for the language. (contributed by @macintux)
• Thinking Forth - Forth is now largely eclipsed by Factor, but the book remains an inspiring look at the ideas behind this stack-based language. (contributed by @macintux)
• Packer Documentation - These are just lovely.
• Abjad: Modeling Music in Python - Clean styling, and impressive integration of figures and diagrams. (contributed by @adorsk)
• SqlAlchemy - One of the most comprehensive pieces of documentation I've ever seen, with excellent linking and layout. (contributed by @adorsk)

Writing about Docs (again, in no particular order)

• Designing Great API Docs - Blog post by @jamesyu about what he/Parse finds essential in API Docs. (contributed by @hobbyist)
• TomDoc - A specification for Ruby library API docs by @mojombo (contributed by @lenary)
• Write the Docs - A conference for authors of technical documentation. (contributed by @macintux)
• Writing Great Documentation - Covers a variety of topics relating to writing good documentation such as content, style, formatting and so on. (contributed by Paul A. Wilson

Generating Docs

• docco - Pretty docs from source code comments with ports for many languages. (contributed by @kylewest)
• DocumentUp - Instantly beautify your Github repositories' README.md. (contributed by @kylewest)
• Sphinx - Comprehensive documentation tool using restructuredText with beautiful HTML and PDF output. (contributed by @nikhilcutshort)
• dr.js - Tiny JavaScript documentation generator from the author of RaphaëlJS. (contributed by @nikhilcutshort)
• Markdoc - Lightweight documentation/wiki generator in Python, released in the public domain. (contributed by Neelfyn)
• ApiGen - Creates clean API documentation from PHP source code (contributed by bryceadams)
• docgenerator - Organize your documentation in Markdown files. (contributed by Florian Margaine)
• dexy - Extensible documentation/report generator supporting multiple programming languages and serveral input and output formats. (contributed by troytop)
• Slate - Static API documentation creation tool from the team at Tripit.
• MireDot - REST API documentation generator for Java. Plugs into your build process and generates a searchable html page. (contributed by bertvh)
• codo - CoffeeScript API documentation generator, similar to YARD. (contributed by Logan Koester)
• Flatdoc - Create well designed open source documentation from Github repository README files or simple Markdown files. (contributed by @moore)
• GitBook - Utility for generating documentation, books and exercises using GitHub/Git and Markdown. (contributed by Samy Pessé)