@wefter/opencode 0.1.0 → 0.2.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/CHANGELOG.md +25 -14
- package/LICENSE +21 -21
- package/README.md +125 -112
- package/bin/wefter.js +8 -8
- package/docs/ARCHITECTURE.md +75 -79
- package/docs/INSTALLATION.md +47 -46
- package/docs/SAFETY_MODEL.md +17 -17
- package/docs/SELF_AUDIT.md +35 -0
- package/docs/WORKFLOWS.md +15 -13
- package/package.json +45 -45
- package/schemas/documentation-audit-profile.schema.json +55 -47
- package/schemas/product-shaping-config.schema.json +63 -0
- package/schemas/product-shaping-contract.schema.json +204 -0
- package/schemas/product-shaping-profile.schema.json +39 -0
- package/schemas/product-shaping-run-manifest.schema.json +103 -0
- package/schemas/run-manifest.schema.json +14 -14
- package/schemas/wefter.config.schema.json +62 -31
- package/schemas/work-unit-config.schema.json +44 -44
- package/schemas/work-unit-profile.schema.json +38 -38
- package/schemas/work-unit-review-result.schema.json +13 -13
- package/schemas/workflow-manifest.schema.json +21 -21
- package/src/cli/main.js +2646 -1858
- package/src/workflows/documentation-audit/README.md +37 -37
- package/src/workflows/documentation-audit/templates/README.md.tmpl +47 -47
- package/src/workflows/documentation-audit/templates/opencode/agent/wefter-doc-audit-consolidator.md.tmpl +27 -27
- package/src/workflows/documentation-audit/templates/opencode/agent/wefter-doc-audit-orchestrator.md.tmpl +65 -65
- package/src/workflows/documentation-audit/templates/opencode/agent/wefter-doc-audit-profile-builder.md.tmpl +58 -58
- package/src/workflows/documentation-audit/templates/opencode/agent/wefter-doc-audit-validator.md.tmpl +26 -26
- package/src/workflows/documentation-audit/templates/opencode/agent/wefter-doc-auditor.md.tmpl +28 -28
- package/src/workflows/documentation-audit/templates/opencode/skills/documentation-audit/SKILL.md.tmpl +38 -38
- package/src/workflows/documentation-audit/templates/prompts/auditor-prompt.md +97 -97
- package/src/workflows/documentation-audit/templates/prompts/consolidator-prompt.md +84 -84
- package/src/workflows/documentation-audit/templates/prompts/validator-prompt.md +92 -92
- package/src/workflows/documentation-audit/workflow.json +24 -24
- package/src/workflows/documentation-repair/README.md +11 -11
- package/src/workflows/documentation-repair/templates/opencode/agent/wefter-doc-repair-orchestrator.md.tmpl +33 -33
- package/src/workflows/documentation-repair/templates/opencode/agent/wefter-doc-repair-planner.md.tmpl +17 -17
- package/src/workflows/documentation-repair/templates/opencode/agent/wefter-doc-repair-reviewer.md.tmpl +17 -17
- package/src/workflows/documentation-repair/templates/opencode/agent/wefter-doc-repairer.md.tmpl +14 -14
- package/src/workflows/documentation-repair/templates/opencode/skills/documentation-repair/SKILL.md.tmpl +17 -17
- package/src/workflows/documentation-repair/templates/prompts/repair-apply-prompt.md +43 -43
- package/src/workflows/documentation-repair/templates/prompts/repair-plan-prompt.md +73 -73
- package/src/workflows/documentation-repair/templates/prompts/repair-review-prompt.md +47 -47
- package/src/workflows/documentation-repair/workflow.json +10 -10
- package/src/workflows/product-shaping/README.md +1245 -7
- package/src/workflows/product-shaping/compatibility.md +33 -0
- package/src/workflows/product-shaping/contracts/product-spec-contract.json +250 -0
- package/src/workflows/product-shaping/templates/default-config.json +34 -0
- package/src/workflows/product-shaping/templates/default-profile.json +48 -0
- package/src/workflows/product-shaping/templates/documentation-audit/workflow-self-audit-auditor-prompt.md +116 -0
- package/src/workflows/product-shaping/templates/documentation-audit-profile.json +80 -0
- package/src/workflows/product-shaping/templates/opencode/agent/wefter-product-auditor.md.tmpl +22 -0
- package/src/workflows/product-shaping/templates/opencode/agent/wefter-product-domain-modeler.md.tmpl +31 -0
- package/src/workflows/product-shaping/templates/opencode/agent/wefter-product-intake-analyst.md.tmpl +31 -0
- package/src/workflows/product-shaping/templates/opencode/agent/wefter-product-orchestrator.md.tmpl +48 -0
- package/src/workflows/product-shaping/templates/opencode/agent/wefter-product-reference-researcher.md.tmpl +29 -0
- package/src/workflows/product-shaping/templates/opencode/agent/wefter-product-release-planner.md.tmpl +34 -0
- package/src/workflows/product-shaping/templates/opencode/agent/wefter-product-repairer.md.tmpl +25 -0
- package/src/workflows/product-shaping/templates/opencode/agent/wefter-product-shaper.md.tmpl +31 -0
- package/src/workflows/product-shaping/templates/opencode/agent/wefter-product-validator.md.tmpl +23 -0
- package/src/workflows/product-shaping/templates/opencode/skills/product-shaping/SKILL.md.tmpl +45 -0
- package/src/workflows/product-shaping/templates/prompts/domain-modeler-prompt.md +27 -0
- package/src/workflows/product-shaping/templates/prompts/intake-prompt.md +30 -0
- package/src/workflows/product-shaping/templates/prompts/product-auditor-prompt.md +53 -0
- package/src/workflows/product-shaping/templates/prompts/product-repairer-prompt.md +25 -0
- package/src/workflows/product-shaping/templates/prompts/product-shaper-prompt.md +26 -0
- package/src/workflows/product-shaping/templates/prompts/product-validator-prompt.md +55 -0
- package/src/workflows/product-shaping/templates/prompts/reference-research-prompt.md +25 -0
- package/src/workflows/product-shaping/templates/prompts/release-planner-prompt.md +34 -0
- package/src/workflows/product-shaping/workflow.json +33 -10
- package/src/workflows/technical-shaping/README.md +5 -5
- package/src/workflows/technical-shaping/workflow.json +10 -10
- package/src/workflows/work-unit-implementation/README.md +71 -71
- package/src/workflows/work-unit-implementation/templates/default-config.json +46 -46
- package/src/workflows/work-unit-implementation/templates/default-profile.json +57 -57
- package/src/workflows/work-unit-implementation/templates/opencode/agent/wefter-work-unit-orchestrator.md.tmpl +62 -62
- package/src/workflows/work-unit-implementation/templates/opencode/agent/wefter-work-unit-plan-auditor.md.tmpl +26 -26
- package/src/workflows/work-unit-implementation/templates/opencode/agent/wefter-work-unit-plan-consolidator.md.tmpl +26 -26
- package/src/workflows/work-unit-implementation/templates/opencode/agent/wefter-work-unit-plan-repairer.md.tmpl +25 -25
- package/src/workflows/work-unit-implementation/templates/opencode/agent/wefter-work-unit-plan-validator.md.tmpl +25 -25
- package/src/workflows/work-unit-implementation/templates/opencode/agent/wefter-work-unit-planner.md.tmpl +27 -27
- package/src/workflows/work-unit-implementation/templates/opencode/agent/wefter-work-unit-task-implementer.md.tmpl +30 -30
- package/src/workflows/work-unit-implementation/templates/opencode/agent/wefter-work-unit-task-reviewer.md.tmpl +28 -28
- package/src/workflows/work-unit-implementation/templates/opencode/agent/wefter-work-unit-validator.md.tmpl +26 -26
- package/src/workflows/work-unit-implementation/templates/opencode/skills/work-unit-implementation/SKILL.md.tmpl +25 -25
- package/src/workflows/work-unit-implementation/templates/prompts/plan-auditor-prompt.md +89 -89
- package/src/workflows/work-unit-implementation/templates/prompts/plan-consolidator-prompt.md +64 -64
- package/src/workflows/work-unit-implementation/templates/prompts/plan-repairer-prompt.md +42 -42
- package/src/workflows/work-unit-implementation/templates/prompts/plan-validator-prompt.md +84 -84
- package/src/workflows/work-unit-implementation/templates/prompts/planner-prompt.md +150 -150
- package/src/workflows/work-unit-implementation/templates/prompts/task-implementation-prompt.md +57 -57
- package/src/workflows/work-unit-implementation/templates/prompts/task-review-prompt.md +69 -69
- package/src/workflows/work-unit-implementation/templates/prompts/work-unit-validator-prompt.md +50 -50
- package/src/workflows/work-unit-implementation/workflow.json +14 -14
|
@@ -1,38 +1,38 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: documentation-audit
|
|
3
|
-
description: Use when the user asks Wefter to audit docs, cross-check, consolidate, validate, generate an audit profile, or run redundant consistency analyses across project documentation.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Documentation Audit
|
|
7
|
-
|
|
8
|
-
Use this skill when the user wants a rigorous documentation consistency audit across the project.
|
|
9
|
-
|
|
10
|
-
Local workflow files:
|
|
11
|
-
|
|
12
|
-
- `{{CONFIG_FILE}}`: local paths and installation configuration.
|
|
13
|
-
- `{{PROFILE_PATH}}`: project-specific audit profile with corpus, variants and lenses.
|
|
14
|
-
- `{{PROCESS_DOC_PATH}}`: process and execution rules.
|
|
15
|
-
- `{{TEMPLATE_ROOT}}`: generic prompt templates used by `wefter docs audit`.
|
|
16
|
-
|
|
17
|
-
Operational rules:
|
|
18
|
-
|
|
19
|
-
- Audit is read-only with respect to source docs. Raw, consolidation, validation and final outputs are written under the configured artifact root.
|
|
20
|
-
- Do not fix documentation during an audit run.
|
|
21
|
-
- Do not assume source-of-truth precedence while auditing.
|
|
22
|
-
- Require concrete file/quote evidence for every finding.
|
|
23
|
-
- Consolidation must verify raw evidence before accepting candidates.
|
|
24
|
-
- Validation must try to disprove every consolidated candidate before producing the final list.
|
|
25
|
-
|
|
26
|
-
Recommended commands:
|
|
27
|
-
|
|
28
|
-
```text
|
|
29
|
-
/wefter-generate-doc-audit-profile
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Use this when the audit profile is missing, outdated or too generic. It inspects the repository and creates or proposes `{{PROFILE_PATH}}`.
|
|
33
|
-
|
|
34
|
-
```text
|
|
35
|
-
/wefter-audit-docs
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
This is the default audit entry point. It creates or resumes a run, executes auditor waves, consolidates raw findings, validates candidates adversarially, and reports the final artifact path.
|
|
1
|
+
---
|
|
2
|
+
name: documentation-audit
|
|
3
|
+
description: Use when the user asks Wefter to audit docs, cross-check, consolidate, validate, generate an audit profile, or run redundant consistency analyses across project documentation.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Documentation Audit
|
|
7
|
+
|
|
8
|
+
Use this skill when the user wants a rigorous documentation consistency audit across the project.
|
|
9
|
+
|
|
10
|
+
Local workflow files:
|
|
11
|
+
|
|
12
|
+
- `{{CONFIG_FILE}}`: local paths and installation configuration.
|
|
13
|
+
- `{{PROFILE_PATH}}`: project-specific audit profile with corpus, variants and lenses.
|
|
14
|
+
- `{{PROCESS_DOC_PATH}}`: process and execution rules.
|
|
15
|
+
- `{{TEMPLATE_ROOT}}`: generic prompt templates used by `wefter docs audit`.
|
|
16
|
+
|
|
17
|
+
Operational rules:
|
|
18
|
+
|
|
19
|
+
- Audit is read-only with respect to source docs. Raw, consolidation, validation and final outputs are written under the configured artifact root.
|
|
20
|
+
- Do not fix documentation during an audit run.
|
|
21
|
+
- Do not assume source-of-truth precedence while auditing.
|
|
22
|
+
- Require concrete file/quote evidence for every finding.
|
|
23
|
+
- Consolidation must verify raw evidence before accepting candidates.
|
|
24
|
+
- Validation must try to disprove every consolidated candidate before producing the final list.
|
|
25
|
+
|
|
26
|
+
Recommended commands:
|
|
27
|
+
|
|
28
|
+
```text
|
|
29
|
+
/wefter-generate-doc-audit-profile
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Use this when the audit profile is missing, outdated or too generic. It inspects the repository and creates or proposes `{{PROFILE_PATH}}`.
|
|
33
|
+
|
|
34
|
+
```text
|
|
35
|
+
/wefter-audit-docs
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
This is the default audit entry point. It creates or resumes a run, executes auditor waves, consolidates raw findings, validates candidates adversarially, and reports the final artifact path.
|
|
@@ -1,97 +1,97 @@
|
|
|
1
|
-
# Individual Documentation Audit
|
|
2
|
-
|
|
3
|
-
Run: `{{RUN_ID}}`
|
|
4
|
-
Audit ID: `{{AUDIT_ID}}`
|
|
5
|
-
Lens: `{{LENS_ID}}` - {{LENS_TITLE}}
|
|
6
|
-
Variant: `{{VARIANT_ID}}` - {{VARIANT_TITLE}}
|
|
7
|
-
Pass: `{{PASS_NUMBER}}`
|
|
8
|
-
Required output: `{{OUTPUT_FILE}}`
|
|
9
|
-
|
|
10
|
-
## Role
|
|
11
|
-
|
|
12
|
-
You are an independent auditor in a redundant documentation cross-check process. Your job is to find real inconsistencies, not to fix documents.
|
|
13
|
-
|
|
14
|
-
Do not assume a source of truth. If two documents conflict, report the conflict. If one document appears newer than another, record that as a hypothesis, not a decision.
|
|
15
|
-
|
|
16
|
-
## Corpus
|
|
17
|
-
|
|
18
|
-
Include:
|
|
19
|
-
|
|
20
|
-
{{CORPUS_INCLUDE}}
|
|
21
|
-
|
|
22
|
-
Exclude:
|
|
23
|
-
|
|
24
|
-
{{CORPUS_EXCLUDE}}
|
|
25
|
-
|
|
26
|
-
## Lens For This Analysis
|
|
27
|
-
|
|
28
|
-
{{LENS_FOCUS}}
|
|
29
|
-
|
|
30
|
-
## Variant For This Analysis
|
|
31
|
-
|
|
32
|
-
{{VARIANT_INSTRUCTION}}
|
|
33
|
-
|
|
34
|
-
## Mandatory Rules
|
|
35
|
-
|
|
36
|
-
- Read broadly before concluding.
|
|
37
|
-
- Use enough searches and reads to cover related documents, not only obvious filenames.
|
|
38
|
-
- Do not edit product, technical, domain or scope documentation.
|
|
39
|
-
- Write only the indicated output file.
|
|
40
|
-
- Do not report generic improvement ideas without a verifiable conflict.
|
|
41
|
-
- Do not report acceptable differences in level of detail as contradictions.
|
|
42
|
-
- If an item depends on interpretation, mark it as ambiguity or probable, not as confirmed conflict.
|
|
43
|
-
- Every finding must cite concrete evidence with file and quote.
|
|
44
|
-
- If there are no findings, still write the file with the `NO_FINDINGS` section.
|
|
45
|
-
|
|
46
|
-
## Output Format
|
|
47
|
-
|
|
48
|
-
Write exactly this Markdown shape to `{{OUTPUT_FILE}}`:
|
|
49
|
-
|
|
50
|
-
```md
|
|
51
|
-
# Raw Documentation Audit
|
|
52
|
-
|
|
53
|
-
Run: {{RUN_ID}}
|
|
54
|
-
Audit ID: {{AUDIT_ID}}
|
|
55
|
-
Lens: {{LENS_ID}} - {{LENS_TITLE}}
|
|
56
|
-
Variant: {{VARIANT_ID}} - {{VARIANT_TITLE}}
|
|
57
|
-
Pass: {{PASS_NUMBER}}
|
|
58
|
-
|
|
59
|
-
## Coverage
|
|
60
|
-
|
|
61
|
-
- Files inspected:
|
|
62
|
-
- Searches performed:
|
|
63
|
-
- Files intentionally skipped:
|
|
64
|
-
- Limits or uncertainty:
|
|
65
|
-
|
|
66
|
-
## Findings
|
|
67
|
-
|
|
68
|
-
### F-{{AUDIT_ID}}-001: <short title>
|
|
69
|
-
|
|
70
|
-
Type: Contradiction | Ambiguity | Probable staleness | Broken reference | Missing cross-reference | Code/doc drift | Scope leak | Unclassified
|
|
71
|
-
Confidence: High | Medium | Low
|
|
72
|
-
Severity: Critical | High | Medium | Low
|
|
73
|
-
Needs human decision: Yes | No
|
|
74
|
-
|
|
75
|
-
Evidence A:
|
|
76
|
-
- File: `<path>`
|
|
77
|
-
- Lines or section: `<line/section>`
|
|
78
|
-
- Quote: "<short exact quote>"
|
|
79
|
-
|
|
80
|
-
Evidence B:
|
|
81
|
-
- File: `<path>`
|
|
82
|
-
- Lines or section: `<line/section>`
|
|
83
|
-
- Quote: "<short exact quote>"
|
|
84
|
-
|
|
85
|
-
Why this conflicts:
|
|
86
|
-
<explain the incompatibility>
|
|
87
|
-
|
|
88
|
-
False-positive risk:
|
|
89
|
-
<explain why this might not be a real issue>
|
|
90
|
-
|
|
91
|
-
Suggested correction direction:
|
|
92
|
-
<do not rewrite docs; describe the likely direction if later corrected>
|
|
93
|
-
|
|
94
|
-
## NO_FINDINGS
|
|
95
|
-
|
|
96
|
-
Use this section only if no findings were identified. Explain briefly what was checked.
|
|
97
|
-
```
|
|
1
|
+
# Individual Documentation Audit
|
|
2
|
+
|
|
3
|
+
Run: `{{RUN_ID}}`
|
|
4
|
+
Audit ID: `{{AUDIT_ID}}`
|
|
5
|
+
Lens: `{{LENS_ID}}` - {{LENS_TITLE}}
|
|
6
|
+
Variant: `{{VARIANT_ID}}` - {{VARIANT_TITLE}}
|
|
7
|
+
Pass: `{{PASS_NUMBER}}`
|
|
8
|
+
Required output: `{{OUTPUT_FILE}}`
|
|
9
|
+
|
|
10
|
+
## Role
|
|
11
|
+
|
|
12
|
+
You are an independent auditor in a redundant documentation cross-check process. Your job is to find real inconsistencies, not to fix documents.
|
|
13
|
+
|
|
14
|
+
Do not assume a source of truth. If two documents conflict, report the conflict. If one document appears newer than another, record that as a hypothesis, not a decision.
|
|
15
|
+
|
|
16
|
+
## Corpus
|
|
17
|
+
|
|
18
|
+
Include:
|
|
19
|
+
|
|
20
|
+
{{CORPUS_INCLUDE}}
|
|
21
|
+
|
|
22
|
+
Exclude:
|
|
23
|
+
|
|
24
|
+
{{CORPUS_EXCLUDE}}
|
|
25
|
+
|
|
26
|
+
## Lens For This Analysis
|
|
27
|
+
|
|
28
|
+
{{LENS_FOCUS}}
|
|
29
|
+
|
|
30
|
+
## Variant For This Analysis
|
|
31
|
+
|
|
32
|
+
{{VARIANT_INSTRUCTION}}
|
|
33
|
+
|
|
34
|
+
## Mandatory Rules
|
|
35
|
+
|
|
36
|
+
- Read broadly before concluding.
|
|
37
|
+
- Use enough searches and reads to cover related documents, not only obvious filenames.
|
|
38
|
+
- Do not edit product, technical, domain or scope documentation.
|
|
39
|
+
- Write only the indicated output file.
|
|
40
|
+
- Do not report generic improvement ideas without a verifiable conflict.
|
|
41
|
+
- Do not report acceptable differences in level of detail as contradictions.
|
|
42
|
+
- If an item depends on interpretation, mark it as ambiguity or probable, not as confirmed conflict.
|
|
43
|
+
- Every finding must cite concrete evidence with file and quote.
|
|
44
|
+
- If there are no findings, still write the file with the `NO_FINDINGS` section.
|
|
45
|
+
|
|
46
|
+
## Output Format
|
|
47
|
+
|
|
48
|
+
Write exactly this Markdown shape to `{{OUTPUT_FILE}}`:
|
|
49
|
+
|
|
50
|
+
```md
|
|
51
|
+
# Raw Documentation Audit
|
|
52
|
+
|
|
53
|
+
Run: {{RUN_ID}}
|
|
54
|
+
Audit ID: {{AUDIT_ID}}
|
|
55
|
+
Lens: {{LENS_ID}} - {{LENS_TITLE}}
|
|
56
|
+
Variant: {{VARIANT_ID}} - {{VARIANT_TITLE}}
|
|
57
|
+
Pass: {{PASS_NUMBER}}
|
|
58
|
+
|
|
59
|
+
## Coverage
|
|
60
|
+
|
|
61
|
+
- Files inspected:
|
|
62
|
+
- Searches performed:
|
|
63
|
+
- Files intentionally skipped:
|
|
64
|
+
- Limits or uncertainty:
|
|
65
|
+
|
|
66
|
+
## Findings
|
|
67
|
+
|
|
68
|
+
### F-{{AUDIT_ID}}-001: <short title>
|
|
69
|
+
|
|
70
|
+
Type: Contradiction | Ambiguity | Probable staleness | Broken reference | Missing cross-reference | Code/doc drift | Scope leak | Unclassified
|
|
71
|
+
Confidence: High | Medium | Low
|
|
72
|
+
Severity: Critical | High | Medium | Low
|
|
73
|
+
Needs human decision: Yes | No
|
|
74
|
+
|
|
75
|
+
Evidence A:
|
|
76
|
+
- File: `<path>`
|
|
77
|
+
- Lines or section: `<line/section>`
|
|
78
|
+
- Quote: "<short exact quote>"
|
|
79
|
+
|
|
80
|
+
Evidence B:
|
|
81
|
+
- File: `<path>`
|
|
82
|
+
- Lines or section: `<line/section>`
|
|
83
|
+
- Quote: "<short exact quote>"
|
|
84
|
+
|
|
85
|
+
Why this conflicts:
|
|
86
|
+
<explain the incompatibility>
|
|
87
|
+
|
|
88
|
+
False-positive risk:
|
|
89
|
+
<explain why this might not be a real issue>
|
|
90
|
+
|
|
91
|
+
Suggested correction direction:
|
|
92
|
+
<do not rewrite docs; describe the likely direction if later corrected>
|
|
93
|
+
|
|
94
|
+
## NO_FINDINGS
|
|
95
|
+
|
|
96
|
+
Use this section only if no findings were identified. Explain briefly what was checked.
|
|
97
|
+
```
|
|
@@ -1,84 +1,84 @@
|
|
|
1
|
-
# Documentation Audit Consolidation
|
|
2
|
-
|
|
3
|
-
Run: `{{RUN_ID}}`
|
|
4
|
-
Raw directory: `{{RAW_DIR}}`
|
|
5
|
-
Consolidation output: `{{CONSOLIDATED_OUTPUT}}`
|
|
6
|
-
Discarded output: `{{DISCARDED_OUTPUT}}`
|
|
7
|
-
|
|
8
|
-
## Role
|
|
9
|
-
|
|
10
|
-
You are the central consolidator. Your job is to analyze raw auditor outputs, verify evidence against the original corpus, remove obvious false positives, merge duplicates and produce a consolidated candidate list.
|
|
11
|
-
|
|
12
|
-
Do not correct documentation. Do not choose a source of truth. Do not accept a finding only because many auditors repeated it. A finding with strong evidence can survive even if it appeared once.
|
|
13
|
-
|
|
14
|
-
## Tasks
|
|
15
|
-
|
|
16
|
-
- Read all files in `{{RAW_DIR}}`.
|
|
17
|
-
- For each raw finding, open the cited files and validate whether the quotes exist and support the claim.
|
|
18
|
-
- Discard items without concrete evidence, with incorrect citations or based only on opinion.
|
|
19
|
-
- Merge duplicates even when names, severity or wording differ.
|
|
20
|
-
- Separate real contradiction from acceptable differences in granularity, context, example, roadmap or document responsibility.
|
|
21
|
-
- Preserve all items that could still be real and need adversarial validation.
|
|
22
|
-
|
|
23
|
-
## Consolidated Output
|
|
24
|
-
|
|
25
|
-
Write `{{CONSOLIDATED_OUTPUT}}` with this format:
|
|
26
|
-
|
|
27
|
-
```md
|
|
28
|
-
# Consolidated Documentation Audit Candidates
|
|
29
|
-
|
|
30
|
-
Run: {{RUN_ID}}
|
|
31
|
-
|
|
32
|
-
## Summary
|
|
33
|
-
|
|
34
|
-
- Raw files inspected:
|
|
35
|
-
- Raw findings inspected:
|
|
36
|
-
- Consolidated candidates:
|
|
37
|
-
- Discarded during consolidation:
|
|
38
|
-
|
|
39
|
-
## Candidates
|
|
40
|
-
|
|
41
|
-
### C-001: <short title>
|
|
42
|
-
|
|
43
|
-
Status: Candidate pending adversarial validation
|
|
44
|
-
Type: Contradiction | Ambiguity | Probable staleness | Broken reference | Missing cross-reference | Code/doc drift | Scope leak | Unclassified
|
|
45
|
-
Confidence after consolidation: High | Medium | Low
|
|
46
|
-
Severity: Critical | High | Medium | Low
|
|
47
|
-
Needs human decision: Yes | No
|
|
48
|
-
Detected by raw findings: `<audit ids>`
|
|
49
|
-
|
|
50
|
-
Evidence set:
|
|
51
|
-
- `<file>` `<line/section>`: "<quote>"
|
|
52
|
-
- `<file>` `<line/section>`: "<quote>"
|
|
53
|
-
|
|
54
|
-
Consolidated conflict:
|
|
55
|
-
<explain the issue>
|
|
56
|
-
|
|
57
|
-
Why it survived consolidation:
|
|
58
|
-
<explain why this is not an obvious false positive>
|
|
59
|
-
|
|
60
|
-
Known false-positive risks:
|
|
61
|
-
<list risks>
|
|
62
|
-
|
|
63
|
-
Suggested correction direction:
|
|
64
|
-
<direction only; no rewrite>
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
## Discarded Output
|
|
68
|
-
|
|
69
|
-
Write `{{DISCARDED_OUTPUT}}` with this format:
|
|
70
|
-
|
|
71
|
-
```md
|
|
72
|
-
# Discarded Raw Findings
|
|
73
|
-
|
|
74
|
-
Run: {{RUN_ID}}
|
|
75
|
-
|
|
76
|
-
## Discarded
|
|
77
|
-
|
|
78
|
-
### D-001: <short title>
|
|
79
|
-
|
|
80
|
-
Raw finding ids: `<ids>`
|
|
81
|
-
Reason: Unsupported evidence | Duplicate merged | Acceptable granularity difference | Misread quote | Not a project inconsistency | Other
|
|
82
|
-
Explanation:
|
|
83
|
-
<why it was discarded or merged>
|
|
84
|
-
```
|
|
1
|
+
# Documentation Audit Consolidation
|
|
2
|
+
|
|
3
|
+
Run: `{{RUN_ID}}`
|
|
4
|
+
Raw directory: `{{RAW_DIR}}`
|
|
5
|
+
Consolidation output: `{{CONSOLIDATED_OUTPUT}}`
|
|
6
|
+
Discarded output: `{{DISCARDED_OUTPUT}}`
|
|
7
|
+
|
|
8
|
+
## Role
|
|
9
|
+
|
|
10
|
+
You are the central consolidator. Your job is to analyze raw auditor outputs, verify evidence against the original corpus, remove obvious false positives, merge duplicates and produce a consolidated candidate list.
|
|
11
|
+
|
|
12
|
+
Do not correct documentation. Do not choose a source of truth. Do not accept a finding only because many auditors repeated it. A finding with strong evidence can survive even if it appeared once.
|
|
13
|
+
|
|
14
|
+
## Tasks
|
|
15
|
+
|
|
16
|
+
- Read all files in `{{RAW_DIR}}`.
|
|
17
|
+
- For each raw finding, open the cited files and validate whether the quotes exist and support the claim.
|
|
18
|
+
- Discard items without concrete evidence, with incorrect citations or based only on opinion.
|
|
19
|
+
- Merge duplicates even when names, severity or wording differ.
|
|
20
|
+
- Separate real contradiction from acceptable differences in granularity, context, example, roadmap or document responsibility.
|
|
21
|
+
- Preserve all items that could still be real and need adversarial validation.
|
|
22
|
+
|
|
23
|
+
## Consolidated Output
|
|
24
|
+
|
|
25
|
+
Write `{{CONSOLIDATED_OUTPUT}}` with this format:
|
|
26
|
+
|
|
27
|
+
```md
|
|
28
|
+
# Consolidated Documentation Audit Candidates
|
|
29
|
+
|
|
30
|
+
Run: {{RUN_ID}}
|
|
31
|
+
|
|
32
|
+
## Summary
|
|
33
|
+
|
|
34
|
+
- Raw files inspected:
|
|
35
|
+
- Raw findings inspected:
|
|
36
|
+
- Consolidated candidates:
|
|
37
|
+
- Discarded during consolidation:
|
|
38
|
+
|
|
39
|
+
## Candidates
|
|
40
|
+
|
|
41
|
+
### C-001: <short title>
|
|
42
|
+
|
|
43
|
+
Status: Candidate pending adversarial validation
|
|
44
|
+
Type: Contradiction | Ambiguity | Probable staleness | Broken reference | Missing cross-reference | Code/doc drift | Scope leak | Unclassified
|
|
45
|
+
Confidence after consolidation: High | Medium | Low
|
|
46
|
+
Severity: Critical | High | Medium | Low
|
|
47
|
+
Needs human decision: Yes | No
|
|
48
|
+
Detected by raw findings: `<audit ids>`
|
|
49
|
+
|
|
50
|
+
Evidence set:
|
|
51
|
+
- `<file>` `<line/section>`: "<quote>"
|
|
52
|
+
- `<file>` `<line/section>`: "<quote>"
|
|
53
|
+
|
|
54
|
+
Consolidated conflict:
|
|
55
|
+
<explain the issue>
|
|
56
|
+
|
|
57
|
+
Why it survived consolidation:
|
|
58
|
+
<explain why this is not an obvious false positive>
|
|
59
|
+
|
|
60
|
+
Known false-positive risks:
|
|
61
|
+
<list risks>
|
|
62
|
+
|
|
63
|
+
Suggested correction direction:
|
|
64
|
+
<direction only; no rewrite>
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Discarded Output
|
|
68
|
+
|
|
69
|
+
Write `{{DISCARDED_OUTPUT}}` with this format:
|
|
70
|
+
|
|
71
|
+
```md
|
|
72
|
+
# Discarded Raw Findings
|
|
73
|
+
|
|
74
|
+
Run: {{RUN_ID}}
|
|
75
|
+
|
|
76
|
+
## Discarded
|
|
77
|
+
|
|
78
|
+
### D-001: <short title>
|
|
79
|
+
|
|
80
|
+
Raw finding ids: `<ids>`
|
|
81
|
+
Reason: Unsupported evidence | Duplicate merged | Acceptable granularity difference | Misread quote | Not a project inconsistency | Other
|
|
82
|
+
Explanation:
|
|
83
|
+
<why it was discarded or merged>
|
|
84
|
+
```
|
|
@@ -1,92 +1,92 @@
|
|
|
1
|
-
# Adversarial Documentation Audit Validation
|
|
2
|
-
|
|
3
|
-
Run: `{{RUN_ID}}`
|
|
4
|
-
Consolidated candidates: `{{CONSOLIDATED_OUTPUT}}`
|
|
5
|
-
Validation output: `{{VALIDATION_OUTPUT}}`
|
|
6
|
-
Final report: `{{FINAL_OUTPUT}}`
|
|
7
|
-
|
|
8
|
-
## Role
|
|
9
|
-
|
|
10
|
-
You are the adversarial validator. Your job is to try to prove that each consolidated candidate is a false positive. Keep a problem in the final report only if it survives that attempt.
|
|
11
|
-
|
|
12
|
-
Do not correct documentation. Do not choose a source of truth. Do not turn acceptable divergence into an error.
|
|
13
|
-
|
|
14
|
-
## Tasks
|
|
15
|
-
|
|
16
|
-
- Read `{{CONSOLIDATED_OUTPUT}}`.
|
|
17
|
-
- For each candidate, open cited files and search nearby/additional context.
|
|
18
|
-
- Try to refute the candidate with alternative explanations: scope, release, responsible document, example status, benchmark context, terminology or detail level.
|
|
19
|
-
- Classify each candidate as Confirmed, Probable, Needs human decision or False positive.
|
|
20
|
-
- Merge remaining duplicates.
|
|
21
|
-
- Generate a short, actionable final report with evidence.
|
|
22
|
-
|
|
23
|
-
## Validation Output
|
|
24
|
-
|
|
25
|
-
Write `{{VALIDATION_OUTPUT}}` with this format:
|
|
26
|
-
|
|
27
|
-
```md
|
|
28
|
-
# Adversarial Validation Log
|
|
29
|
-
|
|
30
|
-
Run: {{RUN_ID}}
|
|
31
|
-
|
|
32
|
-
## Candidate Reviews
|
|
33
|
-
|
|
34
|
-
### C-001: <title>
|
|
35
|
-
|
|
36
|
-
Validation result: Confirmed | Probable | Needs human decision | False positive
|
|
37
|
-
Reasoning:
|
|
38
|
-
<why it survived or failed>
|
|
39
|
-
|
|
40
|
-
Refutation attempts:
|
|
41
|
-
- <attempt>
|
|
42
|
-
|
|
43
|
-
Evidence checked:
|
|
44
|
-
- `<file>` `<line/section>`
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
## Final Report
|
|
48
|
-
|
|
49
|
-
Write `{{FINAL_OUTPUT}}` with this format:
|
|
50
|
-
|
|
51
|
-
```md
|
|
52
|
-
# Final Documentation Audit Report
|
|
53
|
-
|
|
54
|
-
Run: {{RUN_ID}}
|
|
55
|
-
|
|
56
|
-
## Summary
|
|
57
|
-
|
|
58
|
-
- Confirmed problems:
|
|
59
|
-
- Probable problems:
|
|
60
|
-
- Needs human decision:
|
|
61
|
-
- False positives removed during validation:
|
|
62
|
-
|
|
63
|
-
## Confirmed Problems
|
|
64
|
-
|
|
65
|
-
### P-001: <short title>
|
|
66
|
-
|
|
67
|
-
Type: Contradiction | Ambiguity | Probable staleness | Broken reference | Missing cross-reference | Code/doc drift | Scope leak | Unclassified
|
|
68
|
-
Severity: Critical | High | Medium | Low
|
|
69
|
-
Needs human decision: Yes | No
|
|
70
|
-
|
|
71
|
-
Evidence:
|
|
72
|
-
- `<file>` `<line/section>`: "<quote>"
|
|
73
|
-
- `<file>` `<line/section>`: "<quote>"
|
|
74
|
-
|
|
75
|
-
Problem:
|
|
76
|
-
<explain the confirmed issue>
|
|
77
|
-
|
|
78
|
-
Suggested correction direction:
|
|
79
|
-
<direction only; no rewrite>
|
|
80
|
-
|
|
81
|
-
## Probable Problems
|
|
82
|
-
|
|
83
|
-
<same structure, for items that are likely but not fully proven>
|
|
84
|
-
|
|
85
|
-
## Needs Human Decision
|
|
86
|
-
|
|
87
|
-
<same structure, for real conflicts where product/architecture decision is needed>
|
|
88
|
-
|
|
89
|
-
## Removed As False Positives
|
|
90
|
-
|
|
91
|
-
- `<candidate id>`: <reason>
|
|
92
|
-
```
|
|
1
|
+
# Adversarial Documentation Audit Validation
|
|
2
|
+
|
|
3
|
+
Run: `{{RUN_ID}}`
|
|
4
|
+
Consolidated candidates: `{{CONSOLIDATED_OUTPUT}}`
|
|
5
|
+
Validation output: `{{VALIDATION_OUTPUT}}`
|
|
6
|
+
Final report: `{{FINAL_OUTPUT}}`
|
|
7
|
+
|
|
8
|
+
## Role
|
|
9
|
+
|
|
10
|
+
You are the adversarial validator. Your job is to try to prove that each consolidated candidate is a false positive. Keep a problem in the final report only if it survives that attempt.
|
|
11
|
+
|
|
12
|
+
Do not correct documentation. Do not choose a source of truth. Do not turn acceptable divergence into an error.
|
|
13
|
+
|
|
14
|
+
## Tasks
|
|
15
|
+
|
|
16
|
+
- Read `{{CONSOLIDATED_OUTPUT}}`.
|
|
17
|
+
- For each candidate, open cited files and search nearby/additional context.
|
|
18
|
+
- Try to refute the candidate with alternative explanations: scope, release, responsible document, example status, benchmark context, terminology or detail level.
|
|
19
|
+
- Classify each candidate as Confirmed, Probable, Needs human decision or False positive.
|
|
20
|
+
- Merge remaining duplicates.
|
|
21
|
+
- Generate a short, actionable final report with evidence.
|
|
22
|
+
|
|
23
|
+
## Validation Output
|
|
24
|
+
|
|
25
|
+
Write `{{VALIDATION_OUTPUT}}` with this format:
|
|
26
|
+
|
|
27
|
+
```md
|
|
28
|
+
# Adversarial Validation Log
|
|
29
|
+
|
|
30
|
+
Run: {{RUN_ID}}
|
|
31
|
+
|
|
32
|
+
## Candidate Reviews
|
|
33
|
+
|
|
34
|
+
### C-001: <title>
|
|
35
|
+
|
|
36
|
+
Validation result: Confirmed | Probable | Needs human decision | False positive
|
|
37
|
+
Reasoning:
|
|
38
|
+
<why it survived or failed>
|
|
39
|
+
|
|
40
|
+
Refutation attempts:
|
|
41
|
+
- <attempt>
|
|
42
|
+
|
|
43
|
+
Evidence checked:
|
|
44
|
+
- `<file>` `<line/section>`
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Final Report
|
|
48
|
+
|
|
49
|
+
Write `{{FINAL_OUTPUT}}` with this format:
|
|
50
|
+
|
|
51
|
+
```md
|
|
52
|
+
# Final Documentation Audit Report
|
|
53
|
+
|
|
54
|
+
Run: {{RUN_ID}}
|
|
55
|
+
|
|
56
|
+
## Summary
|
|
57
|
+
|
|
58
|
+
- Confirmed problems:
|
|
59
|
+
- Probable problems:
|
|
60
|
+
- Needs human decision:
|
|
61
|
+
- False positives removed during validation:
|
|
62
|
+
|
|
63
|
+
## Confirmed Problems
|
|
64
|
+
|
|
65
|
+
### P-001: <short title>
|
|
66
|
+
|
|
67
|
+
Type: Contradiction | Ambiguity | Probable staleness | Broken reference | Missing cross-reference | Code/doc drift | Scope leak | Unclassified
|
|
68
|
+
Severity: Critical | High | Medium | Low
|
|
69
|
+
Needs human decision: Yes | No
|
|
70
|
+
|
|
71
|
+
Evidence:
|
|
72
|
+
- `<file>` `<line/section>`: "<quote>"
|
|
73
|
+
- `<file>` `<line/section>`: "<quote>"
|
|
74
|
+
|
|
75
|
+
Problem:
|
|
76
|
+
<explain the confirmed issue>
|
|
77
|
+
|
|
78
|
+
Suggested correction direction:
|
|
79
|
+
<direction only; no rewrite>
|
|
80
|
+
|
|
81
|
+
## Probable Problems
|
|
82
|
+
|
|
83
|
+
<same structure, for items that are likely but not fully proven>
|
|
84
|
+
|
|
85
|
+
## Needs Human Decision
|
|
86
|
+
|
|
87
|
+
<same structure, for real conflicts where product/architecture decision is needed>
|
|
88
|
+
|
|
89
|
+
## Removed As False Positives
|
|
90
|
+
|
|
91
|
+
- `<candidate id>`: <reason>
|
|
92
|
+
```
|
|
@@ -1,24 +1,24 @@
|
|
|
1
|
-
{
|
|
2
|
-
"id": "documentation-audit",
|
|
3
|
-
"status": "available",
|
|
4
|
-
"title": "Documentation Audit",
|
|
5
|
-
"summary": "Runs redundant, adversarial consistency audits across project documentation without editing source docs.",
|
|
6
|
-
"commands": {
|
|
7
|
-
"cli": [
|
|
8
|
-
"wefter docs audit",
|
|
9
|
-
"wefter new-run documentation-audit"
|
|
10
|
-
],
|
|
11
|
-
"opencode": [
|
|
12
|
-
"/wefter-audit-docs",
|
|
13
|
-
"/wefter-generate-doc-audit-profile"
|
|
14
|
-
]
|
|
15
|
-
},
|
|
16
|
-
"artifactLayout": [
|
|
17
|
-
"prompts/auditors/",
|
|
18
|
-
"raw/",
|
|
19
|
-
"consolidation/",
|
|
20
|
-
"validation/",
|
|
21
|
-
"final/"
|
|
22
|
-
],
|
|
23
|
-
"writesSourceFiles": false
|
|
24
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"id": "documentation-audit",
|
|
3
|
+
"status": "available",
|
|
4
|
+
"title": "Documentation Audit",
|
|
5
|
+
"summary": "Runs redundant, adversarial consistency audits across project documentation without editing source docs.",
|
|
6
|
+
"commands": {
|
|
7
|
+
"cli": [
|
|
8
|
+
"wefter docs audit",
|
|
9
|
+
"wefter new-run documentation-audit"
|
|
10
|
+
],
|
|
11
|
+
"opencode": [
|
|
12
|
+
"/wefter-audit-docs",
|
|
13
|
+
"/wefter-generate-doc-audit-profile"
|
|
14
|
+
]
|
|
15
|
+
},
|
|
16
|
+
"artifactLayout": [
|
|
17
|
+
"prompts/auditors/",
|
|
18
|
+
"raw/",
|
|
19
|
+
"consolidation/",
|
|
20
|
+
"validation/",
|
|
21
|
+
"final/"
|
|
22
|
+
],
|
|
23
|
+
"writesSourceFiles": false
|
|
24
|
+
}
|