Documentation style

Your project should contain both:

• project documentation: as a minimum a README.txt,
• code documentation: including inline comments, function, class and module docstrings,

The documentation should allow another data scientist (or you in a few years time!) to understand and pick up your work.

It is helpful to think of documentation as falling into one of four modes:

• tutorials: learning-oriented lessons that take the reader by the hand through a series of steps to complete a project of some kind,

• how-to guides: goal-oriented directions that take the reader through the steps required to solve a real-world problem,

• reference guides: information-oriented technical descriptions of the machinery and how to operate it,

• explanation: understanding-oriented discussion that clarifies and illuminates a particular topic.

The is a great breakdown of these four areas on the Diátaxis website.