We're sorry but this page doesn't work properly without JavaScript enabled. Please enable it to continue.
Feedback

Documentation: Do's and don'ts

Formal Metadata

Title
Documentation: Do's and don'ts
Title of Series
Number of Parts
61
Author
License
CC Attribution 3.0 Germany:
You are free to use, adapt and copy, distribute and transmit the work or content in adapted or unchanged form for any legal purpose as long as the work is attributed to the author in the manner specified by the author or licensor.
Identifiers
Publisher
Release Date
Language

Content Metadata

Subject Area
Genre
Abstract
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 good, the 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.