From eddf0e605859744d018d1b1f5ffd378156d0c20d Mon Sep 17 00:00:00 2001 From: abrichr Date: Sat, 17 Oct 2026 00:05:58 -0400 Subject: [PATCH] docs(vocabulary): a person or an agent shows the task, one or more times The meaning for "showing the task" said a person does the task once. An agent can show it too, and a task can be learned from more than one demonstration. Signed-off-by: abrichr --- docs/VOCABULARY.md | 2 +- openadapt_types/vocabulary/vocabulary.json | 2 +- tests/test_vocabulary_lint.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/VOCABULARY.md b/docs/VOCABULARY.md index 319c207..c2efdda 100644 --- a/docs/VOCABULARY.md +++ b/docs/VOCABULARY.md @@ -34,7 +34,7 @@ the engineering level, so engineers and auditors keep the exact name. | Plain term | Technical terms one level deeper | Meaning | |---|---|---| | workflow | | The task you hand off, such as entering a referral. | -| showing the task, or recording | demonstration, capture, trace | A person does the task once while OpenAdapt watches. | +| showing the task, or recording | demonstration, capture, trace | A person or an agent shows the task, one or more times, while OpenAdapt watches. | | the automation | program, compiled program, bundle, compile | What OpenAdapt builds from the recording. | | run | replay | One time the automation does the task. | | Done and checked | VERIFIED | It saved the entry and read the record back to confirm it. | diff --git a/openadapt_types/vocabulary/vocabulary.json b/openadapt_types/vocabulary/vocabulary.json index 6d75517..4c1ebad 100644 --- a/openadapt_types/vocabulary/vocabulary.json +++ b/openadapt_types/vocabulary/vocabulary.json @@ -50,7 +50,7 @@ "id": "recording", "business_term": "showing the task", "also_business": ["recording"], - "meaning": "A person does the task once while OpenAdapt watches.", + "meaning": "A person or an agent shows the task, one or more times, while OpenAdapt watches.", "technical": [ {"term": "demonstration", "pattern": "\\bdemonstrat(e|es|ed|ion|ions)\\b", "case_sensitive": false, "min_level": "detail", "severity": "warn"}, {"term": "capture", "pattern": "\\bcaptures?\\b", "case_sensitive": false, "min_level": "detail", "severity": "warn"}, diff --git a/tests/test_vocabulary_lint.py b/tests/test_vocabulary_lint.py index fcd3032..5bf8fec 100644 --- a/tests/test_vocabulary_lint.py +++ b/tests/test_vocabulary_lint.py @@ -112,7 +112,7 @@ def test_plain_business_copy_passes(tmp_path: Path) -> None: [ "# Hand off the last step", "", - "Show the task once. OpenAdapt builds the automation and runs it.", + "Show the task one or more times. OpenAdapt builds the automation and runs it.", "Each run ends Done and checked, Stopped before saving, or Check the record.", "A record check reads the saved entry back. A right-record check comes first.", "Before it goes live, a readiness test uses your cases.",