workflow-supervisor 0.1.0
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/LICENSE +21 -0
- package/README.md +266 -0
- package/adapters/claude-code/adapter.json +7 -0
- package/adapters/codex/adapter.json +8 -0
- package/adapters/hermesagent/adapter.json +8 -0
- package/adapters/opencode/adapter.json +8 -0
- package/assets/workflow-supervisor-hero.png +0 -0
- package/bin/workflow-skills +2 -0
- package/bin/workflow-skills.mjs +452 -0
- package/docs/artifacts.md +40 -0
- package/docs/cli.md +119 -0
- package/docs/compatibility.md +85 -0
- package/docs/skill-reference.md +33 -0
- package/docs/troubleshooting.md +38 -0
- package/package.json +45 -0
- package/skills/acceptance-matrix/SKILL.md +77 -0
- package/skills/acceptance-matrix/agents/openai.yaml +7 -0
- package/skills/dossier-builder/SKILL.md +93 -0
- package/skills/dossier-builder/agents/openai.yaml +7 -0
- package/skills/loop-policy/SKILL.md +103 -0
- package/skills/loop-policy/agents/openai.yaml +7 -0
- package/skills/source-corpus/SKILL.md +92 -0
- package/skills/source-corpus/agents/openai.yaml +7 -0
- package/skills/work-unit/SKILL.md +72 -0
- package/skills/work-unit/agents/openai.yaml +7 -0
- package/skills/worker-roles/SKILL.md +115 -0
- package/skills/worker-roles/agents/openai.yaml +7 -0
- package/skills/workflow-docs/SKILL.md +88 -0
- package/skills/workflow-docs/agents/openai.yaml +7 -0
- package/skills/workflow-docs/references/documentation-production.md +230 -0
- package/skills/workflow-docs/references/goal-resume.md +62 -0
- package/skills/workflow-docs/references/templates.md +53 -0
- package/skills/workflow-docs/references/workflow-control.md +276 -0
- package/skills/workflow-supervisor/SKILL.md +254 -0
- package/skills/workflow-supervisor/agents/openai.yaml +7 -0
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: worker-roles
|
|
3
|
+
description: Define narrow role contracts only when creating explicit worker prompts or separating responsibilities across multiple agents, threads, reviewers, or formal handoffs. 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 thread.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Worker Roles
|
|
7
|
+
|
|
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
|
+
|
|
10
|
+
No worker thread 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
|
+
|
|
12
|
+
## Domain Neutrality
|
|
13
|
+
|
|
14
|
+
Use "Executor" or "Producer" instead of "Implementer" when the work is documentation, research, design, planning, operations, data, or other non-code production. Use "artifact changed" instead of "files changed" when the mutable output is not a file.
|
|
15
|
+
|
|
16
|
+
## Solo Mode
|
|
17
|
+
|
|
18
|
+
When separate agents, threads, 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
|
+
|
|
20
|
+
## Role Contracts
|
|
21
|
+
|
|
22
|
+
### Implementer Or Executor
|
|
23
|
+
|
|
24
|
+
- May edit only allowed surfaces.
|
|
25
|
+
- Must not stage, commit, publish, approve, or edit workflow records unless assigned.
|
|
26
|
+
- Starts only after complete intake and the path gate are satisfied and the supervisor sends the implementation dossier.
|
|
27
|
+
- Must report files or artifacts changed, decisions followed, checks run or evidence produced, skipped checks, assumptions, and acceptance mapping.
|
|
28
|
+
|
|
29
|
+
### Verifier
|
|
30
|
+
|
|
31
|
+
- Must not edit files except unavoidable command side effects.
|
|
32
|
+
- Must inspect sources and diff/artifacts independently.
|
|
33
|
+
- Starts only after the relevant implementer or repair report is available.
|
|
34
|
+
- Must map every acceptance item to evidence.
|
|
35
|
+
- Must return PASS, FAIL, or BLOCKED.
|
|
36
|
+
- Must list repair intent only, not code changes.
|
|
37
|
+
|
|
38
|
+
### Researcher
|
|
39
|
+
|
|
40
|
+
- Finds and ranks evidence.
|
|
41
|
+
- Must distinguish source claims from inference.
|
|
42
|
+
- Must not decide implementation scope.
|
|
43
|
+
|
|
44
|
+
### Repair-Ticket Author
|
|
45
|
+
|
|
46
|
+
- Converts verifier findings into actionable tickets.
|
|
47
|
+
- Must not invent new scope.
|
|
48
|
+
- Starts only after a verifier returns FAIL or BLOCKED with actionable findings.
|
|
49
|
+
- Must include severity, affected surfaces or artifacts, problem, required repair, required checks or evidence, and acceptance criteria.
|
|
50
|
+
- Must link each ticket to a verifier finding ID, acceptance row, or exact evidence gap.
|
|
51
|
+
|
|
52
|
+
### Documenter
|
|
53
|
+
|
|
54
|
+
- Creates or updates workflow artifacts from evidence.
|
|
55
|
+
- Starts after complete intake and the path gate for planning docs, or after implementation and verification evidence exists for outcome docs.
|
|
56
|
+
- Must preserve unknowns and residual risks.
|
|
57
|
+
- Must not turn unresolved questions into facts.
|
|
58
|
+
|
|
59
|
+
### Editor
|
|
60
|
+
|
|
61
|
+
- Revises content for audience, structure, clarity, voice, and completeness.
|
|
62
|
+
- Must not invent unsupported facts or erase source uncertainty.
|
|
63
|
+
- Must report changed sections, rationale, open questions, and review needs.
|
|
64
|
+
|
|
65
|
+
### Subject-Matter Reviewer
|
|
66
|
+
|
|
67
|
+
- Reviews factual accuracy within an assigned domain.
|
|
68
|
+
- Must distinguish required corrections from preferences.
|
|
69
|
+
- Must cite sources or expertise basis for material changes.
|
|
70
|
+
|
|
71
|
+
### Approver
|
|
72
|
+
|
|
73
|
+
- Grants or withholds publication or workflow approval.
|
|
74
|
+
- Must name caveats, required follow-ups, and expiration or review cadence when relevant.
|
|
75
|
+
|
|
76
|
+
### Reviewer
|
|
77
|
+
|
|
78
|
+
- Reviews completed artifacts, plans, or changes.
|
|
79
|
+
- Must prioritize issues and missing evidence.
|
|
80
|
+
- Must not silently repair unless explicitly assigned.
|
|
81
|
+
|
|
82
|
+
### Synthesizer
|
|
83
|
+
|
|
84
|
+
- Compresses context for continuation.
|
|
85
|
+
- Must preserve decisions, blockers, sources, checks, and next actions.
|
|
86
|
+
|
|
87
|
+
## Anti Role-Bleed Rules
|
|
88
|
+
|
|
89
|
+
- A verifier that edits implementation has invalidated independence.
|
|
90
|
+
- An implementer that declares final PASS without verifier evidence is premature.
|
|
91
|
+
- A repair author that adds product requirements is expanding scope.
|
|
92
|
+
- A documenter that hides unknowns is corrupting resume state.
|
|
93
|
+
- A supervisor that implements code should mark that role switch explicitly.
|
|
94
|
+
- Same-thread verification is a self-check unless an independent verifier separately inspects the evidence.
|
|
95
|
+
|
|
96
|
+
## Worker Prompt Minimums
|
|
97
|
+
|
|
98
|
+
Include:
|
|
99
|
+
|
|
100
|
+
- thread name
|
|
101
|
+
- role name
|
|
102
|
+
- work unit and objective
|
|
103
|
+
- must-read sources
|
|
104
|
+
- allowed and forbidden surfaces
|
|
105
|
+
- acceptance criteria
|
|
106
|
+
- stop gates
|
|
107
|
+
- exact report schema
|
|
108
|
+
|
|
109
|
+
## Thread Interaction Rules
|
|
110
|
+
|
|
111
|
+
- Workers should acknowledge the handoff before acting.
|
|
112
|
+
- Workers should ask the supervisor for clarification when a blocker affects scope, sources, surfaces, checks, or acceptance.
|
|
113
|
+
- Workers should not message other worker threads directly unless the supervisor allows it in the loop policy.
|
|
114
|
+
- Workers should send one terminal report with PASS, FAIL, BLOCKED, or PARTIAL status using the assigned schema.
|
|
115
|
+
- Verifier and repair threads should cite acceptance row IDs and prior report IDs so the supervisor can route the loop.
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: workflow-docs
|
|
3
|
+
description: Generate or refresh durable workflow-state, handoff, 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
|
+
---
|
|
5
|
+
|
|
6
|
+
# Workflow Docs
|
|
7
|
+
|
|
8
|
+
Use this skill to make the workspace remember the workflow. These Markdown files are working artifacts, not explanatory essays.
|
|
9
|
+
|
|
10
|
+
## No-Prerequisite Mode
|
|
11
|
+
|
|
12
|
+
Do not require existing Markdown files. You may create a minimal doc set from conversation context alone, as long as unknowns are marked. For non-document workflows, create only the artifacts that help the next agent or human continue.
|
|
13
|
+
|
|
14
|
+
## State Artifact Medium
|
|
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 handoff. Choose the medium that the next human or agent can actually use.
|
|
17
|
+
|
|
18
|
+
## Default Artifact Directory
|
|
19
|
+
|
|
20
|
+
When creating Markdown workflow artifacts, use `<workspace>/.workflow/` as the default directory. Treat `<workspace>` as the active project root, repository root, or user-provided working directory. If the task has no stable workspace, keep state inline or ask where to write it.
|
|
21
|
+
|
|
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
|
+
|
|
24
|
+
## Artifact Lanes
|
|
25
|
+
|
|
26
|
+
Use two lanes:
|
|
27
|
+
|
|
28
|
+
- Workflow control: preserve state, decisions, work units, handoffs, verification, and outcomes.
|
|
29
|
+
- Documentation production: define audience, purpose, content inventory, outline, style, review path, publication readiness, and maintenance.
|
|
30
|
+
|
|
31
|
+
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.
|
|
32
|
+
|
|
33
|
+
## Modes
|
|
34
|
+
|
|
35
|
+
- Scaffold blank artifacts for a new workflow.
|
|
36
|
+
- Generate artifacts from conversation, source inspection, or supervisor state.
|
|
37
|
+
- Refresh existing artifacts while preserving unresolved questions and decisions.
|
|
38
|
+
- Create a resume pack for another thread or future session.
|
|
39
|
+
- Convert verification and repair results into durable reports.
|
|
40
|
+
- Preserve thread plans, worker handoffs, terminal reports, and final disposition decisions when supervised work spans threads.
|
|
41
|
+
|
|
42
|
+
## Rules
|
|
43
|
+
|
|
44
|
+
- Load [references/templates.md](references/templates.md) first when choosing exact templates, then load only the referenced lane file needed for the task.
|
|
45
|
+
- 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, handoffs, and outcomes.
|
|
47
|
+
- Load [references/goal-resume.md](references/goal-resume.md) for Codex goal mirrors, active-goal conflicts, and resume packs.
|
|
48
|
+
- Keep facts, assumptions, open questions, and inferences separate.
|
|
49
|
+
- Include paths, commands, sources, and evidence when available.
|
|
50
|
+
- Do not hide missing information. Use `Unknown` or `Blocked` with reason.
|
|
51
|
+
- Prefer concise tables and checklists over narrative.
|
|
52
|
+
- Do not create files the workflow will not use.
|
|
53
|
+
- Reject requests to create every possible workflow document "just in case"; select the smallest doc set that preserves state or enables production.
|
|
54
|
+
- Do not treat workflow docs as a required provenance ledger; use them as lightweight working memory.
|
|
55
|
+
- Adapt headings from files and commands to artifacts and evidence for non-code workflows.
|
|
56
|
+
- Preserve acceptance matrices and verification reports; do not reinterpret evidence rows or change verdicts unless the workflow explicitly asks for a review/update.
|
|
57
|
+
|
|
58
|
+
## Artifact Selection
|
|
59
|
+
|
|
60
|
+
- `.workflow/WORKFLOW.md`: overall objective, policy, state, units, and next action.
|
|
61
|
+
- `.workflow/SOURCE-CORPUS.md`: source map, authority ranking, contradictions, gaps.
|
|
62
|
+
- `.workflow/WORK-UNITS.md`: decomposition and sequencing.
|
|
63
|
+
- `.workflow/DOSSIER.md`: handoff contract for one unit.
|
|
64
|
+
- `.workflow/THREAD-MAP.md`: thread names, roles, dossiers, dependencies, start conditions, report status, and supervisor checkpoints.
|
|
65
|
+
- `.workflow/ACCEPTANCE-MATRIX.md`: verifiable done criteria.
|
|
66
|
+
- `.workflow/VERIFICATION-REPORT.md`: evidence-backed PASS/FAIL/BLOCKED report.
|
|
67
|
+
- `.workflow/REPAIR-TICKETS.md`: actionable repair tasks from verifier findings.
|
|
68
|
+
- `.workflow/DECISIONS.md`: durable decisions, assumptions, and reversals.
|
|
69
|
+
- `.workflow/HANDOFF.md`: resume state for another agent or session.
|
|
70
|
+
- `.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 handoff.
|
|
72
|
+
- `.workflow/DOCUMENTATION-BRIEF.md`: audience, purpose, document type, reader task, channel, owner, approvers, and success criteria.
|
|
73
|
+
- `.workflow/CONTENT-INVENTORY.md`: existing materials, reusable sections, gaps, stale areas, and owners.
|
|
74
|
+
- `.workflow/OUTLINE.md`: information architecture, section hierarchy, and required content.
|
|
75
|
+
- `.workflow/STYLE-GUIDE.md`: tone, terminology, formatting, examples, and banned phrasing.
|
|
76
|
+
- `.workflow/GLOSSARY.md`: approved terms, definitions, aliases, and deprecated terms.
|
|
77
|
+
- `.workflow/REVIEW-PLAN.md`: SME, editorial, legal, compliance, accessibility, localization, and approval steps.
|
|
78
|
+
- `.workflow/REVISION-QUEUE.md`: section-level feedback and editorial repair tasks.
|
|
79
|
+
- `.workflow/PUBLISHING-CHECKLIST.md`: metadata, links, assets, permissions, approvals, and launch target.
|
|
80
|
+
- `.workflow/MAINTENANCE-PLAN.md`: owner, review cadence, expiry date, and update triggers.
|
|
81
|
+
- `.workflow/CONTENT-DRAFT.md`: actual documentation draft body with audience, reader task, sources, open claims, examples, review status, and publishing target.
|
|
82
|
+
- `.workflow/CLAIMS-REGISTER.md`: claim-level source, citation, confidence, reviewer, status, rights, and recheck tracking.
|
|
83
|
+
- `.workflow/ASSET-REGISTER.md`: images, diagrams, videos, source files, licenses, owners, and usage status.
|
|
84
|
+
- `.workflow/PUBLICATION-LOG.md`: channel, version, approver, date, and notes for published artifacts.
|
|
85
|
+
|
|
86
|
+
## Output Requirement
|
|
87
|
+
|
|
88
|
+
When generating docs, report which files were created or updated, which artifact directory was used, which sources informed them, and which fields remain unknown.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
interface:
|
|
2
|
+
display_name: "Workflow Docs"
|
|
3
|
+
short_description: "Preserve workflow and thread state"
|
|
4
|
+
default_prompt: "Use $workflow-docs to create or refresh .workflow/ artifacts that preserve workflow, thread, handoff, verification, and outcome state."
|
|
5
|
+
|
|
6
|
+
policy:
|
|
7
|
+
allow_implicit_invocation: false
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
# Documentation Production Templates
|
|
2
|
+
|
|
3
|
+
Use these for documentation production. Do not create all of them by default; select the smallest set that supports the document type and review path.
|
|
4
|
+
|
|
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
|
+
|
|
7
|
+
## Presets
|
|
8
|
+
|
|
9
|
+
- Public article: `DOCUMENTATION-BRIEF.md`, `CONTENT-INVENTORY.md`, `OUTLINE.md`, `CONTENT-DRAFT.md`, `REVIEW-PLAN.md`, `PUBLISHING-CHECKLIST.md`.
|
|
10
|
+
- Fact-heavy reference: `DOCUMENTATION-BRIEF.md`, `SOURCE-CORPUS.md`, `CLAIMS-REGISTER.md`, `GLOSSARY.md`, `MAINTENANCE-PLAN.md`.
|
|
11
|
+
- SOP or runbook: `DOCUMENTATION-BRIEF.md`, `OUTLINE.md`, `CONTENT-DRAFT.md`, `REVIEW-PLAN.md`, `PUBLISHING-CHECKLIST.md`, `MAINTENANCE-PLAN.md`.
|
|
12
|
+
- Release notes: `DOCUMENTATION-BRIEF.md`, `CONTENT-INVENTORY.md`, `CONTENT-DRAFT.md`, `REVIEW-PLAN.md`, `PUBLICATION-LOG.md`.
|
|
13
|
+
- Research memo: `DOCUMENTATION-BRIEF.md`, `SOURCE-CORPUS.md`, `CLAIMS-REGISTER.md`, `CONTENT-DRAFT.md`, `REVIEW-PLAN.md`.
|
|
14
|
+
|
|
15
|
+
## DOCUMENTATION-BRIEF.md
|
|
16
|
+
|
|
17
|
+
```md
|
|
18
|
+
# Documentation Brief
|
|
19
|
+
|
|
20
|
+
## Document Type
|
|
21
|
+
|
|
22
|
+
## Audience
|
|
23
|
+
|
|
24
|
+
## Reader Knowledge Level
|
|
25
|
+
|
|
26
|
+
## Reader Tasks
|
|
27
|
+
|
|
28
|
+
## Desired Reader Action
|
|
29
|
+
|
|
30
|
+
## Primary Use Case
|
|
31
|
+
|
|
32
|
+
## Publishing Target Or Channel
|
|
33
|
+
|
|
34
|
+
## Owner
|
|
35
|
+
|
|
36
|
+
## Approvers
|
|
37
|
+
|
|
38
|
+
## Scope
|
|
39
|
+
|
|
40
|
+
## Non-Goals
|
|
41
|
+
|
|
42
|
+
## Source Requirements
|
|
43
|
+
|
|
44
|
+
## Confidentiality Or Access Constraints
|
|
45
|
+
|
|
46
|
+
## Freshness Requirement
|
|
47
|
+
|
|
48
|
+
## Voice And Tone
|
|
49
|
+
|
|
50
|
+
## Success Criteria Or Analytics Signal
|
|
51
|
+
|
|
52
|
+
## Constraints
|
|
53
|
+
|
|
54
|
+
## Open Questions
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## CONTENT-INVENTORY.md
|
|
58
|
+
|
|
59
|
+
```md
|
|
60
|
+
# Content Inventory
|
|
61
|
+
|
|
62
|
+
| Material | Type | Canonical Location | Owner | Version | Last Reviewed | License Or Permission | Current State | Reuse Candidate | Stale Areas | Gaps | Action Needed | Risk |
|
|
63
|
+
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
64
|
+
|
|
65
|
+
## Missing Materials
|
|
66
|
+
|
|
67
|
+
## Reuse Plan
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## OUTLINE.md
|
|
71
|
+
|
|
72
|
+
```md
|
|
73
|
+
# Outline
|
|
74
|
+
|
|
75
|
+
## Information Architecture
|
|
76
|
+
|
|
77
|
+
| Section | Reader Task | Key Question | Evidence Or Source | Examples Or Assets | Acceptance Criteria | Owner | Status |
|
|
78
|
+
|---|---|---|---|---|---|---|---|
|
|
79
|
+
|
|
80
|
+
## Navigation Or Reading Flow
|
|
81
|
+
|
|
82
|
+
## Required Examples
|
|
83
|
+
|
|
84
|
+
## Open Structure Questions
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## CONTENT-DRAFT.md
|
|
88
|
+
|
|
89
|
+
```md
|
|
90
|
+
# Content Draft
|
|
91
|
+
|
|
92
|
+
Status: Draft | Needs Review | Ready To Publish | Blocked
|
|
93
|
+
|
|
94
|
+
## Title
|
|
95
|
+
|
|
96
|
+
## Audience
|
|
97
|
+
|
|
98
|
+
## Reader Task
|
|
99
|
+
|
|
100
|
+
## Publishing Target
|
|
101
|
+
|
|
102
|
+
## Source Notes
|
|
103
|
+
|
|
104
|
+
## Draft Body
|
|
105
|
+
|
|
106
|
+
## Open Claims
|
|
107
|
+
|
|
108
|
+
| Claim | Location | Source Needed | Status |
|
|
109
|
+
|---|---|---|---|
|
|
110
|
+
|
|
111
|
+
## Examples Or Assets
|
|
112
|
+
|
|
113
|
+
## Review Status
|
|
114
|
+
|
|
115
|
+
## Open Questions
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## CLAIMS-REGISTER.md
|
|
119
|
+
|
|
120
|
+
```md
|
|
121
|
+
# Claims Register
|
|
122
|
+
|
|
123
|
+
| Claim | Location | Source | Citation Needed | Usage Rights | Confidence | Reviewer | Status | Expiry Or Recheck Trigger |
|
|
124
|
+
|---|---|---|---|---|---|---|---|---|
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## STYLE-GUIDE.md
|
|
128
|
+
|
|
129
|
+
```md
|
|
130
|
+
# Style Guide
|
|
131
|
+
|
|
132
|
+
## Voice And Tone
|
|
133
|
+
|
|
134
|
+
## Terminology
|
|
135
|
+
|
|
136
|
+
| Preferred Term | Definition | Avoid | Notes |
|
|
137
|
+
|---|---|---|---|
|
|
138
|
+
|
|
139
|
+
## Formatting Rules
|
|
140
|
+
|
|
141
|
+
## Examples
|
|
142
|
+
|
|
143
|
+
## Banned Phrasing
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## GLOSSARY.md
|
|
147
|
+
|
|
148
|
+
```md
|
|
149
|
+
# Glossary
|
|
150
|
+
|
|
151
|
+
| Term | Definition | Aliases | Deprecated Terms | Source |
|
|
152
|
+
|---|---|---|---|---|
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
## ASSET-REGISTER.md
|
|
156
|
+
|
|
157
|
+
```md
|
|
158
|
+
# Asset Register
|
|
159
|
+
|
|
160
|
+
| Asset | Type | Source | Owner | License Or Permission | Used In | Status | Risk |
|
|
161
|
+
|---|---|---|---|---|---|---|---|
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
## REVIEW-PLAN.md
|
|
165
|
+
|
|
166
|
+
```md
|
|
167
|
+
# Review Plan
|
|
168
|
+
|
|
169
|
+
| Review Type | Reviewer | Scope | Required Before | Status |
|
|
170
|
+
|---|---|---|---|---|
|
|
171
|
+
|
|
172
|
+
## Approval Path
|
|
173
|
+
|
|
174
|
+
## Review Cadence
|
|
175
|
+
|
|
176
|
+
## Blocking Reviews
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
## REVISION-QUEUE.md
|
|
180
|
+
|
|
181
|
+
```md
|
|
182
|
+
# Revision Queue
|
|
183
|
+
|
|
184
|
+
| ID | Location | Reviewer | Issue Type | Audience Impact | Requested Change | Owner | Due Date | Status | Validation |
|
|
185
|
+
|---|---|---|---|---|---|---|---|---|---|
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
## PUBLISHING-CHECKLIST.md
|
|
189
|
+
|
|
190
|
+
```md
|
|
191
|
+
# Publishing Checklist
|
|
192
|
+
|
|
193
|
+
| Item | Owner | Status | Evidence |
|
|
194
|
+
|---|---|---|---|
|
|
195
|
+
|
|
196
|
+
## Metadata
|
|
197
|
+
|
|
198
|
+
## Links And Assets
|
|
199
|
+
|
|
200
|
+
## Permissions
|
|
201
|
+
|
|
202
|
+
## Approvals
|
|
203
|
+
|
|
204
|
+
## Launch Target
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
## PUBLICATION-LOG.md
|
|
208
|
+
|
|
209
|
+
```md
|
|
210
|
+
# Publication Log
|
|
211
|
+
|
|
212
|
+
| Date | Artifact | Channel | Version | Approver | Notes |
|
|
213
|
+
|---|---|---|---|---|---|
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
## MAINTENANCE-PLAN.md
|
|
217
|
+
|
|
218
|
+
```md
|
|
219
|
+
# Maintenance Plan
|
|
220
|
+
|
|
221
|
+
## Owner
|
|
222
|
+
|
|
223
|
+
## Review Cadence
|
|
224
|
+
|
|
225
|
+
## Expiry Or Review Date
|
|
226
|
+
|
|
227
|
+
## Update Triggers
|
|
228
|
+
|
|
229
|
+
## Monitoring Sources
|
|
230
|
+
```
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Goal And Resume Templates
|
|
2
|
+
|
|
3
|
+
Use these only for Codex goal mirroring, active-goal conflicts, or resume packs.
|
|
4
|
+
|
|
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
|
+
|
|
7
|
+
## Goal-Aware WORKFLOW.md Fields
|
|
8
|
+
|
|
9
|
+
```md
|
|
10
|
+
## Goal Binding
|
|
11
|
+
|
|
12
|
+
- Goal Binding: created | reused | skipped | unavailable | conflict
|
|
13
|
+
- Goal Status: active | complete | blocked | unknown
|
|
14
|
+
- Last Goal Tool Action: get_goal | create_goal | update_goal | none
|
|
15
|
+
- Next Allowed Goal Action:
|
|
16
|
+
- Goal Objective:
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Goal-Aware OUTCOME.md Fields
|
|
20
|
+
|
|
21
|
+
```md
|
|
22
|
+
Goal Binding: created | reused | skipped | unavailable | conflict
|
|
23
|
+
Goal Status: active | complete | blocked | unknown
|
|
24
|
+
Last Goal Tool Action: get_goal | create_goal | update_goal | none
|
|
25
|
+
Next Allowed Goal Action:
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## GOAL-STATE.md
|
|
29
|
+
|
|
30
|
+
```md
|
|
31
|
+
# Goal State
|
|
32
|
+
|
|
33
|
+
## Objective
|
|
34
|
+
|
|
35
|
+
## Goal Binding
|
|
36
|
+
|
|
37
|
+
created | reused | skipped | unavailable | conflict
|
|
38
|
+
|
|
39
|
+
## Goal Status
|
|
40
|
+
|
|
41
|
+
active | complete | blocked | unknown
|
|
42
|
+
|
|
43
|
+
## Why A Goal Was Created Or Skipped
|
|
44
|
+
|
|
45
|
+
## Active Goal Conflict
|
|
46
|
+
|
|
47
|
+
## Last Tool Action
|
|
48
|
+
|
|
49
|
+
get_goal | create_goal | update_goal | none
|
|
50
|
+
|
|
51
|
+
## Next Allowed Goal Action
|
|
52
|
+
|
|
53
|
+
## Last Evidence
|
|
54
|
+
|
|
55
|
+
## Current Work Unit
|
|
56
|
+
|
|
57
|
+
## Completion Rule
|
|
58
|
+
|
|
59
|
+
## Blocked Rule
|
|
60
|
+
|
|
61
|
+
## Resume Instructions
|
|
62
|
+
```
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Workflow Docs Template Index
|
|
2
|
+
|
|
3
|
+
Load only the lane needed for the task.
|
|
4
|
+
|
|
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
|
+
|
|
7
|
+
## Documentation Production
|
|
8
|
+
|
|
9
|
+
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.
|
|
10
|
+
|
|
11
|
+
Includes:
|
|
12
|
+
|
|
13
|
+
- `DOCUMENTATION-BRIEF.md`
|
|
14
|
+
- `CONTENT-INVENTORY.md`
|
|
15
|
+
- `OUTLINE.md`
|
|
16
|
+
- `CONTENT-DRAFT.md`
|
|
17
|
+
- `CLAIMS-REGISTER.md`
|
|
18
|
+
- `STYLE-GUIDE.md`
|
|
19
|
+
- `GLOSSARY.md`
|
|
20
|
+
- `ASSET-REGISTER.md`
|
|
21
|
+
- `REVIEW-PLAN.md`
|
|
22
|
+
- `REVISION-QUEUE.md`
|
|
23
|
+
- `PUBLISHING-CHECKLIST.md`
|
|
24
|
+
- `PUBLICATION-LOG.md`
|
|
25
|
+
- `MAINTENANCE-PLAN.md`
|
|
26
|
+
|
|
27
|
+
## Workflow Control
|
|
28
|
+
|
|
29
|
+
Read [workflow-control.md](workflow-control.md) when preserving supervised workflow state, work units, dossiers, acceptance matrices, verification reports, repairs, decisions, handoffs, or outcomes.
|
|
30
|
+
|
|
31
|
+
Includes:
|
|
32
|
+
|
|
33
|
+
- `WORKFLOW.md`
|
|
34
|
+
- `SOURCE-CORPUS.md`
|
|
35
|
+
- `WORK-UNITS.md`
|
|
36
|
+
- `DOSSIER.md`
|
|
37
|
+
- `THREAD-MAP.md`
|
|
38
|
+
- `ACCEPTANCE-MATRIX.md`
|
|
39
|
+
- `VERIFICATION-REPORT.md`
|
|
40
|
+
- `REPAIR-TICKETS.md`
|
|
41
|
+
- `DECISIONS.md`
|
|
42
|
+
- `HANDOFF.md`
|
|
43
|
+
- `OUTCOME.md`
|
|
44
|
+
|
|
45
|
+
## Goal And Resume
|
|
46
|
+
|
|
47
|
+
Read [goal-resume.md](goal-resume.md) when mirroring Codex goal state, resolving active-goal conflicts, or creating resume packs.
|
|
48
|
+
|
|
49
|
+
Includes:
|
|
50
|
+
|
|
51
|
+
- `GOAL-STATE.md`
|
|
52
|
+
- goal-aware `WORKFLOW.md` fields
|
|
53
|
+
- goal-aware `OUTCOME.md` fields
|