assumptions

Acknowledging the assumptions and caveats in our analysis is an essential part of quality assurance. When the code changes, this should be reflected in our documentation.

Record your analytical assumptions and caveats in code comments:

# Assumption: Title of assumption
# Quality: RED
# Impact: AMBER
# Detailed description
# on one line or many.

Assumptions will generate a Markdown assumptions logs for your documentation:

### Assumption 1: Title of assumption

* Location: `test_git_assumptions/search_here/assumptions.py`
* **Quality**: RED
* **Impact**: AMBER

Detailed description on one line or many.

By the way, assumptions can also be customised to find any text pattern and insert matches into any template text document.

Documentation

• User guide
  • Installation and usage
  • Assumptions and caveats
• Example output logs
  • Assumptions and caveats log
  • Technical debt log
  • Todo list
• Customising assumptions
  • Log templates
  • Log item types
  • Log class