4. In Search of Lost Time 1,500,000
Infinite Jest 484,000
Django 360,000
New Testament 180,000
Your first manuscript 60,000
5. “The documentation and community are second to none.”
“[W]e’ve found that people …can get up-to-speed relatively
quickly thanks to the excellent documentation…”
“Django … provides an excellent developer experience, with
great documentation and tutorials…”
“Our initial choice … was based on the strength of the
Django community and documentation…”
“Productive development, good documentation, flexibility,
and it just works.”
http://j.mp/hnOsVl
11. First contact - new users.
Education - new & existing users.
12. First contact - new users.
Education - new & existing users.
Support - experienced users.
13. First contact - new users.
Education - new & existing users.
Support - experienced users.
Troubleshooting - annoyed users.
14. First contact - new users.
Education - new & existing users.
Support - experienced users.
Troubleshooting - annoyed users.
Internals - your fellow developers.
15. First contact - new users.
Education - new & existing users.
Support - experienced users.
Troubleshooting - annoyed users.
Internals - your fellow developers.
Reference - everyone.
25. “The code required to fix a problem… is an
essential part of a patch, but it is not the
only part. A good patch should also
include a regression test to validate the
behavior that has been fixed.”
26. “If the… patch adds a new feature, or
modifies behavior of an existing feature,
the patch should also contain
documentation.”
30. Tutorials
Quick - a new user should experience
success within 30 minutes.
Easy - help users feel epic win.
Not too easy - don’t sugar-coat the truth.
Show off how the project feels.
31. Topic guides
Conceptual - foster understanding,
not parroting.
Comprehensive - explain in detail.
Tell me the why of the topic.
51. Read the Docs Sign up
Create, host, and browse documentation.
or Log in
Read the Docs
What is this place?
Read the Docs hosts documentation, making it fully searchable and easy to find. You can import your docs
using any major version control system, including Mercurial, Git, Subversion, and Bazaar. It also supports
webhooks so your docs get built when you commit code. There's also support for versioning so you can build
http://readthedocs.org/
docs from tagged versions of your code in your repository. You can even create docs on the site. It's free and
simple. Read Getting Started and find out how to host your docs on Read the Docs!
Find a project
Let's do this.
Featured Projects
Celery (asksol) View Docs
