Merge pull request #1716 from tidepool-org/improve-checklists

Improve checklist templates (UPLOAD-1526)

Author: gniezen

docs/checklisttemplates/CGMChecklist.md

@@ -1,105 +1,86 @@
 ## Checklist for CGM Implementation
 
-(Key:
+### CBG (Continous Blood Glucose value)
 
- - `[x]` available in data protocol/documented in spec and implemented
- - `[-]` available in data protocol/documented in spec but *not* yet implemented
- - `[?]` unknown whether available in data protocol/documented in spec; *not* yet implemented
- - `*[ ]` TODO: needs implementation!
- - `[ ]` unavailable in data protocol and/or not documented in spec and not yet implemented)
-
-### Required if Present
-
-#### CBG
-
-  - `[ ]` cbg values
-  - `[ ]` units of cbg values (read from device, not hard-coded)
-  - `[ ]` out-of-range values (LO or HI)
-  - `[ ]` out-of-range value thresholds (e.g., often 40 for low and 400 for high on CGMs)
+  - [ ] cbg values
+  - [ ] units of cbg values (read from device, not hard-coded)
+  - [ ] out-of-range values (LO or HI)
+  - [ ] out-of-range value thresholds (e.g., often 40 for low and 400 for high on CGMs)
 
 Device-specific? (Add any device-specific notes/additions here.)
 
-#### Device Events
-  - `[ ]` calibrations
-    - `[ ]` calibration value
-    - `[ ]` units of calibration value (read from device, not hard-coded)
-  - `[ ]` time changes (presence of which is also in the [BtUTC section](#bootstrapping-to-utc) below)
-    - `[ ]` device display time `from` (before change) and `to` (result of change)
-    - `[ ]` agent of change (`automatic` or `manual`)
-    - `[ ]` timezone
-    - `[ ]` reason for change (read from device)
+### Device Events
+
+  - [ ] calibrations
+    - [ ] calibration value
+    - [ ] units of calibration value (read from device, not hard-coded)
+  - [ ] time changes
+    - [ ] device display time `from` (before change) and `to` (result of change)
+    - [ ] agent of change (`automatic` or `manual`)[^1]
+    - [ ] timezone
+    - [ ] reason for change (read from device)
 
 Device-specific? (Add any device-specific notes/additions here.)
 
-#### Settings
-
-  - `[ ]` units preference for BG display
-  - `[ ]` units of data being uploaded (will be mutated to mmol/L storage units if not mmol/L)
-  - `[ ]` transmitter ID
-  - `[ ]` low alert settings
-    - `[ ]` enabled
-    - `[ ]` level/threshold
-    - `[ ]` snooze threshold
-  - `[ ]` high alert settings
-    - `[ ]` enabled
-    - `[ ]` level/threshold
-    - `[ ]` snooze threshold
-  - `[ ]` rate-of-change alerts
-    - `[ ]` fall rate alert
-        - `[ ]` enabled
-        - `[ ]` rate threshold for alerting
-    - `[ ]` rise rate alert
-        - `[ ]` enabled
-        - `[ ]` rate threshold for alerting
-  - `[ ]` out-of-range alerts
-    - `[ ]` enabled
-    - `[ ]` snooze time between alerts
-  - `[ ]` predictive alerts
-    - `[ ]` low prediction
-        - `[ ]` enabled
-        - `[ ]` time sensitivity (minutes to predicted low for alerting)
-    - `[ ]` high prediction
-        - `[ ]` enabled
-        - `[ ]` time sensitivity (minutes to predicted high for alerting)
-  - `[ ]` calibration alerts/reminders
-    - `[ ]` pre-reminder
-    - `[ ]` overdue alert
+### CGM Settings
+
+  - [ ] units preference for BG display
+  - [ ] units of data being uploaded
+  - [ ] transmitter ID (if used)
+  - [ ] low alert settings
+    - [ ] enabled
+    - [ ] level/threshold
+    - [ ] snooze threshold
+  - [ ] high alert settings
+    - [ ] enabled
+    - [ ] level/threshold
+    - [ ] snooze threshold
+  - [ ] rate-of-change alerts
+    - [ ] fall rate alert
+        - [ ] enabled
+        - [ ] rate threshold for alerting
+    - [ ] rise rate alert
+        - [ ] enabled
+        - [ ] rate threshold for alerting
+  - [ ] out-of-range alerts
+    - [ ] enabled
+    - [ ] snooze time between alerts
+  - [ ] predictive alerts
+    - [ ] low prediction
+        - [ ] enabled
+        - [ ] time sensitivity (minutes to predicted low for alerting)
+    - [ ] high prediction
+        - [ ] enabled
+        - [ ] time sensitivity (minutes to predicted high for alerting)
+  - [ ] calibration alerts/reminders
+    - [ ] pre-reminder
+    - [ ] overdue alert
 
 Settings history:
 
-  - `[ ]` device stores all changes to settings OR
-  - `[ ]` device only returns current settings at time of upload
+  - [ ] device stores all changes to settings (including previous settings) OR
+  - [ ] device only returns current settings at time of upload
+
+No Tidepool data model (yet):
 
-No Tidepool data model (yet): volume and/or vibrate mode of all alerts (can/should go in `payload`).
+  - [ ] volume and/or vibrate mode of all alerts
 
 Device-specific? (Add any device-specific notes/additions here.)
 
-#### "Bootstrapping" to UTC
+### General
 
-  - `[ ]` index
-    - `[ ]` UTC timestamp (*Hey, one can dream!*) OR
-    - `[ ]` internal timestamp or persistent log index (across device communication sessions) to order all pump events (regardless of type), independent of device display time OR
-    - `[ ]` ephemeral log index (does not persist across device communication sessions) to order all pump events (regardless of type), independent of device display time
-  - `[ ]` date & time settings changes
-  - `[ ]` use `common.checkDeviceTime(currentDeviceTime, timezone, cb)` to check against server time
+  - [ ] device time is in UTC, with records using UTC timestamps, OR
+  - [ ] internal timestamp or persistent log index (across device communication sessions) to order all pump events (regardless of type), independent of device display time OR
+  - [ ] ephemeral log index (does not persist across device communication sessions) to order all pump events (regardless of type), independent of device display time
 
 Device-specific? (Add any device-specific notes/additions here.)
 
 ### No Tidepool Data Model Yet
 
 > **NB:** You can and should add to this section if there are other data types documented in the device's data protocol specification but not part of Tidepool's data model (yet).
 
-  - `[ ]` activity/exercise
-  - `[ ]` food (e.g., Dexcom allows logging carb events)
-  - `[ ]` notes/other events
-
-### Tidepool ingestion API
-
-Choose one of the following:
-
-  - `[ ]` legacy "jellyfish" ingestion API
-  - `[ ]` platform ingestion API
-
-### Known implementation issues/TODOs
+  - [ ] activity/exercise
+  - [ ] food (e.g. carb events)
+  - [ ] notes/other events
 
-*Use this space to describe device-specific known issues or implementation TODOs **not** contained in the above datatype-specific sections.*
+[^1]: where `automatic` indicates an automated method (e.g. device) and `manual` indicates it was done manually (e.g. by a human)