Write the Docs by James Bennett

Write the Docs by James Bennett

The greatest piece of software in the world is useless without great documentation, but unfortunately most of us just don't write great docs. This can be fixed, though. Documentation doesn't need to be an afterthought, and doesn't have to be bad, and you, too, can learn how to write good docs and make that an integrated part of your development process.

Afcfefa1f067d10bd021de0cc2e5e806?s=128

PyCon 2013

March 15, 2013
Tweet

Transcript

  1. 1.

    Write the Docs James Bennett · PyCon US 2013 Santa

    Clara, California Friday, March 15, 13
  2. 7.

    SLOTH FACTS • Can extract energy from low-nutrition food sources

    • Multi-part stomachs (up to a month to digest!) • Native to Central and South America Friday, March 15, 13
  3. 10.

    Happy users • Stay with you • Promote your software

    • Contribute to your software Friday, March 15, 13
  4. 11.

    0 25 50 75 100 Happy users Bad documentation Great

    documentation Friday, March 15, 13
  5. 18.

    Here’s some stuff • Tutorials • High-level overviews • Specific

    examples • API references • Topical guides • Downloadable samples • FAQs • In-depth guides • Contributing guides • Extension guides Friday, March 15, 13
  6. 21.

    New users • Assume nothing • Don’t bury them in

    details • Give plenty of care and feeding (definitions, explanations, examples) Friday, March 15, 13
  7. 22.

    Experienced users • Assume a few things • Include plenty

    of links and cross-references • Give practical examples Friday, March 15, 13
  8. 35.

    “If the implementation is easy to explain, it may be

    a good idea.” Friday, March 15, 13