Skip to main content

Writing Documentation that Satisfies Your Users

Sarah White (Asciidoctor Project)

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 Project

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.

Leave a Comment or Question

Help us make this conference the best it can be for you. Have questions you'd like this speaker to address? Suggestions for issues that deserve extra attention? Feedback that you'd like to share with the speaker and other attendees?

Join the conversation here (requires login)