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

Formale Metadaten

Titel
Documentation: Do's and don'ts
Serientitel
Anzahl der Teile
61
Autor
Lizenz
CC-Namensnennung 3.0 Deutschland:
Sie dürfen das Werk bzw. den Inhalt zu jedem legalen Zweck nutzen, verändern und in unveränderter oder veränderter Form vervielfältigen, verbreiten und öffentlich zugänglich machen, sofern Sie den Namen des Autors/Rechteinhabers in der von ihm festgelegten Weise nennen.
Identifikatoren
Herausgeber
Erscheinungsjahr
Sprache

Inhaltliche Metadaten

Fachgebiet
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.