pycon-2011--writing-great-documentation.json

{
  "alias": "video/403/pycon-2011--writing-great-documentation",
  "category": "PyCon US 2011",
  "copyright_text": "Creative Commons Attribution-NonCommercial-ShareAlike 3.0",
  "description": "Writing great documentation\n\nPresented by Jacob Kaplan-Moss\n\nDjango\u2019s among the best documented open source projects; I'm intensely\nproud of that accomplishment. If any part of Django endures, I hope\nit\u2019ll be a \u201cdocumentation culture\u201d \u2014 an ethos that values great,\nwell-written documentation. To that end, this talk looks at the tools,\ntips, and techniques I\u2019ve learned over the years. I hope it helps you\nwrite great documentation, too.\n\nAbstract\n\nThis talk looks at tips, tools, and techniques you can use to produce\ngreat technical documentation.\n\nIt's split roughly into two parts:\n\n-  Part 1: technique. We'll look at the structural elements that make\n   documentation useful: tutorials, high-level overviews, topical\n   guides, reference material, FAQs, and more. We'll cover some tips on\n   how to get documentation done, and community processes for handling\n   documentation in teams (open or not). We'll also talk about what I'm\n   calling \"Documentation Driven Development\" - a technique riffing off\n   Test Driven Development that calls for writing documentation before\n   code.\n-  Part 2: tools. Over the last couple of years a few fantastic tools\n   have sprung up that ease the technical aspects of writing\n   documentation. We'll talk about which tools are suitable for which\n   uses, and look at a handful of cool tools including\n   `Sphinx <http://sphinx.pocoo.org/>`__,\n   `Epydoc <http://epydoc.sourceforge.net/>`__, and\n   http://fitzgen.github.com/pycco/.\n\nThis talk is mostly targeted towards those documenting libraries or\nframeworks intended for use by other developers, but much of it probably\napplies to any sort of technical documentation.\n",
  "duration": null,
  "id": 403,
  "language": "eng",
  "quality_notes": "",
  "recorded": "2011-03-11",
  "related_urls": [
    "http://epydoc.sourceforge.net/",
    "http://fitzgen.github.com/pycco/.",
    "http://sphinx.pocoo.org/"
  ],
  "slug": "pycon-2011--writing-great-documentation",
  "speakers": [
    "Jacob Kaplan-Moss"
  ],
  "summary": "",
  "tags": [
    "docs",
    "documentation",
    "epydoc",
    "faqs",
    "pycco",
    "pycon",
    "pycon2011",
    "sphinx"
  ],
  "thumbnail_url": "https://archive.org/services/img/pyvideo_403___writing-great-documentation",
  "title": "Writing great documentation",
  "videos": [
    {
      "type": "archive.org",
      "url": "https://archive.org/details/pyvideo_403___writing-great-documentation"
    }
  ]
}