Log templates

Assumptions contains a few built-in Markdown templates for generating logs. Curly braces are used to indicate where log items and other dynamic content should be inserted into the template (e.g. { assumptions } for assumptions). The representation of log items in the output log is defined in the corresponding log item class.

The date that the log is generated can be inserted into a template using the { current_date } placeholder.

See the built-in templates below for example usage. Custom templates can be used with the command line interface using the -t flag and pointing to the template text file.

Assumptions and caveats log

The default template displays a list of assumptions and caveats. It also indicates the last time the template was updated.

# Assumptions and caveats log

This log contains a list of assumptions and caveats used in this analysis.

## Definitions

Assumptions are red, amber or green (RAG) rated according to the following definitions for quality and impact[^1]:

| RAG rating | Assumption quality | Assumption impact |
|------------|--------------------|-------------------|
| GREEN | Reliable assumption, well understood and/or documented; anything up to a validated & recent set of actual data. | Marginal assumptions; their changes have no or limited impact on the outputs.  |
| AMBER | Some evidence to support the assumption; may vary from a source with poor methodology to a good source that is a few years old. | Assumptions with a relevant, even if not critical, impact on the outputs. |
| RED   | Little evidence to support the assumption; may vary from an opinion to a limited data source with poor methodology. | Core assumptions of the analysis; the output would be drastically affected by their change. |

[^1]: With thanks to the Home Office Analytical Quality Assurance team for these definitions.

## Assumptions and caveats

Assumptions and caveats last updated: { current_date }

This analysis contains the following assumptions and caveats:

{ assumptions }

{ caveats }

Technical debt log

This basic template creates a Markdown checklist from technical debt items that have been recorded in comments in your code.

# Technical debt log

[Technical debt](https://en.wikipedia.org/wiki/Technical_debt) is the consequence of poor design decisions, which may or may not be intentional. The consequences of this debt can include code being more difficult to extend, maintain or test.

Up to date documentation of technical debt can help to identify and prioritise improvements that will benefit ongoing development of the project.

## Technical debt

Technical debt log last updated: { current_date }

This project has incurred the following debt:

{ debt }

Todo list

This basic template creates a Markdown checklist from “Todo” comments in your code.

# Todo List

Todo list last updated: { current_date }

## List

{ todos }