DjangoCon 2022 | How to wag a dog

Discover how documentation can transform your software product from a mere tool into a meaningful experience. Learn how to create documentation that engages users, improves product understanding, and drives innovation.

Key takeaways
  • Documentation is not just a user’s introduction to the product; it’s an active part of the product’s definition and meaning.
  • Documentation should be an ongoing dialogue between the creators and the critics, with the documentation responding to the software and the software responding to the documentation.
  • The relationship between software and documentation should be like a dog wagging its tail, not a tail wagging a dog.
  • Documentation is essential to understanding a software product, and it can help to improve the product itself by providing feedback from users.
  • Documentation should be written in a way that is engaging and informative, and it should be easy for users to find and understand.
  • Technical authors should be recognized as technical authorities in their domain, and they should be given the respect and support they deserve.
  • Documentation is not just about providing information; it’s about helping users to see and understand the product in a new way.
  • Documentation can be a powerful tool for improving the success of a software product, and it should be given the attention and resources it deserves.
  • Documentation is an art, and it should be approached with the same creativity and passion as any other creative endeavor.
  • Documentation is a gift, and it should be given freely and generously to the world.