Lessons learned from improving existing documentation
Sven Strack

Sven Strack

Length: Long Talk

Target Level: Beginner

Target Audience: Integrator, User, Developer

In the beginning we will learn why documentation is important and how it can help you and your customers.

From here we will move on to the main topic of this talk. With the help of real world examples, we will discover the goodthe bad and the ugly.

This will cover items such as:

  • Header
  • Line-length
  • File-length
  • Wording
  • Audience
  • Consistency
  • Code examples
  • PEP8 and friends
  • Many more

In the last part we will talk about structure, planning, helper tools and such.

This talk will use real examples out of the Plone world, but it is not limited to it.