diff --git a/doc/adr/0016-notes.md b/doc/adr/0016-notes.md new file mode 100644 index 0000000..f37eac7 --- /dev/null +++ b/doc/adr/0016-notes.md @@ -0,0 +1,31 @@ +# 16. Notes + +Date: 2023-09-27 + +## Status + +Provisional + +## Context + +We want a log of events including notes from human and machine events. + +## Decision + +Whilst the log might contain other events (e.g. publication of new versions, enrichment times, etc.) a +core aspect is recording notes. + +These should be placed in the Marklogic Properties and be a single tag with nested tags, eg. + + + Judgment has typo + Judgment TDR-2023-RFT uploaded + + +Notes should be added to the end of this list; should identify whether they're human-written or machine-written, have timestamps, help us understand what person or machine wrote the message, allow a machine-readable categorisation of messages, and has writable text. + +Editors will be able to add notes via the Editor UI + +## Consequences + +We should be able to track the lifecycle of a document