This repository guides you thru the process of creating online searchable documentation that is kept under version control and is automatically built whenever it changes.
The target audience are:
-
The data managers that are responsible for data collection workflows (a.k.a. dataflows) and that need to create the reporting guidance documents for the external data providers.
-
The data analysts that are responsible for data processing workflows and that need to document their code and anaylitical workflow so that other colleagues can review/reuse it.
Read the getting started section.
It contains:
- a step-by-step guide on everything you need to do (just once) to getting things running on your computer
- a selection of tools to help you write the documents, if you don't have a favorite editor already
- a step-by-step guide on how to build and publish your documents.
The documentation can be written in reStructuredText or in Markdown.
-
Presently we have a guidance document about the syntax of reStructuredText
-
As soon as possible, we'll create a similar one for Markdown.
What other teams are doing is always a good source of information and inspiration.
-
Have a look at the examples in the Sphinx project.
-
Check our initial efforts at the WISE WFD Documentation