workflow-supervisor 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +433 -167
- package/adapters/claude-code/adapter.json +7 -1
- package/adapters/codex/adapter.json +7 -1
- package/bin/workflow-skills.mjs +1103 -20
- package/docs/artifacts.md +4 -2
- package/docs/cli.md +77 -15
- package/docs/compatibility.md +11 -37
- package/docs/portable-delegation.md +189 -0
- package/docs/skill-reference.md +4 -4
- package/docs/troubleshooting.md +1 -1
- package/package.json +3 -4
- package/schemas/dossier-v1.schema.json +139 -0
- package/schemas/worker-report-v1.schema.json +119 -0
- package/skills/acceptance-matrix/SKILL.md +2 -2
- package/skills/dossier-builder/SKILL.md +22 -8
- package/skills/dossier-builder/agents/openai.yaml +2 -2
- package/skills/loop-policy/SKILL.md +10 -10
- package/skills/loop-policy/agents/openai.yaml +1 -1
- package/skills/work-unit/SKILL.md +3 -3
- package/skills/worker-roles/SKILL.md +10 -10
- package/skills/worker-roles/agents/openai.yaml +2 -2
- package/skills/workflow-docs/SKILL.md +12 -9
- package/skills/workflow-docs/agents/openai.yaml +2 -2
- package/skills/workflow-docs/references/documentation-production.md +2 -0
- package/skills/workflow-docs/references/goal-resume.md +2 -0
- package/skills/workflow-docs/references/templates.md +4 -2
- package/skills/workflow-docs/references/workflow-control.md +16 -12
- package/skills/workflow-supervisor/SKILL.md +118 -46
- package/adapters/hermesagent/adapter.json +0 -8
- package/adapters/opencode/adapter.json +0 -8
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://workflow-supervisor.local/schemas/worker-report-v1.schema.json",
|
|
4
|
+
"title": "WorkerReportV1",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"additionalProperties": false,
|
|
7
|
+
"required": [
|
|
8
|
+
"schema",
|
|
9
|
+
"status",
|
|
10
|
+
"role",
|
|
11
|
+
"unit_id",
|
|
12
|
+
"summary",
|
|
13
|
+
"changed_surfaces",
|
|
14
|
+
"evidence",
|
|
15
|
+
"checks_run",
|
|
16
|
+
"skipped_checks",
|
|
17
|
+
"findings",
|
|
18
|
+
"blocking_question",
|
|
19
|
+
"next_action",
|
|
20
|
+
"adapter",
|
|
21
|
+
"guard",
|
|
22
|
+
"reason"
|
|
23
|
+
],
|
|
24
|
+
"properties": {
|
|
25
|
+
"schema": {
|
|
26
|
+
"type": "string",
|
|
27
|
+
"const": "WorkerReportV1"
|
|
28
|
+
},
|
|
29
|
+
"status": {
|
|
30
|
+
"type": "string",
|
|
31
|
+
"enum": ["PASS", "FAIL", "BLOCKED"]
|
|
32
|
+
},
|
|
33
|
+
"role": {
|
|
34
|
+
"type": "string",
|
|
35
|
+
"enum": ["implementer", "verifier", "repair", "documenter"]
|
|
36
|
+
},
|
|
37
|
+
"unit_id": {
|
|
38
|
+
"type": "string",
|
|
39
|
+
"minLength": 1
|
|
40
|
+
},
|
|
41
|
+
"summary": {
|
|
42
|
+
"type": "string"
|
|
43
|
+
},
|
|
44
|
+
"changed_surfaces": {
|
|
45
|
+
"type": "array",
|
|
46
|
+
"items": {
|
|
47
|
+
"type": "string"
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
"evidence": {
|
|
51
|
+
"type": "array",
|
|
52
|
+
"items": {
|
|
53
|
+
"type": "string"
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
"checks_run": {
|
|
57
|
+
"type": "array",
|
|
58
|
+
"items": {
|
|
59
|
+
"type": "string"
|
|
60
|
+
}
|
|
61
|
+
},
|
|
62
|
+
"skipped_checks": {
|
|
63
|
+
"type": "array",
|
|
64
|
+
"items": {
|
|
65
|
+
"type": "string"
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
"findings": {
|
|
69
|
+
"type": "array",
|
|
70
|
+
"items": {
|
|
71
|
+
"type": "string"
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
"blocking_question": {
|
|
75
|
+
"type": ["string", "null"]
|
|
76
|
+
},
|
|
77
|
+
"next_action": {
|
|
78
|
+
"type": "string"
|
|
79
|
+
},
|
|
80
|
+
"adapter": {
|
|
81
|
+
"type": ["object", "null"],
|
|
82
|
+
"additionalProperties": false,
|
|
83
|
+
"required": [],
|
|
84
|
+
"properties": {}
|
|
85
|
+
},
|
|
86
|
+
"guard": {
|
|
87
|
+
"type": ["object", "null"],
|
|
88
|
+
"additionalProperties": false,
|
|
89
|
+
"required": [
|
|
90
|
+
"allowed_surface_violations",
|
|
91
|
+
"role_violations",
|
|
92
|
+
"warnings"
|
|
93
|
+
],
|
|
94
|
+
"properties": {
|
|
95
|
+
"allowed_surface_violations": {
|
|
96
|
+
"type": "array",
|
|
97
|
+
"items": {
|
|
98
|
+
"type": "string"
|
|
99
|
+
}
|
|
100
|
+
},
|
|
101
|
+
"role_violations": {
|
|
102
|
+
"type": "array",
|
|
103
|
+
"items": {
|
|
104
|
+
"type": "string"
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
"warnings": {
|
|
108
|
+
"type": "array",
|
|
109
|
+
"items": {
|
|
110
|
+
"type": "string"
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
},
|
|
115
|
+
"reason": {
|
|
116
|
+
"type": ["string", "null"]
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: acceptance-matrix
|
|
3
|
-
description: Convert requirements into formal, evidence-mapped acceptance criteria only for supervised, high-risk, ambiguous, resumable, or
|
|
3
|
+
description: Convert requirements into formal, evidence-mapped acceptance criteria only for supervised, high-risk, ambiguous, resumable, or delegated workflows. Use when verification must map each requirement to evidence, adversarial cases, PASS/FAIL/BLOCKED states, review states, and residual risk. Do not use for ordinary code review, small scoped edits, routine test runs, trivial explicit acceptance, or declaring completion unless the user asks for an acceptance matrix or evidence-mapped verification.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Acceptance Matrix
|
|
@@ -53,7 +53,7 @@ Consider:
|
|
|
53
53
|
```yaml
|
|
54
54
|
status: PASS|FAIL|BLOCKED
|
|
55
55
|
verified_work_unit:
|
|
56
|
-
|
|
56
|
+
verified_worker:
|
|
57
57
|
matrix:
|
|
58
58
|
- id:
|
|
59
59
|
requirement:
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: dossier-builder
|
|
3
|
-
description: Create a concrete
|
|
3
|
+
description: Create a concrete delegation contract only when one already-bounded work unit needs a dossier for another agent, automated worker run, future session, formal worker prompt, or durable continuation. Use when objective, sources, boundaries, acceptance rows, checks or evidence, stop gates, worker naming, start conditions, and report schemas must be captured before delegation. Do not use to plan work Codex will perform directly in the current turn, for unbounded work, or for ordinary same-session implementation.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Dossier Builder
|
|
7
7
|
|
|
8
|
-
Use this skill to prevent vague
|
|
8
|
+
Use this skill to prevent vague delegation. A dossier is the contract between the supervisor and a worker.
|
|
9
9
|
|
|
10
10
|
## Domain Neutral Inputs
|
|
11
11
|
|
|
@@ -26,6 +26,14 @@ The dossier does not own acceptance design. It references or embeds acceptance r
|
|
|
26
26
|
|
|
27
27
|
If these inputs are missing, create a discovery dossier or return BLOCKED.
|
|
28
28
|
|
|
29
|
+
Before delegation, validate the dossier with:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
workflow-supervisor validate-dossier <dossier-path> --role <role> --unit <unit-id> --json
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
If validation fails, do not start a worker. Return BLOCKED, create a discovery dossier, or ask the supervisor/user for the missing decision.
|
|
36
|
+
|
|
29
37
|
For early discovery, the only source may be conversation context and the only allowed surface may be a planned brief, doc, or question list. Do not require repository paths or existing files.
|
|
30
38
|
|
|
31
39
|
Use a provisional dossier for low-risk drafts, plans, outlines, rubrics, and options when sources are thin but the output can clearly mark assumptions. Use BLOCKED for factual, irreversible, regulated, publication, or production changes that lack material sources or boundaries.
|
|
@@ -33,11 +41,13 @@ Use a provisional dossier for low-risk drafts, plans, outlines, rubrics, and opt
|
|
|
33
41
|
## Dossier Shape
|
|
34
42
|
|
|
35
43
|
```yaml
|
|
44
|
+
schema: DossierV1
|
|
36
45
|
workflow:
|
|
37
46
|
work_unit:
|
|
38
47
|
dossier_id:
|
|
39
|
-
|
|
40
|
-
|
|
48
|
+
worker_name:
|
|
49
|
+
worker_role:
|
|
50
|
+
delegation_transport:
|
|
41
51
|
start_condition:
|
|
42
52
|
title:
|
|
43
53
|
objective:
|
|
@@ -57,7 +67,7 @@ acceptance_matrix:
|
|
|
57
67
|
adversarial_checks:
|
|
58
68
|
required_commands_or_evidence:
|
|
59
69
|
worker_role:
|
|
60
|
-
|
|
70
|
+
worker_prompt:
|
|
61
71
|
supervisor_checkpoints:
|
|
62
72
|
completion_report_schema:
|
|
63
73
|
verification_report_schema:
|
|
@@ -66,7 +76,9 @@ assumptions:
|
|
|
66
76
|
open_questions:
|
|
67
77
|
```
|
|
68
78
|
|
|
69
|
-
|
|
79
|
+
The machine gate requires concrete strings or arrays for the core fields. Use `open_questions: [none]` only when no open question remains. Do not use placeholders such as `TBD`, `unknown`, `all files`, `entire repo`, `as needed`, or `use your judgment`.
|
|
80
|
+
|
|
81
|
+
## Delegation Rules
|
|
70
82
|
|
|
71
83
|
- Name exact files, docs, systems, or artifact paths when available.
|
|
72
84
|
- Prefer concrete boundaries over broad module names.
|
|
@@ -76,10 +88,12 @@ open_questions:
|
|
|
76
88
|
- Require workers to report skipped checks and assumptions.
|
|
77
89
|
- For non-code work, use evidence such as citations, before/after excerpts, review rubrics, examples, artifact diffs, or explicit user decisions instead of commands.
|
|
78
90
|
- Require repair tickets to cite the verification finding or acceptance row they repair.
|
|
79
|
-
- Include a deterministic `
|
|
91
|
+
- Include a deterministic `worker_name` when delegation is planned. Use `wf/<workflow-slug>/<unit-id>-<role>-<dossier-slug>`.
|
|
80
92
|
- Include `start_condition`, such as `after path gate`, `after human plan approval`, `after autonomous execution plan`, `after implementer report`, `after verification FAIL`, or `after repairs complete`.
|
|
81
|
-
- Include
|
|
93
|
+
- Include the selected `delegation_transport`, such as `portable_delegate`, `native_thread`, `native_subagent`, or `same_session_phased`.
|
|
94
|
+
- Include a ready-to-send `worker_prompt` that contains only the worker's role, dossier, sources, acceptance rows, stop gates, and report schema.
|
|
82
95
|
- Include supervisor checkpoints for kickoff acknowledgement, blocker questions, terminal report, and closeout.
|
|
96
|
+
- Run `workflow-supervisor validate-dossier` before `workflow-supervisor delegate`. Treat validation failure as a stop gate.
|
|
83
97
|
|
|
84
98
|
## Failure Modes
|
|
85
99
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Dossier Builder"
|
|
3
|
-
short_description: "Create concrete
|
|
4
|
-
default_prompt: "Use $dossier-builder to create a grounded
|
|
3
|
+
short_description: "Create concrete worker delegation contracts"
|
|
4
|
+
default_prompt: "Use $dossier-builder to create a grounded worker dossier with worker name, delegation transport, start condition, and report schema for this work unit."
|
|
5
5
|
|
|
6
6
|
policy:
|
|
7
7
|
allow_implicit_invocation: false
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: loop-policy
|
|
3
|
-
description: Define execution policy only for supervised, multi-agent,
|
|
3
|
+
description: Define execution policy only for supervised, multi-agent, portable-worker, long-running, resumable, autonomous-goal, human-in-loop, approval-gated, or repair-loop workflows. Use for execution path selection, sequential or parallel execution, worker delegation, retry and repair limits, budgets, escalation, Codex goal binding, blocking rules, continuation criteria, and no-progress detection. Do not use for one failing command, normal retrying, routine user approval, or a one-shot task with obvious completion.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Loop Policy
|
|
@@ -30,11 +30,11 @@ Do not create goals for small direct tasks. A goal is the state container for op
|
|
|
30
30
|
- Intake: whether every required intake decision has an explicit user answer, and which unanswered items must be re-asked before any work can start.
|
|
31
31
|
- Execution path: autonomous_goal or human_in_loop, from completed intake only.
|
|
32
32
|
- Mode: sequential, parallel, staged parallel, or discovery-first, from completed intake only.
|
|
33
|
-
- Approval: none, before
|
|
34
|
-
- Delegation orchestration:
|
|
33
|
+
- Approval: none, before worker delegation, before implementation, before verification, before repair, before publication, before irreversible action, before each unit, or path-gated.
|
|
34
|
+
- Delegation orchestration: selected transport, adapter availability, naming scheme, start timing, supervisor checkpoint cadence, terminal report collection, and stop behavior when automated delegation is unavailable.
|
|
35
35
|
- Repair limit: maximum repair loops per unit.
|
|
36
36
|
- Budget: time, token, command, cost, or file-change limits.
|
|
37
|
-
- Escalation: when to ask the user,
|
|
37
|
+
- Escalation: when to ask the user, delegate to a specialist worker, or stop.
|
|
38
38
|
- Completion: evidence required before marking done.
|
|
39
39
|
- Resume: artifacts needed before pausing or compacting.
|
|
40
40
|
- Mutation conflict: whether units touch the same mutable surfaces or decisions.
|
|
@@ -44,7 +44,7 @@ Do not create goals for small direct tasks. A goal is the state container for op
|
|
|
44
44
|
Use this default unless the task says otherwise:
|
|
45
45
|
|
|
46
46
|
```yaml
|
|
47
|
-
intake_required_when: every supervisor invocation before goal creation, planning beyond intake,
|
|
47
|
+
intake_required_when: every supervisor invocation before goal creation, planning beyond intake, worker delegation, implementation, verification, repair, final disposition, publication, or irreversible action
|
|
48
48
|
intake_question_count: ask the complete intake packet first; on follow-up ask every unanswered or ambiguous item
|
|
49
49
|
required_intake_decisions: objective_and_source, execution_path, mode, delegation, final_disposition, mutation_boundaries, state_artifacts
|
|
50
50
|
use_judgment_defaults: none; user must answer every required intake decision explicitly
|
|
@@ -54,15 +54,15 @@ execution_path: from completed intake only
|
|
|
54
54
|
approval_gate: path-gated; complete intake before any path-specific plan; human approval for human_in_loop plans; explicit completed-intake authorization for autonomous_goal; explicit completed-intake authorization for irreversible or user-visible publication
|
|
55
55
|
repair_limit_per_unit: 2
|
|
56
56
|
parallel_allowed_when: units do not share mutable surfaces
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
supervisor_checkpoint_cadence: after
|
|
57
|
+
worker_delegation_rule: after complete intake, path gate, concrete dossier, and supported automated transport
|
|
58
|
+
native_transport_rule: after complete intake, path gate, and concrete dossier when the environment exposes approved thread or subagent tools
|
|
59
|
+
worker_name_template: wf/<workflow-slug>/<unit-id>-<role>-<dossier-slug>
|
|
60
|
+
supervisor_checkpoint_cadence: after worker start, terminal report, repair ticket creation, re-verification, and final disposition
|
|
61
61
|
final_disposition_policy: from completed intake only; if set to ask_at_end, stop and ask at final disposition
|
|
62
62
|
workflow_unit_blocked_after: first material blocker may stop the unit while the Codex goal remains active
|
|
63
63
|
codex_goal_blocked_after: same material blocker across 3 consecutive goal turns and no meaningful progress
|
|
64
64
|
completion_requires: acceptance evidence plus residual risk report
|
|
65
|
-
resume_requires:
|
|
65
|
+
resume_requires: workflow state or outcome doc for long workflows
|
|
66
66
|
missing_prerequisites: discovery-first, not failure
|
|
67
67
|
goal_start: after complete intake only; create only when completed intake and environment authorize goal binding, otherwise mirror state in docs
|
|
68
68
|
goal_state_mirror_cadence: after unit terminal states and final outcome
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Loop Policy"
|
|
3
|
-
short_description: "Control path,
|
|
3
|
+
short_description: "Control path, workers, retries, and gates"
|
|
4
4
|
default_prompt: "Use $loop-policy to enforce complete intake before work starts, forbid keyword shortcuts, require explicit user answers for every intake field, then define execution path, delegation, retry, approval, and stopping rules."
|
|
5
5
|
|
|
6
6
|
policy:
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: work-unit
|
|
3
|
-
description: Decompose fuzzy or broad objectives into bounded, sequenced, verifiable work units. Use when a task is too large, ambiguous, multi-phase, dependency-heavy, or risky to execute as one edit; when a supervisor needs packets, milestones, slices, tickets, or agent
|
|
3
|
+
description: Decompose fuzzy or broad objectives into bounded, sequenced, verifiable work units. Use when a task is too large, ambiguous, multi-phase, dependency-heavy, or risky to execute as one edit; when a supervisor needs packets, milestones, slices, tickets, or agent delegation; or when scope must be narrowed before implementation. Do not use for already-small tasks with clear files and acceptance.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Work Unit
|
|
@@ -16,7 +16,7 @@ Work units can be bounded by code package, document section, source set, stakeho
|
|
|
16
16
|
A good work unit has:
|
|
17
17
|
|
|
18
18
|
- one objective
|
|
19
|
-
- a stable unit ID suitable for dossier and
|
|
19
|
+
- a stable unit ID suitable for dossier and worker naming
|
|
20
20
|
- named dependencies
|
|
21
21
|
- explicit in-scope and out-of-scope surfaces
|
|
22
22
|
- known sources or source gaps
|
|
@@ -49,7 +49,7 @@ For over-broad one-pass requests, produce a sequencing recommendation and invoke
|
|
|
49
49
|
parent_objective:
|
|
50
50
|
units:
|
|
51
51
|
- id:
|
|
52
|
-
|
|
52
|
+
worker_slug:
|
|
53
53
|
title:
|
|
54
54
|
objective:
|
|
55
55
|
in_scope:
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: worker-roles
|
|
3
|
-
description: Define narrow role contracts only when creating explicit worker prompts or separating responsibilities across multiple agents,
|
|
3
|
+
description: Define narrow role contracts only when creating explicit worker prompts or separating responsibilities across multiple agents, automated worker runs, reviewers, or formal delegation. Use to prevent role bleed such as verifiers editing implementation, implementers self-approving, repair authors inventing scope, or documenters starting before evidence exists. Do not use for ordinary single-agent reviewing, editing, researching, documenting, or implementing in the current session.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Worker Roles
|
|
7
7
|
|
|
8
8
|
Use this skill to make delegation safe. Each worker prompt should include one role, one objective, allowed behavior, forbidden behavior, sources to read, and a report schema.
|
|
9
9
|
|
|
10
|
-
No worker
|
|
10
|
+
No worker should start before the supervisor intake and path gates are satisfied. In `human_in_loop`, that means complete intake plus human plan approval. In `autonomous_goal`, that means complete intake selecting `autonomous_goal` plus a recorded execution plan. Role-specific start conditions below are additional gates after the path gate.
|
|
11
11
|
|
|
12
12
|
## Domain Neutrality
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ Use "Executor" or "Producer" instead of "Implementer" when the work is documenta
|
|
|
15
15
|
|
|
16
16
|
## Solo Mode
|
|
17
17
|
|
|
18
|
-
When separate
|
|
18
|
+
When separate automated workers, agents, or reviewers are unavailable, collapse roles into phases in the same session. Label verification as `self-check`, not independent verification. Require independent review only when the user asks, the work is high-risk, publication-bound, regulated, security-sensitive, or the loop policy requires it.
|
|
19
19
|
|
|
20
20
|
## Role Contracts
|
|
21
21
|
|
|
@@ -91,13 +91,13 @@ When separate agents, threads, or reviewers are unavailable, collapse roles into
|
|
|
91
91
|
- A repair author that adds product requirements is expanding scope.
|
|
92
92
|
- A documenter that hides unknowns is corrupting resume state.
|
|
93
93
|
- A supervisor that implements code should mark that role switch explicitly.
|
|
94
|
-
- Same-
|
|
94
|
+
- Same-session verification is a self-check unless an independent verifier separately inspects the evidence.
|
|
95
95
|
|
|
96
96
|
## Worker Prompt Minimums
|
|
97
97
|
|
|
98
98
|
Include:
|
|
99
99
|
|
|
100
|
-
-
|
|
100
|
+
- worker name
|
|
101
101
|
- role name
|
|
102
102
|
- work unit and objective
|
|
103
103
|
- must-read sources
|
|
@@ -106,10 +106,10 @@ Include:
|
|
|
106
106
|
- stop gates
|
|
107
107
|
- exact report schema
|
|
108
108
|
|
|
109
|
-
##
|
|
109
|
+
## Worker Interaction Rules
|
|
110
110
|
|
|
111
|
-
- Workers should
|
|
112
|
-
- Workers should
|
|
113
|
-
- Workers should not message other
|
|
111
|
+
- Workers should confirm they received the assigned dossier before acting when the transport supports acknowledgement.
|
|
112
|
+
- Workers should return `BLOCKED` to the supervisor when a blocker affects scope, sources, surfaces, checks, or acceptance.
|
|
113
|
+
- Workers should not message other workers directly unless the supervisor allows it in the loop policy.
|
|
114
114
|
- Workers should send one terminal report with PASS, FAIL, BLOCKED, or PARTIAL status using the assigned schema.
|
|
115
|
-
- Verifier and repair
|
|
115
|
+
- Verifier and repair workers should cite acceptance row IDs and prior report IDs so the supervisor can route the loop.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Worker Roles"
|
|
3
|
-
short_description: "Define narrow worker
|
|
4
|
-
default_prompt: "Use $worker-roles to assign strict
|
|
3
|
+
short_description: "Define narrow worker role contracts"
|
|
4
|
+
default_prompt: "Use $worker-roles to assign strict worker roles and prevent role bleed in this workflow."
|
|
5
5
|
|
|
6
6
|
policy:
|
|
7
7
|
allow_implicit_invocation: false
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: workflow-docs
|
|
3
|
-
description: Generate or refresh durable workflow-state,
|
|
3
|
+
description: Generate or refresh durable workflow-state, delegation, resume, verification, repair, decision, or documentation-production control artifacts. Use when the work needs reusable state such as workflow control docs, documentation briefs, source inventories, review plans, revision queues, publishing checklists, or maintenance plans. Do not use for ordinary README edits, help article drafting, prose cleanup, summaries, marketing copy, decorative docs, or documentation content unless reusable workflow/documentation-production state is requested.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Workflow Docs
|
|
@@ -13,7 +13,7 @@ Do not require existing Markdown files. You may create a minimal doc set from co
|
|
|
13
13
|
|
|
14
14
|
## State Artifact Medium
|
|
15
15
|
|
|
16
|
-
Markdown is the default when the workspace/file medium is appropriate, but reusable workflow state may also be an inline brief, spreadsheet tab, ticket set, design annotation, CRM note, runbook, decision log, slide appendix, whiteboard note, or chat
|
|
16
|
+
Markdown is the default when the workspace/file medium is appropriate, but reusable workflow state may also be an inline brief, spreadsheet tab, ticket set, design annotation, CRM note, runbook, decision log, slide appendix, whiteboard note, or chat continuation note. Choose the medium that the next human or agent can actually use.
|
|
17
17
|
|
|
18
18
|
## Default Artifact Directory
|
|
19
19
|
|
|
@@ -21,11 +21,13 @@ When creating Markdown workflow artifacts, use `<workspace>/.workflow/` as the d
|
|
|
21
21
|
|
|
22
22
|
Use another location only when the user names one, the project has an existing workflow-state convention, the target medium is not files, or the artifact is a final deliverable that belongs elsewhere. Keep control artifacts under `.workflow/` even when implementation files, docs, or product outputs are created in normal project locations.
|
|
23
23
|
|
|
24
|
+
In a Git-backed codebase, `.workflow/` is local supervisor state by default. Before creating `.workflow/` artifacts, ensure `<workspace>/.gitignore` contains `.workflow/`. Create `.gitignore` if needed. Do not stage, commit, or publish `.workflow/` unless the completed intake explicitly names workflow state as a final deliverable.
|
|
25
|
+
|
|
24
26
|
## Artifact Lanes
|
|
25
27
|
|
|
26
28
|
Use two lanes:
|
|
27
29
|
|
|
28
|
-
- Workflow control: preserve state, decisions, work units,
|
|
30
|
+
- Workflow control: preserve state, decisions, work units, delegation, verification, and outcomes.
|
|
29
31
|
- Documentation production: define audience, purpose, content inventory, outline, style, review path, publication readiness, and maintenance.
|
|
30
32
|
|
|
31
33
|
For documentation work, start with `DOCUMENTATION-BRIEF.md` unless the user provides an equivalent brief. Without audience, reader task, document type, owner, source expectations, and publishing target, create a brief or ask for the missing decision before drafting final content.
|
|
@@ -35,15 +37,15 @@ For documentation work, start with `DOCUMENTATION-BRIEF.md` unless the user prov
|
|
|
35
37
|
- Scaffold blank artifacts for a new workflow.
|
|
36
38
|
- Generate artifacts from conversation, source inspection, or supervisor state.
|
|
37
39
|
- Refresh existing artifacts while preserving unresolved questions and decisions.
|
|
38
|
-
- Create a resume pack for another
|
|
40
|
+
- Create a resume pack for another worker or future session.
|
|
39
41
|
- Convert verification and repair results into durable reports.
|
|
40
|
-
- Preserve
|
|
42
|
+
- Preserve worker delegation plans, terminal reports, and final disposition decisions when supervised work spans workers or sessions.
|
|
41
43
|
|
|
42
44
|
## Rules
|
|
43
45
|
|
|
44
46
|
- Load [references/templates.md](references/templates.md) first when choosing exact templates, then load only the referenced lane file needed for the task.
|
|
45
47
|
- Load [references/documentation-production.md](references/documentation-production.md) for documentation deliverables, content drafts, claims registers, review plans, publishing, and maintenance.
|
|
46
|
-
- Load [references/workflow-control.md](references/workflow-control.md) for supervised workflow state, work units, dossiers, acceptance, verification, repairs, decisions,
|
|
48
|
+
- Load [references/workflow-control.md](references/workflow-control.md) for supervised workflow state, work units, dossiers, acceptance, verification, repairs, decisions, delegation state, and outcomes.
|
|
47
49
|
- Load [references/goal-resume.md](references/goal-resume.md) for Codex goal mirrors, active-goal conflicts, and resume packs.
|
|
48
50
|
- Keep facts, assumptions, open questions, and inferences separate.
|
|
49
51
|
- Include paths, commands, sources, and evidence when available.
|
|
@@ -52,6 +54,7 @@ For documentation work, start with `DOCUMENTATION-BRIEF.md` unless the user prov
|
|
|
52
54
|
- Do not create files the workflow will not use.
|
|
53
55
|
- Reject requests to create every possible workflow document "just in case"; select the smallest doc set that preserves state or enables production.
|
|
54
56
|
- Do not treat workflow docs as a required provenance ledger; use them as lightweight working memory.
|
|
57
|
+
- Keep `.workflow/` ignored by Git in codebases; workflow state is private working memory unless the user explicitly chooses to publish it.
|
|
55
58
|
- Adapt headings from files and commands to artifacts and evidence for non-code workflows.
|
|
56
59
|
- Preserve acceptance matrices and verification reports; do not reinterpret evidence rows or change verdicts unless the workflow explicitly asks for a review/update.
|
|
57
60
|
|
|
@@ -60,15 +63,15 @@ For documentation work, start with `DOCUMENTATION-BRIEF.md` unless the user prov
|
|
|
60
63
|
- `.workflow/WORKFLOW.md`: overall objective, policy, state, units, and next action.
|
|
61
64
|
- `.workflow/SOURCE-CORPUS.md`: source map, authority ranking, contradictions, gaps.
|
|
62
65
|
- `.workflow/WORK-UNITS.md`: decomposition and sequencing.
|
|
63
|
-
- `.workflow/DOSSIER.md`:
|
|
64
|
-
- `.workflow/
|
|
66
|
+
- `.workflow/DOSSIER.md`: delegation contract for one unit.
|
|
67
|
+
- `.workflow/WORKER-MAP.md`: worker names, roles, transports, dossiers, dependencies, start conditions, report status, and supervisor checkpoints.
|
|
65
68
|
- `.workflow/ACCEPTANCE-MATRIX.md`: verifiable done criteria.
|
|
66
69
|
- `.workflow/VERIFICATION-REPORT.md`: evidence-backed PASS/FAIL/BLOCKED report.
|
|
67
70
|
- `.workflow/REPAIR-TICKETS.md`: actionable repair tasks from verifier findings.
|
|
68
71
|
- `.workflow/DECISIONS.md`: durable decisions, assumptions, and reversals.
|
|
69
72
|
- `.workflow/HANDOFF.md`: resume state for another agent or session.
|
|
70
73
|
- `.workflow/OUTCOME.md`: final status, checks, risks, and next step.
|
|
71
|
-
- `.workflow/GOAL-STATE.md`: optional fallback record when a Codex goal tool is unavailable or goal state must be mirrored for
|
|
74
|
+
- `.workflow/GOAL-STATE.md`: optional fallback record when a Codex goal tool is unavailable or goal state must be mirrored for continuation.
|
|
72
75
|
- `.workflow/DOCUMENTATION-BRIEF.md`: audience, purpose, document type, reader task, channel, owner, approvers, and success criteria.
|
|
73
76
|
- `.workflow/CONTENT-INVENTORY.md`: existing materials, reusable sections, gaps, stale areas, and owners.
|
|
74
77
|
- `.workflow/OUTLINE.md`: information architecture, section hierarchy, and required content.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Workflow Docs"
|
|
3
|
-
short_description: "Preserve workflow and
|
|
4
|
-
default_prompt: "Use $workflow-docs to create or refresh .workflow/ artifacts that preserve workflow,
|
|
3
|
+
short_description: "Preserve workflow and worker state"
|
|
4
|
+
default_prompt: "Use $workflow-docs to create or refresh .workflow/ artifacts that preserve workflow, worker delegation, verification, and outcome state."
|
|
5
5
|
|
|
6
6
|
policy:
|
|
7
7
|
allow_implicit_invocation: false
|
|
@@ -4,6 +4,8 @@ Use these for documentation production. Do not create all of them by default; se
|
|
|
4
4
|
|
|
5
5
|
Default path: create documentation-production control artifacts under `<workspace>/.workflow/` unless the user names another artifact directory or the project already has an established workflow-state location. Final public docs, app files, articles, or published content may still belong in their normal product or documentation locations.
|
|
6
6
|
|
|
7
|
+
In Git-backed codebases, ensure `<workspace>/.gitignore` contains `.workflow/` before creating these control artifacts. Workflow state is local working memory and should not be staged or published unless explicitly selected as a final deliverable.
|
|
8
|
+
|
|
7
9
|
## Presets
|
|
8
10
|
|
|
9
11
|
- Public article: `DOCUMENTATION-BRIEF.md`, `CONTENT-INVENTORY.md`, `OUTLINE.md`, `CONTENT-DRAFT.md`, `REVIEW-PLAN.md`, `PUBLISHING-CHECKLIST.md`.
|
|
@@ -4,6 +4,8 @@ Use these only for Codex goal mirroring, active-goal conflicts, or resume packs.
|
|
|
4
4
|
|
|
5
5
|
Default path: create `GOAL-STATE.md` and goal-aware workflow artifacts under `<workspace>/.workflow/` unless the user provides another artifact directory or the project already has an established workflow-state location.
|
|
6
6
|
|
|
7
|
+
In Git-backed codebases, ensure `<workspace>/.gitignore` contains `.workflow/` before creating these artifacts. Workflow state is local working memory and should not be staged or published unless explicitly selected as a final deliverable.
|
|
8
|
+
|
|
7
9
|
## Goal-Aware WORKFLOW.md Fields
|
|
8
10
|
|
|
9
11
|
```md
|
|
@@ -4,6 +4,8 @@ Load only the lane needed for the task.
|
|
|
4
4
|
|
|
5
5
|
Create Markdown artifacts under `<workspace>/.workflow/` by default. Use another directory only when the user names one, the project already has a clearer workflow-state convention, or the artifact is a final deliverable that belongs elsewhere.
|
|
6
6
|
|
|
7
|
+
In Git-backed codebases, ensure `<workspace>/.gitignore` contains `.workflow/` before creating the directory. Workflow state is local working memory and should not be staged or published unless explicitly selected as a final deliverable.
|
|
8
|
+
|
|
7
9
|
## Documentation Production
|
|
8
10
|
|
|
9
11
|
Read [documentation-production.md](documentation-production.md) when creating or revising documentation deliverables, briefs, outlines, factual source registers, review plans, publication assets, or maintenance plans.
|
|
@@ -26,7 +28,7 @@ Includes:
|
|
|
26
28
|
|
|
27
29
|
## Workflow Control
|
|
28
30
|
|
|
29
|
-
Read [workflow-control.md](workflow-control.md) when preserving supervised workflow state, work units, dossiers, acceptance matrices, verification reports, repairs, decisions,
|
|
31
|
+
Read [workflow-control.md](workflow-control.md) when preserving supervised workflow state, work units, dossiers, acceptance matrices, verification reports, repairs, decisions, delegation state, or outcomes.
|
|
30
32
|
|
|
31
33
|
Includes:
|
|
32
34
|
|
|
@@ -34,7 +36,7 @@ Includes:
|
|
|
34
36
|
- `SOURCE-CORPUS.md`
|
|
35
37
|
- `WORK-UNITS.md`
|
|
36
38
|
- `DOSSIER.md`
|
|
37
|
-
- `
|
|
39
|
+
- `WORKER-MAP.md`
|
|
38
40
|
- `ACCEPTANCE-MATRIX.md`
|
|
39
41
|
- `VERIFICATION-REPORT.md`
|
|
40
42
|
- `REPAIR-TICKETS.md`
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
# Workflow Control Templates
|
|
2
2
|
|
|
3
|
-
Use these for supervised workflow state. Do not use them for ordinary documentation drafting unless workflow state or
|
|
3
|
+
Use these for supervised workflow state. Do not use them for ordinary documentation drafting unless workflow state or continuation is required.
|
|
4
4
|
|
|
5
5
|
Default path: create these files under `<workspace>/.workflow/` unless the user provides another artifact directory or the project already has an established workflow-state location.
|
|
6
6
|
|
|
7
|
+
Git rule: in a Git-backed codebase, ensure `<workspace>/.gitignore` contains `.workflow/` before creating this directory. Treat `.workflow/` as local workflow memory; do not stage, commit, push, or include it in a PR unless the user explicitly makes workflow state a final deliverable.
|
|
8
|
+
|
|
7
9
|
## WORKFLOW.md
|
|
8
10
|
|
|
9
11
|
```md
|
|
@@ -68,7 +70,7 @@ Default path: create these files under `<workspace>/.workflow/` unless the user
|
|
|
68
70
|
```md
|
|
69
71
|
# Work Units
|
|
70
72
|
|
|
71
|
-
| ID |
|
|
73
|
+
| ID | Worker Slug | Title | Objective | Dependencies | Status | Verification |
|
|
72
74
|
|---|---|---|---|---|---|---|
|
|
73
75
|
|
|
74
76
|
## Sequencing
|
|
@@ -85,9 +87,11 @@ Default path: create these files under `<workspace>/.workflow/` unless the user
|
|
|
85
87
|
|
|
86
88
|
## Dossier ID
|
|
87
89
|
|
|
88
|
-
##
|
|
90
|
+
## Worker Name
|
|
91
|
+
|
|
92
|
+
## Worker Role
|
|
89
93
|
|
|
90
|
-
##
|
|
94
|
+
## Delegation Transport
|
|
91
95
|
|
|
92
96
|
## Start Condition
|
|
93
97
|
|
|
@@ -117,7 +121,7 @@ Default path: create these files under `<workspace>/.workflow/` unless the user
|
|
|
117
121
|
|
|
118
122
|
## Owner Or Contributor Role
|
|
119
123
|
|
|
120
|
-
##
|
|
124
|
+
## Worker Prompt
|
|
121
125
|
|
|
122
126
|
## Supervisor Checkpoints
|
|
123
127
|
|
|
@@ -128,19 +132,19 @@ Default path: create these files under `<workspace>/.workflow/` unless the user
|
|
|
128
132
|
## Open Questions
|
|
129
133
|
```
|
|
130
134
|
|
|
131
|
-
##
|
|
135
|
+
## WORKER-MAP.md
|
|
132
136
|
|
|
133
137
|
```md
|
|
134
|
-
#
|
|
138
|
+
# Worker Map
|
|
135
139
|
|
|
136
|
-
|
|
|
140
|
+
| Worker Name | Role | Transport | Work Unit | Dossier | Start Condition | Dependencies | Status | Terminal Report |
|
|
137
141
|
|---|---|---|---|---|---|---|---|---|
|
|
138
142
|
|
|
139
143
|
## Supervisor Checkpoints
|
|
140
144
|
|
|
141
|
-
## Blocked
|
|
145
|
+
## Blocked Workers
|
|
142
146
|
|
|
143
|
-
## Closed
|
|
147
|
+
## Closed Workers
|
|
144
148
|
```
|
|
145
149
|
|
|
146
150
|
## ACCEPTANCE-MATRIX.md
|
|
@@ -165,7 +169,7 @@ Status: PASS | FAIL | BLOCKED | NEEDS REVISION | APPROVED WITH CAVEATS | READY T
|
|
|
165
169
|
|
|
166
170
|
Verified Work Unit:
|
|
167
171
|
|
|
168
|
-
Verified
|
|
172
|
+
Verified Worker:
|
|
169
173
|
|
|
170
174
|
## Sources Inspected
|
|
171
175
|
|
|
@@ -262,7 +266,7 @@ Final Disposition Policy:
|
|
|
262
266
|
|
|
263
267
|
## Work Completed
|
|
264
268
|
|
|
265
|
-
##
|
|
269
|
+
## Workers
|
|
266
270
|
|
|
267
271
|
## Verification Evidence
|
|
268
272
|
|