Skip to main content

Writing Documentation that Satisfies Your Users

Sarah White (Asciidoctor, OpenDevise)
Average rating: ***..
(3.75, 8 ratings)
Slides:   external link

Documentation is paramount to increasing an open source project’s adoption and growth. Planning and writing documentation for a variety of users and taking into consideration their needs, backgrounds, and environments can quickly become complex and feel overwhelming. Using examples from new and mature open source projects, we’ll explore strategies and steps you can use to plan, organize, write and improve your documentation.

  • Determine your project’s audiences
  • Select and prioritize the types of documentation each audience needs
  • Outline and write the text
  • Brainstorm and create useful and interesting examples
  • Gather feedback and incorporate it into the documentation
  • Use the documentation to improve your project
Photo of Sarah White

Sarah White

Asciidoctor, OpenDevise

Sarah is the co-founder of OpenDevise. She’s passionate about helping open source projects find practical yet fun ways to communicate with their users and contributors.

Long ago, in a not-too-distant galaxy, she assessed hazardous waste sites and tracked pesticide routes through watersheds. So she knows a thing or two about identifying and eradicating stuff that kills projects, including poor documentation.

Comments on this page are now closed.

Comments

Picture of Sarah White
07/23/2014 4:33pm PDT

FYI, this talk is going to be as tool agnostic as possible. If you’re interested in learning more about the Asciidoctor project itself, come to the Asciidoctor BOF on Wednesday, the 24th, at 8pm (see the on-site board for the room number).