KB Software Documentation


Our aim is to create simple step-by-step documentation for implementing a feature or service.

The notes do not usually try and explain the reason why (or alternative strategies). They will assume competency in development, the linux command line and sys-admin.

From What nobody tells you about documentation. We are writing How-To Guides, so they are:

  1. is goal-oriented

  2. shows how to solve a specific problem

  3. is a series of steps

Analogy: a recipe in a cookery book

(A copy of this document can be found here: misc/what-nobody-tells-you-about-documentation.pdf)

The YouTube video from PyCON UK 2017, Docs or it didn’t happen is very useful.

Indices and tables