Documentation

Introduction

What to document?

Good practices

Stick to the patterns.

Do not hesitate to provide input/output examples.

Avoid to describe how something was implemented.

Documentation tips

Documenting constants.

(pending).

Documenting object accessors.

(pending).

How to come up with a good title sentences.

(pending).

Documenting method purpose.

(pending).

I have never written any word of documentation. Where should I start from?

Future topics