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
- π 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).
Β Β Β 162βΒ Β Β Β 60π΄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 - Librato's RESTful API documentation. (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 (contributed by Rodney Keeling)
- π Underscore.js - Simple, clean, single page. (contributed by @twe4ked)
- π Qt - Very comprehensive documentation with tutorials and guides and great examples. (contributed by π @nikhilcutshort)
- π Savon.rb - (contributed by π Mathias Meyer)
- π Android Developer Documentation (contributed by π Rajeev N B @rBharshetty)
- π 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. (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)
- π Riak 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.
- π gevent API Docs - Clean, polished docs for gevent. (contributed by rubik)
- π 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)
- π Sonata Project - All the Sonata Project bundles for Symfony2 on a single page. These have a nice, clear layout. (contributed by @NoScopie)
- π Laravel - Easily-readable and well-organized docs. Navigation is well formatted and articles are easy to consume. (contributed by @ToddSmithSalter)
- π FullCalendar β Concise overview of all APIs on a single page, and in-depth descriptions for each. (contributed by
Β Β Β Β Β ?βΒ Β Β Β Β ?π΄@gr2m)) - π Rust Guides - Rust is a stable and memory-save language and the docs (written by Steve Klabnik) are clearly a high priority. The guides in particular illustrate core concepts of the standard library in a conversational, accessible style. (contributed by Nick Cox
- π MongoDB Manual - Easy to navigate, clean, carefully and well designed manual. (contributed by ericbn)
- π Mailgun Documentation - Email service for developers. Language selector, API code samples, editable in the browser, created with Sphinx. (contributed by @leemunroe)
- π Grav Documentation - Documentation for Grav, a modern open source flat-file CMS. Tightly integrated with GitHub in markdown format, with quick search and highlight. (contributed by π @rhuk)
- π Mailjet API guides - Great documentation with generated code samples using Slate from Tripit
- π Atlassian GIT Tutorials - Documentation and tutorials on Git. I like their layout. It is simple and focused on explaining the concepts with good diagrams, tutorials and glossary. (contributed by π @vaseehh)
- π Digital Ocean API Docs - These docs are stellar. Examples are abundant and the organization makes each component of the API easy to reason about. (contributed by @jasonaibrahim)
- π The LTTng Documentation - The whole documentation of the open source LTTng project on a single page (one page per project release). Features are: sparse style with pleasant colors, good information structure, auto-scrolling navigation, mobile-friendly, dedicated example boxes, glossary, tight integration with the π online man pages of the same version which are rendered with the same style.
Β Β Β Β 67βΒ Β Β Β 35π΄Source) is written in AsciiDoc (project's man pages too), with custom inline macros for specific features. (contributed by π @eepp) - π DocRaptor Covers HTML-to-PDF API language wrappers, styling instructions and core API docs.
- π Go Programming Language Docs - These docs are simple, well-organized, and effective. (contributed by Ed Bacher)
- π Sequelize - Simple, clear and well-structured docs with a complete Class Reference and listing of all public methods. (contributed by @bandantonio)
- π Vue.js Docs - The Progressive JavaScript Framework: An approachable, performant and versatile framework for building web user interfaces. (contributed by @jinjiang)
- π Posit Documentation - Clean, simple, and easy on the eyes. (contributed by @foxnic)
- π FastAPI - Python framework for building APIs with beautiful and complete documentation. (contributed by @jrwaine)
- π Circles, Sines and Signals - A Compact Primer on Digital Signal Processing. (contributed by @PharkMillups)
- π PostgreSQL - One of the most reliable sets of documentation available. There is rarely a need to go outside the documentation. (contributed by @dalryan)
- π 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)
- π Google Developer Documentation Style Guide - The best style guide I've seen since the Sun Style Guide. I'm agitating to get my team to replace the MMoS with this as the place to look for style guidance that doesn't exist in our team's style guide. (contributed by @carolinakinetic)
Β Β 8618βΒ Β 2143π΄API Blueprint) - A powerful high-level API description language for web APIs. (contributed by @PharkMillups)- π DiΓ‘taxis - A systematic framework for technical documentation authoring. (contributed by @matheusfelipeog)
- π docco - Pretty docs from source code comments with ports for many languages. (contributed by π @kylewest)
- π Sphinx - Comprehensive documentation tool using restructuredText with beautiful HTML and PDF output. (contributed by π @nikhilcutshort)
- π MkDocs - Documentation with Markdown, written in Python. (contributed by ericbn)
- π Read the Docs - Hosted docs using Sphinx or MkDocs, supports translations and finding docs for specific software versions. Used by the Django Docs. (contributed by Stephen Paulger)
- π ApiGen - Creates clean API documentation from PHP source code (contributed by bryceadams)
Β Β Β Β Β 5βΒ Β Β Β Β 8π΄docgenerator) - Organize your documentation in Markdown files. (contributed by Florian Margaine)- π dexy - Extensible documentation/report generator supporting multiple programming languages and several input and output formats. (contributed by troytop)
Β 35876βΒ 22020π΄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)
Β Β Β 628βΒ Β Β Β 92π΄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)
Β 26435βΒ Β 3797π΄GitBook) - Utility for generating documentation, books and exercises using GitHub/Git and Markdown. (contributed by Samy PessΓ©)- π Daux - A documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way. (contributed by veshinak)
Β Β Β Β 24βΒ Β Β Β Β 4π΄comment.js) - Simple API documentation generator. (contributed by @dciccale)- π phpDocumentor - phpDocumentor enables you to generate documentation from your PHP source code. (contributed by shivamdixit)
- π Hologram - Hologram is a Ruby gem that parses comments in your CSS and helps you turn them into a beautiful style guide. (contributed by @jchild3rs)
- π Middleman - Static site generator using all the shortcuts and tools in modern web development. (contributed by Sota Yamashtia)
Β Β 5768βΒ Β Β 483π΄documentation.js) - Generates documentation from JavaScript source code. (contributed by tmcw)- SassDoc - A Sass documentation generator that utilizes inline comments to make pretty and powerful docs. (contributed by Hugo Giraudel)
- π Pickles - Pickles is an open source living documentation generator that works on feature files written in the Gherkin language.
Β Β 9719βΒ Β 1684π΄ApiDoc) RESTful web API Documentation Generator that creates documentation from API descriptions in your source code. (contributed by Trenton Broughton)- π Documentation theme for Jekyll - Documentation theme built on Jekyll. Includes detailed notes on how to tackle nearly every technical documentation scenario, from single sourcing to conditional filtering, PDF output, relative links, and more.
- π JSDoc - Generate JavaScript API documentation directly from source code comments. Also useful as a style guide for JS commenting, in general. Google uses a version of JSDoc tags for its
Β Β Β Β Β ?βΒ Β Β Β Β ?π΄Closure compiler). - π Asciidoctor - Asciidoctor is a fast text processor and publishing toolchain for converting AsciiDoc content to HTML5, DocBook 5 (or 4.5) and other formats. (contributed by ThomasG77)
- π Bookdown - A open-source (GPL-3) R package to facilitate writing books and long-form articles/reports with R Markdown. Support for languages other than R, including C/C++, Python, and SQL, etc. (contributed by ThomasG77)
- π Pandoc If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Can generate documentation from most common markup languages. (contributed by ThomasG77)
- π LaTeX LaTeX is a typesetting system that has been around for almost 40 years and still very popular mostly in academia settings. Its strongest strength is in its capacity and flexibility in creating beautiful mathematical formulas. (contributed by Tao Li)
Β Β Β Β Β ?βΒ Β Β Β Β ?π΄gd2md-html) - gd2md-html is a free Google Docs add-on that converts a formatted Google Doc to a simple, readable Markdown or HTML text file. gd2md-html lets you use Google Docs' editing, formatting, and collaboration tools before you publish to a Markdown or HTML platform. (contributed by Ed Bacher)Β Β 2074βΒ Β Β 206π΄Documize) - One place to author, approve, publish documentation (contributed by HarveyKandola)- π ESDoc - Documentation generator for JavaScript. Similar to JSDoc, but provides more useful features and stylish look and feel. (contributed by @bandantonio)
- π Doxygen - Doxygen is the de facto standard tool for generating documentation from almost all popular programming languages. (contributed by @nocomplexity)
Β Β Β 103βΒ Β Β Β 33π΄Ignite) - Markdown documentation tool built around react components as first class plugins. Docs generateed using π bulma. (contributed by hipstersmoothie)- π Docusaurus - A project by Facebook for building, deploying, and maintaining open source project websites easily. Docusaurus currently provides support to help your website use translations, search, and versioning, along with some other special documentation markdown features. (contributed by akhildaphara)
- π Scramble - Scramble generates API documentation for Laravel project. Without requiring you to manually write PHPDoc annotations. (contributed by danie1net0)
- π VuePress - Vue-powered static site generator, simplicity first and performant. (contributed by matheusfelipeog)
- π VitePress - VitePress is a Static Site Generator designed for building fast, simple, powerful and content-centric websites. (contributed by matheusfelipeog)
- π Mintlify - Hosted docs using Markdown and MDX (contributed by arnehuang)
Β Β 8925β Β Β Β 596π΄ matheusfelipeog/beautiful-docs)