Writing the Rule Book: Developing Good Documentation

davidneedham
JQTNguyen

Have you ever been excited to play a game only to discover a key part of the rules were either missing or very unclear? What about that time your friend tried to explain the rules to a really complex game? That’s exactly how your clients feel when you fail to provide comprehensive documentation.

In this session “Board Game John” and David will discuss best practices for writing solid documentation for your project or service. We’ll explain core concepts using easy to understand examples from popular board games.

Topics include:

  • Understanding why docs are no Trivial Pursuit

  • Role-playing with user personas

  • Avoiding the game of Charades

  • Thinking strategically about content

  • Getting a Clue about video tutorials

  • Don’t be afraid to say you’re Sorry!

 

This session is perfect for:

  • Agencies who build and deliver projects for clients

  • Service providers who need to explain their product

  • Project managers who want to improve client satisfaction

  • Site owners who need to regularly onboard new staff

  • Devs who want their docs to make more sense to layman

Session Track

Project Management

Experience Level

Beginner

Drupal Version