Skip to content

Commit

Permalink
Docs: add notes on terminology
Browse files Browse the repository at this point in the history
  • Loading branch information
edavey committed Oct 8, 2024
1 parent 4fb2a07 commit a52e46b
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,29 @@ This is a rebuild of the airTEXT.info service

1. [Getting started](/doc/getting-started.md)

## Description of the service

A service for providing forecasts and personalised alerts on air quality and
other environmental factors in:

- Greater London
- Cambridge
- the Chelmsford/Colchester area

## Terminology

We aim to use and refine a "ubiquitous language" for use throughout the service.
We believe that this will optimise our communication and minimise our
misunderstandings and our cognitive load. We will aim use the same terms in:

- the UI of the service
- the code we write
- our sketches and mockups
- our research sessions
- our documentation and our presentations to partner organisations

See [./doc/terminology.md][]

## Tests

### Local unit and integration tests
Expand Down Expand Up @@ -80,3 +103,4 @@ This repository was bootstrapped from

[https://air-text-3e4548b53179.herokuapp.com/]:
https://air-text-3e4548b53179.herokuapp.com/
[./doc/terminology.md]: ./doc/terminology.md
46 changes: 46 additions & 0 deletions doc/terminology.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Terminology

## Purpose

We aim to use and refine a "ubiquitous language" for use throughout the service.
We believe that this will optimise our communication and minimise our
misunderstandings and our cognitive load. We will aim use the same terms in:

- the UI of the service
- the code we write
- our sketches and mockups
- our research sessions
- our documentation and our presentations to partner organisations

## Terms

We are provided with daily **`forecasts`** by CERC. Each forecast consists of 6
environmental **`predictions`**:

- Air pollution
- UV
- Pollen
- Temperature
- Wind
- Rain

Each **prediction** has an **`DAQI level`**. This [DAQI (Daily Air
Quality Index)][] scoring uses the range 1-10:

- low (1-3)
- moderate (4-6)
- high (7-9)
- very high (10)

An **`alert`** is in effect when a particular prediction's DAQI level is above a
certain threshold e.g. tomorrow the:

- UV prediction has the **moderate** DAQI level
- pollen prediction has the **low** DAQI level
- air pollution prediction has the **high** DAQI level (aka an "**Air quality
alert**: high")

**Air quality alerts** are air pollution predictions with DAQI leveles above
"low".

[DAQI (Daily Air Quality Index)]: https://uk-air.defra.gov.uk/air-pollution/daqi

0 comments on commit a52e46b

Please sign in to comment.