Documentation : Let’s make it better, now, together! - Sarah Haïm-Lubczanski

Learn how to create better documentation that helps users learn and use your software effectively. This talk covers organizing, writing, and maintaining documentation for various audiences.

Key takeaways
  • Documentation is a tool, not a toy. It’s not here to entertain you, but to help you learn and use the software.

  • The audience of your documentation is important. Who is reading your documentation? If you don’t know yet, find out.

  • Organize your documentation by type. This will make it easier for users to find the information they need.

  • Use clear and concise language. Avoid jargon and technical terms that your users may not understand.

  • Use images, diagrams, and other visuals to help explain concepts. This can make your documentation more engaging and easier to understand.

  • Provide examples and tutorials. This will help users learn how to use the software.

  • Make your documentation accessible. This means making it available in multiple formats, including HTML, PDF, and plain text.

  • Keep your documentation up to date. This will ensure that users have the most accurate information.

  • Encourage users to contribute to your documentation. This can help you improve the quality and accuracy of your documentation.

  • Use a style guide. This will help ensure that your documentation is consistent and easy to read.

  • Get feedback from users. This will help you identify areas where your documentation can be improved.