agentera 0.0.0 → 3.0.0-dev.1
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 +6 -45
- package/bundle/.agentera-npx-bundle.json +4 -0
- package/bundle/references/adapters/cursor.md +213 -0
- package/bundle/references/adapters/opencode.md +530 -0
- package/bundle/references/adapters/package-manifest-interface-model.yaml +337 -0
- package/bundle/references/adapters/package-registry.yaml +247 -0
- package/bundle/references/adapters/package-surface-characterization.md +48 -0
- package/bundle/references/adapters/runtime-adapter-characterization.md +79 -0
- package/bundle/references/adapters/runtime-adapter-interface-model.yaml +200 -0
- package/bundle/references/adapters/runtime-adapter-registry.yaml +548 -0
- package/bundle/references/adapters/runtime-feature-parity.md +189 -0
- package/bundle/references/analysis/benchmark.md +267 -0
- package/bundle/references/analysis/startup-measurement-contract.yaml +424 -0
- package/bundle/references/artifacts/artifact-registry-interface-model.yaml +288 -0
- package/bundle/references/cli/agent-ready-state-contract.yaml +950 -0
- package/bundle/references/cli/app-lifecycle-vocabulary.yaml +241 -0
- package/bundle/references/cli/audience-namespace-cli-migration.yaml +355 -0
- package/bundle/references/cli/bundle-skill-vocabulary.yaml +278 -0
- package/bundle/references/cli/capability-instruction-contract.yaml +123 -0
- package/bundle/references/cli/capability-tool-classification.yaml +53 -0
- package/bundle/references/cli/routing-execution-vocabulary.yaml +281 -0
- package/bundle/references/cli/update-channels.yaml +147 -0
- package/bundle/references/cli/vocabulary-index.yaml +160 -0
- package/bundle/references/cli/vocabulary.md +566 -0
- package/bundle/references/meta/documentation-inventory.md +43 -0
- package/bundle/references/v1-section-mapping.md +47 -0
- package/bundle/registry.json +39 -0
- package/bundle/skills/agentera/.claude-plugin/plugin.json +27 -0
- package/bundle/skills/agentera/SKILL.md +470 -0
- package/bundle/skills/agentera/agents/dokumentera.toml +6 -0
- package/bundle/skills/agentera/agents/hej.toml +6 -0
- package/bundle/skills/agentera/agents/inspektera.toml +6 -0
- package/bundle/skills/agentera/agents/inspirera.toml +6 -0
- package/bundle/skills/agentera/agents/optimera.toml +6 -0
- package/bundle/skills/agentera/agents/orkestrera.toml +6 -0
- package/bundle/skills/agentera/agents/planera.toml +6 -0
- package/bundle/skills/agentera/agents/profilera.toml +6 -0
- package/bundle/skills/agentera/agents/realisera.toml +6 -0
- package/bundle/skills/agentera/agents/resonera.toml +6 -0
- package/bundle/skills/agentera/agents/visionera.toml +6 -0
- package/bundle/skills/agentera/agents/visualisera.toml +6 -0
- package/bundle/skills/agentera/capabilities/dokumentera/instructions.md +428 -0
- package/bundle/skills/agentera/capabilities/dokumentera/schemas/artifacts.yaml +73 -0
- package/bundle/skills/agentera/capabilities/dokumentera/schemas/exit.yaml +35 -0
- package/bundle/skills/agentera/capabilities/dokumentera/schemas/triggers.yaml +35 -0
- package/bundle/skills/agentera/capabilities/dokumentera/schemas/validation.yaml +139 -0
- package/bundle/skills/agentera/capabilities/hej/instructions.md +331 -0
- package/bundle/skills/agentera/capabilities/hej/schemas/artifacts.yaml +69 -0
- package/bundle/skills/agentera/capabilities/hej/schemas/exit.yaml +32 -0
- package/bundle/skills/agentera/capabilities/hej/schemas/triggers.yaml +58 -0
- package/bundle/skills/agentera/capabilities/hej/schemas/validation.yaml +55 -0
- package/bundle/skills/agentera/capabilities/inspektera/instructions.md +514 -0
- package/bundle/skills/agentera/capabilities/inspektera/schemas/artifacts.yaml +76 -0
- package/bundle/skills/agentera/capabilities/inspektera/schemas/exit.yaml +36 -0
- package/bundle/skills/agentera/capabilities/inspektera/schemas/triggers.yaml +38 -0
- package/bundle/skills/agentera/capabilities/inspektera/schemas/validation.yaml +113 -0
- package/bundle/skills/agentera/capabilities/inspirera/instructions.md +280 -0
- package/bundle/skills/agentera/capabilities/inspirera/schemas/artifacts.yaml +24 -0
- package/bundle/skills/agentera/capabilities/inspirera/schemas/exit.yaml +33 -0
- package/bundle/skills/agentera/capabilities/inspirera/schemas/triggers.yaml +34 -0
- package/bundle/skills/agentera/capabilities/inspirera/schemas/validation.yaml +58 -0
- package/bundle/skills/agentera/capabilities/optimera/instructions.md +437 -0
- package/bundle/skills/agentera/capabilities/optimera/schemas/artifacts.yaml +69 -0
- package/bundle/skills/agentera/capabilities/optimera/schemas/exit.yaml +35 -0
- package/bundle/skills/agentera/capabilities/optimera/schemas/triggers.yaml +39 -0
- package/bundle/skills/agentera/capabilities/optimera/schemas/validation.yaml +91 -0
- package/bundle/skills/agentera/capabilities/orkestrera/instructions.md +433 -0
- package/bundle/skills/agentera/capabilities/orkestrera/schemas/artifacts.yaml +64 -0
- package/bundle/skills/agentera/capabilities/orkestrera/schemas/exit.yaml +34 -0
- package/bundle/skills/agentera/capabilities/orkestrera/schemas/triggers.yaml +42 -0
- package/bundle/skills/agentera/capabilities/orkestrera/schemas/validation.yaml +107 -0
- package/bundle/skills/agentera/capabilities/planera/instructions.md +368 -0
- package/bundle/skills/agentera/capabilities/planera/schemas/artifacts.yaml +62 -0
- package/bundle/skills/agentera/capabilities/planera/schemas/exit.yaml +33 -0
- package/bundle/skills/agentera/capabilities/planera/schemas/triggers.yaml +34 -0
- package/bundle/skills/agentera/capabilities/planera/schemas/validation.yaml +61 -0
- package/bundle/skills/agentera/capabilities/profilera/instructions.md +419 -0
- package/bundle/skills/agentera/capabilities/profilera/schemas/artifacts.yaml +18 -0
- package/bundle/skills/agentera/capabilities/profilera/schemas/exit.yaml +34 -0
- package/bundle/skills/agentera/capabilities/profilera/schemas/triggers.yaml +45 -0
- package/bundle/skills/agentera/capabilities/profilera/schemas/validation.yaml +57 -0
- package/bundle/skills/agentera/capabilities/realisera/instructions.md +403 -0
- package/bundle/skills/agentera/capabilities/realisera/schemas/artifacts.yaml +80 -0
- package/bundle/skills/agentera/capabilities/realisera/schemas/exit.yaml +35 -0
- package/bundle/skills/agentera/capabilities/realisera/schemas/triggers.yaml +39 -0
- package/bundle/skills/agentera/capabilities/realisera/schemas/validation.yaml +110 -0
- package/bundle/skills/agentera/capabilities/resonera/instructions.md +329 -0
- package/bundle/skills/agentera/capabilities/resonera/schemas/artifacts.yaml +47 -0
- package/bundle/skills/agentera/capabilities/resonera/schemas/exit.yaml +35 -0
- package/bundle/skills/agentera/capabilities/resonera/schemas/triggers.yaml +46 -0
- package/bundle/skills/agentera/capabilities/resonera/schemas/validation.yaml +77 -0
- package/bundle/skills/agentera/capabilities/visionera/instructions.md +309 -0
- package/bundle/skills/agentera/capabilities/visionera/schemas/artifacts.yaml +57 -0
- package/bundle/skills/agentera/capabilities/visionera/schemas/exit.yaml +35 -0
- package/bundle/skills/agentera/capabilities/visionera/schemas/triggers.yaml +41 -0
- package/bundle/skills/agentera/capabilities/visionera/schemas/validation.yaml +74 -0
- package/bundle/skills/agentera/capabilities/visualisera/instructions.md +400 -0
- package/bundle/skills/agentera/capabilities/visualisera/schemas/artifacts.yaml +44 -0
- package/bundle/skills/agentera/capabilities/visualisera/schemas/exit.yaml +34 -0
- package/bundle/skills/agentera/capabilities/visualisera/schemas/triggers.yaml +33 -0
- package/bundle/skills/agentera/capabilities/visualisera/schemas/validation.yaml +80 -0
- package/bundle/skills/agentera/capability_schema_contract.yaml +385 -0
- package/bundle/skills/agentera/protocol.yaml +463 -0
- package/bundle/skills/agentera/references/contract.md +1039 -0
- package/bundle/skills/agentera/schemas/artifacts/changelog.yaml +60 -0
- package/bundle/skills/agentera/schemas/artifacts/decisions.yaml +461 -0
- package/bundle/skills/agentera/schemas/artifacts/design.yaml +55 -0
- package/bundle/skills/agentera/schemas/artifacts/docs.yaml +402 -0
- package/bundle/skills/agentera/schemas/artifacts/experiments.yaml +373 -0
- package/bundle/skills/agentera/schemas/artifacts/health.yaml +484 -0
- package/bundle/skills/agentera/schemas/artifacts/objective.yaml +399 -0
- package/bundle/skills/agentera/schemas/artifacts/plan.yaml +342 -0
- package/bundle/skills/agentera/schemas/artifacts/progress.yaml +325 -0
- package/bundle/skills/agentera/schemas/artifacts/todo.yaml +110 -0
- package/bundle/skills/agentera/schemas/artifacts/vision.yaml +262 -0
- package/bundle/skills/hej/.claude-plugin/plugin.json +6 -0
- package/bundle/skills/hej/SKILL.md +69 -0
- package/bundle/skills/hej/agents/hej.toml +11 -0
- package/bundle/skills/hej/agents/openai.yaml +8 -0
- package/dist/analytics/extractCorpus.js +1791 -0
- package/dist/analytics/extractCorpus.js.map +1 -0
- package/dist/analytics/usageStats.js +487 -0
- package/dist/analytics/usageStats.js.map +1 -0
- package/dist/bin/agentera.js +4 -0
- package/dist/bin/agentera.js.map +1 -0
- package/dist/cli/appContext.js +226 -0
- package/dist/cli/appContext.js.map +1 -0
- package/dist/cli/argvalidate.js +41 -0
- package/dist/cli/argvalidate.js.map +1 -0
- package/dist/cli/capabilityContext.js +2421 -0
- package/dist/cli/capabilityContext.js.map +1 -0
- package/dist/cli/commands/backfill.js +84 -0
- package/dist/cli/commands/backfill.js.map +1 -0
- package/dist/cli/commands/capability.js +44 -0
- package/dist/cli/commands/capability.js.map +1 -0
- package/dist/cli/commands/compact.js +148 -0
- package/dist/cli/commands/compact.js.map +1 -0
- package/dist/cli/commands/doctor.js +180 -0
- package/dist/cli/commands/doctor.js.map +1 -0
- package/dist/cli/commands/lint.js +179 -0
- package/dist/cli/commands/lint.js.map +1 -0
- package/dist/cli/commands/prime.js +544 -0
- package/dist/cli/commands/prime.js.map +1 -0
- package/dist/cli/commands/query.js +346 -0
- package/dist/cli/commands/query.js.map +1 -0
- package/dist/cli/commands/report.js +210 -0
- package/dist/cli/commands/report.js.map +1 -0
- package/dist/cli/commands/schema.js +306 -0
- package/dist/cli/commands/schema.js.map +1 -0
- package/dist/cli/commands/state.js +1012 -0
- package/dist/cli/commands/state.js.map +1 -0
- package/dist/cli/commands/upgrade.js +48 -0
- package/dist/cli/commands/upgrade.js.map +1 -0
- package/dist/cli/commands/validate.js +519 -0
- package/dist/cli/commands/validate.js.map +1 -0
- package/dist/cli/commands/verify.js +204 -0
- package/dist/cli/commands/verify.js.map +1 -0
- package/dist/cli/dispatch.js +958 -0
- package/dist/cli/dispatch.js.map +1 -0
- package/dist/cli/orientation.js +595 -0
- package/dist/cli/orientation.js.map +1 -0
- package/dist/cli/prime-blob.js +3 -0
- package/dist/cli/prime-blob.js.map +1 -0
- package/dist/cli/stateQuery.js +292 -0
- package/dist/cli/stateQuery.js.map +1 -0
- package/dist/cli/structured.js +18 -0
- package/dist/cli/structured.js.map +1 -0
- package/dist/core/difflib.js +274 -0
- package/dist/core/difflib.js.map +1 -0
- package/dist/core/git.js +43 -0
- package/dist/core/git.js.map +1 -0
- package/dist/core/paths.js +50 -0
- package/dist/core/paths.js.map +1 -0
- package/dist/core/pyjson.js +101 -0
- package/dist/core/pyjson.js.map +1 -0
- package/dist/core/sourceRoot.js +72 -0
- package/dist/core/sourceRoot.js.map +1 -0
- package/dist/core/toml.js +11 -0
- package/dist/core/toml.js.map +1 -0
- package/dist/core/yaml.js +25 -0
- package/dist/core/yaml.js.map +1 -0
- package/dist/eval/evalSkills.js +258 -0
- package/dist/eval/evalSkills.js.map +1 -0
- package/dist/eval/semanticEval.js +148 -0
- package/dist/eval/semanticEval.js.map +1 -0
- package/dist/eval/semanticFixtures.js +227 -0
- package/dist/eval/semanticFixtures.js.map +1 -0
- package/dist/hooks/common.js +160 -0
- package/dist/hooks/common.js.map +1 -0
- package/dist/hooks/compaction.js +935 -0
- package/dist/hooks/compaction.js.map +1 -0
- package/dist/hooks/cursorPreToolUse.js +19 -0
- package/dist/hooks/cursorPreToolUse.js.map +1 -0
- package/dist/hooks/cursorSessionStart.js +71 -0
- package/dist/hooks/cursorSessionStart.js.map +1 -0
- package/dist/hooks/sessionStart.js +209 -0
- package/dist/hooks/sessionStart.js.map +1 -0
- package/dist/hooks/sessionStop.js +212 -0
- package/dist/hooks/sessionStop.js.map +1 -0
- package/dist/hooks/validateArtifact.js +933 -0
- package/dist/hooks/validateArtifact.js.map +1 -0
- package/dist/registries/artifactRegistry.js +206 -0
- package/dist/registries/artifactRegistry.js.map +1 -0
- package/dist/registries/capabilityContract.js +310 -0
- package/dist/registries/capabilityContract.js.map +1 -0
- package/dist/registries/packageRegistry.js +641 -0
- package/dist/registries/packageRegistry.js.map +1 -0
- package/dist/registries/runtimeAdapterRegistry.js +315 -0
- package/dist/registries/runtimeAdapterRegistry.js.map +1 -0
- package/dist/setup/codex.js +1056 -0
- package/dist/setup/codex.js.map +1 -0
- package/dist/setup/copilot.js +227 -0
- package/dist/setup/copilot.js.map +1 -0
- package/dist/setup/cursor.js +127 -0
- package/dist/setup/cursor.js.map +1 -0
- package/dist/setup/doctor.js +1276 -0
- package/dist/setup/doctor.js.map +1 -0
- package/dist/state/installRoot.js +279 -0
- package/dist/state/installRoot.js.map +1 -0
- package/dist/state/progressCommit.js +289 -0
- package/dist/state/progressCommit.js.map +1 -0
- package/dist/state/startupAnalysis.js +1953 -0
- package/dist/state/startupAnalysis.js.map +1 -0
- package/dist/upgrade/appModel.js +189 -0
- package/dist/upgrade/appModel.js.map +1 -0
- package/dist/upgrade/channels.js +208 -0
- package/dist/upgrade/channels.js.map +1 -0
- package/dist/upgrade/compatibility.js +201 -0
- package/dist/upgrade/compatibility.js.map +1 -0
- package/dist/upgrade/doctor.js +373 -0
- package/dist/upgrade/doctor.js.map +1 -0
- package/dist/upgrade/migrateArtifactsV2ToV3.js +332 -0
- package/dist/upgrade/migrateArtifactsV2ToV3.js.map +1 -0
- package/dist/upgrade/runtimeMigration.js +484 -0
- package/dist/upgrade/runtimeMigration.js.map +1 -0
- package/dist/upgrade/upgradeCommands.js +36 -0
- package/dist/upgrade/upgradeCommands.js.map +1 -0
- package/dist/upgrade/upgradeOrchestrator.js +299 -0
- package/dist/upgrade/upgradeOrchestrator.js.map +1 -0
- package/dist/upgrade/versionResolution.js +179 -0
- package/dist/upgrade/versionResolution.js.map +1 -0
- package/dist/validate/appHomeContract.js +150 -0
- package/dist/validate/appHomeContract.js.map +1 -0
- package/dist/validate/capability.js +412 -0
- package/dist/validate/capability.js.map +1 -0
- package/dist/validate/crossCapability.js +145 -0
- package/dist/validate/crossCapability.js.map +1 -0
- package/dist/validate/lifecycleAdapters.js +772 -0
- package/dist/validate/lifecycleAdapters.js.map +1 -0
- package/dist/validate/selfAudit.js +107 -0
- package/dist/validate/selfAudit.js.map +1 -0
- package/package.json +28 -8
- package/LICENSE +0 -201
- package/bin/agentera.mjs +0 -50
- package/lib/exec.mjs +0 -116
- package/lib/resolve.mjs +0 -129
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# agentera_managed: true
|
|
2
|
+
name = "realisera"
|
|
3
|
+
description = "Autonomous development execution."
|
|
4
|
+
developer_instructions = """
|
|
5
|
+
You are the Agentera realisera capability subagent. You have full file write, file edit, and shell execution tools available — use them to implement code changes, run tests, and commit results. Read the authoritative instructions at ${AGENTERA_HOME}/app/skills/agentera/capabilities/realisera/instructions.md when available. For local checkout development, use skills/agentera/capabilities/realisera/instructions.md under the active Agentera source root. Stay within the dispatched capability task, use the Agentera CLI state seam first, and preserve Agentera artifact safety rails.
|
|
6
|
+
"""
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# agentera_managed: true
|
|
2
|
+
name = "resonera"
|
|
3
|
+
description = "Structured deliberation and decision support."
|
|
4
|
+
developer_instructions = """
|
|
5
|
+
You are the Agentera resonera capability subagent. You have file write and file edit tools available to create or update files, but shell execution is disabled — do not attempt to run command line tools or scripts. Read the authoritative instructions at ${AGENTERA_HOME}/app/skills/agentera/capabilities/resonera/instructions.md when available. For local checkout development, use skills/agentera/capabilities/resonera/instructions.md under the active Agentera source root. Stay within the dispatched capability task, use the Agentera CLI state seam first, and preserve Agentera artifact safety rails.
|
|
6
|
+
"""
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# agentera_managed: true
|
|
2
|
+
name = "visionera"
|
|
3
|
+
description = "Define and refine project direction."
|
|
4
|
+
developer_instructions = """
|
|
5
|
+
You are the Agentera visionera capability subagent. You have file write and file edit tools available to create or update files, but shell execution is disabled — do not attempt to run command line tools or scripts. Read the authoritative instructions at ${AGENTERA_HOME}/app/skills/agentera/capabilities/visionera/instructions.md when available. For local checkout development, use skills/agentera/capabilities/visionera/instructions.md under the active Agentera source root. Stay within the dispatched capability task, use the Agentera CLI state seam first, and preserve Agentera artifact safety rails.
|
|
6
|
+
"""
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# agentera_managed: true
|
|
2
|
+
name = "visualisera"
|
|
3
|
+
description = "Visual identity and design systems."
|
|
4
|
+
developer_instructions = """
|
|
5
|
+
You are the Agentera visualisera capability subagent. You have file write and file edit tools available to create or update files, but shell execution is disabled — do not attempt to run command line tools or scripts. Read the authoritative instructions at ${AGENTERA_HOME}/app/skills/agentera/capabilities/visualisera/instructions.md when available. For local checkout development, use skills/agentera/capabilities/visualisera/instructions.md under the active Agentera source root. Stay within the dispatched capability task, use the Agentera CLI state seam first, and preserve Agentera artifact safety rails.
|
|
6
|
+
"""
|
|
@@ -0,0 +1,428 @@
|
|
|
1
|
+
# DOKUMENTERA
|
|
2
|
+
|
|
3
|
+
**Documentation Origin: Knowledge Unified, Methodology Enforced, Notation Traced. Encode, Record, Archive**
|
|
4
|
+
|
|
5
|
+
Owns the docs-first workflow: document intended behavior before tests and code. Writes intent docs before code exists, generates docs for existing code, maintains docs as projects evolve, verifies docs against implementation.
|
|
6
|
+
|
|
7
|
+
Two modes: **create** and **update**. Context-detected: no feature yet = intent-first; code exists = explore and generate.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Visual identity
|
|
12
|
+
|
|
13
|
+
Glyph: **▤** (protocol ref: SG8). Used in the mandatory exit marker.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## State artifacts
|
|
18
|
+
|
|
19
|
+
One index file; writes individual doc files across the project.
|
|
20
|
+
|
|
21
|
+
| Artifact | Purpose | Bootstrap |
|
|
22
|
+
|----------|---------|-----------|
|
|
23
|
+
| `DOCS.md` | Canonical documentation contract, stored as `.agentera/docs.yaml` unless mapped otherwise. Conventions, artifact mapping, and documentation index. | Created on first dokumentera run. |
|
|
24
|
+
|
|
25
|
+
Use `agentera describe --format json` and its `artifact_schemas` entry for `docs` to locate the active installed schema; use `artifact_locations` or `agentera query --list-artifacts --format json` for mapped artifact paths and raw-access boundaries. Do not search Agentera directories manually. The repository's existing `.agentera/docs.yaml` shape provides the local structure when editing that artifact. Individual documentation files are written to their mapped locations.
|
|
26
|
+
|
|
27
|
+
### Artifact path resolution
|
|
28
|
+
|
|
29
|
+
Before reading or writing any artifact, prefer the CLI artifact-location contract from `agentera describe --format json` or `agentera query --list-artifacts --format json`. It resolves `.agentera/docs.yaml` mappings, default paths, existence, normal read commands, and raw-access boundaries without a separate raw docs read. Raw `.agentera/docs.yaml` access is reserved for writing or validating the docs artifact itself, corruption diagnostics, or unavailable/incomplete CLI discovery. This applies to all artifact references in this capability, including cross-capability reads (VISION.md, .agentera/progress.yaml, .agentera/decisions.yaml, .agentera/health.yaml).
|
|
30
|
+
|
|
31
|
+
### Contract values
|
|
32
|
+
|
|
33
|
+
Contract values are inlined where referenced. Visual tokens from protocol: severity arrows VT5-VT8, trend arrows VT12-VT13, progress bar VT18, inline separator VT16 (·), list item VT15 (▸), section divider VT14, flow/target VT17 (→). Skill glyph SG8 for the exit marker. Exit signals EX1-EX4 for the exit marker. Confidence scale CS1-CS5 for decision profile consumption.
|
|
34
|
+
|
|
35
|
+
`references/contract.md` (at the v2 skill location `skills/agentera/references/contract.md`) remains available as a full-spec reference for ambiguous cases or cross-checking.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## docs.yaml shape
|
|
40
|
+
|
|
41
|
+
```yaml
|
|
42
|
+
last_audit: YYYY-MM-DD
|
|
43
|
+
conventions:
|
|
44
|
+
doc_root: .
|
|
45
|
+
style: technical, concise
|
|
46
|
+
auto_gen: []
|
|
47
|
+
version_files: []
|
|
48
|
+
semver_policy:
|
|
49
|
+
feat: minor
|
|
50
|
+
fix: patch
|
|
51
|
+
docs/chore/test: no bump
|
|
52
|
+
mapping:
|
|
53
|
+
- artifact: VISION.md
|
|
54
|
+
path: .agentera/vision.yaml
|
|
55
|
+
producers: [visionera, realisera]
|
|
56
|
+
index:
|
|
57
|
+
- document: README
|
|
58
|
+
path: README.md
|
|
59
|
+
last_updated: YYYY-MM-DD
|
|
60
|
+
status: current
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Step 0: Detect context
|
|
66
|
+
|
|
67
|
+
Before artifact-backed work, use supported Agentera CLI state first. For final
|
|
68
|
+
documentation or metadata synchronization, follow the closeout context startup
|
|
69
|
+
contract below before reading TODO, docs, changelog, or progress artifacts directly.
|
|
70
|
+
|
|
71
|
+
Determine what kind of documentation work is needed:
|
|
72
|
+
|
|
73
|
+
1. Read DOCS.md (if exists) for current state
|
|
74
|
+
2. Parse user request: specific target or broad "write/update docs"?
|
|
75
|
+
3. Check codebase: does the feature exist in code?
|
|
76
|
+
|
|
77
|
+
| Context | Approach |
|
|
78
|
+
|---------|----------|
|
|
79
|
+
| Feature doesn't exist yet, user wants to document intent | **Intent-first** (conversational) |
|
|
80
|
+
| Code exists, docs don't | **Explore and generate** (autonomous) |
|
|
81
|
+
| Docs exist, may be stale | **Update and verify** (audit-driven) |
|
|
82
|
+
| Broad "audit the docs" / "are docs up to date" | **Full audit** |
|
|
83
|
+
| No DOCS.md exists | **First-run survey** (convention detection) |
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Closeout context startup
|
|
88
|
+
|
|
89
|
+
Closeout synchronization uses the existing state seam:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
agentera prime --context dokumentera --format json
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
When the response includes `closeout_context.source_contract.complete_for_closeout_context: true`, use `closeout_context` as the normal source for:
|
|
96
|
+
|
|
97
|
+
- artifact mappings
|
|
98
|
+
- version policy
|
|
99
|
+
- TODO blockers
|
|
100
|
+
- changelog and release boundary state
|
|
101
|
+
- progress evidence
|
|
102
|
+
- benchmark evidence or unavailable caveat
|
|
103
|
+
- fallback commands
|
|
104
|
+
- state caveats
|
|
105
|
+
- raw-read policy
|
|
106
|
+
- completeness and non-empty evidence flags
|
|
107
|
+
|
|
108
|
+
Do not raw-read `TODO.md`, `.agentera/docs.yaml`, `CHANGELOG.md`, or `.agentera/progress.yaml` merely to reconstruct those fields when the closeout context is complete. Raw artifacts are write targets or last-resort diagnostics, not normal closeout inputs.
|
|
109
|
+
|
|
110
|
+
When closeout context is incomplete or caveated:
|
|
111
|
+
|
|
112
|
+
1. Preserve every returned caveat, including stale app/profile state, compacted state, missing benchmark evidence, absent local tag/metadata, and no-publication/no-remote state.
|
|
113
|
+
2. Run the listed `closeout_context.fallback_commands` before any raw artifact read. Expected existing fallbacks are `agentera todo --format json`, `agentera docs --format json`, `agentera progress --format json`, `agentera query changelog --format json`, `agentera query --list-artifacts --format json`, and `agentera decisions --format json` when listed.
|
|
114
|
+
3. If fallback CLI state is still incomplete, raw reads may be used only as last-resort diagnostics or as explicit write targets after artifact path resolution.
|
|
115
|
+
4. Never hide or reconstruct caveats while preparing docs, changelog, TODO, or progress closeout. Carry them into the final synchronization note.
|
|
116
|
+
|
|
117
|
+
Closeout context does not approve publication, remote push, installed app refresh, profile refresh, vision edits, or objective-state edits. Treat those fields as recorded evidence or caveats only.
|
|
118
|
+
|
|
119
|
+
### Decision satisfaction authority
|
|
120
|
+
|
|
121
|
+
When documentation or closeout work touches decision satisfaction, agents may
|
|
122
|
+
mark provisional satisfaction with evidence only. Dokumentera must not mark or
|
|
123
|
+
imply user-confirmed final satisfaction; only the user confirms final
|
|
124
|
+
satisfaction. If decisions are compacted, missing satisfaction state, open,
|
|
125
|
+
provisional, or review-needed, preserve the caveat and review pressure in docs
|
|
126
|
+
or closeout notes instead of reconstructing hidden outcomes or claiming
|
|
127
|
+
automation proved intent.
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## First-run survey (convention detection)
|
|
132
|
+
|
|
133
|
+
When DOCS.md doesn't exist, run a survey first. Observe the project and propose a three-layer convention map for user approval.
|
|
134
|
+
|
|
135
|
+
Step markers: display `── step N/5: verb` before each step.
|
|
136
|
+
Steps: explore, propose, handle, audit, write.
|
|
137
|
+
|
|
138
|
+
### Step 1: Explore structure
|
|
139
|
+
|
|
140
|
+
Detect documentation conventions:
|
|
141
|
+
|
|
142
|
+
1. **Doc root**: check docs/, doc/, documentation/, wiki/, or root. Default to root.
|
|
143
|
+
2. **Existing docs**: README, CLAUDE.md, AGENTS.md, CONTRIBUTING.md, API docs, guides
|
|
144
|
+
3. **Auto-generated docs**: TypeDoc, Storybook, OpenAPI/Swagger, GoDoc, Rustdoc, Javadoc. Record each with output path.
|
|
145
|
+
4. **Style**: infer tone, structure patterns, formatting conventions from existing docs
|
|
146
|
+
5. **Skill artifacts**: check `.agentera/docs.yaml` mappings, root human artifacts, and `.agentera/*.yaml` agent artifacts
|
|
147
|
+
6. **Version files**: package.json, Cargo.toml, pyproject.toml, plugin.json, etc. Note files and current values. None found = omit versioning from DOCS.md.
|
|
148
|
+
|
|
149
|
+
### Step 2: Propose conventions
|
|
150
|
+
|
|
151
|
+
Draft three-layer `.agentera/docs.yaml` from the artifact schema and observed repository conventions:
|
|
152
|
+
|
|
153
|
+
1. **Conventions**: doc_root, style, auto_gen from observations. If version files found, populate `version_files` and ask about semver policy. No version files = omit block.
|
|
154
|
+
2. **Artifact mapping**: paths consistent with project's doc organization
|
|
155
|
+
3. **Index**: all discovered docs (auto-generated = `generated`, existing = `current`)
|
|
156
|
+
|
|
157
|
+
Present for user approval.
|
|
158
|
+
|
|
159
|
+
### Step 3: Handle existing artifacts
|
|
160
|
+
|
|
161
|
+
If artifacts exist at root but mapping places them elsewhere:
|
|
162
|
+
|
|
163
|
+
1. List artifacts that would move
|
|
164
|
+
2. Offer to relocate via `git mv`
|
|
165
|
+
3. If declined, update mapping to match actual locations
|
|
166
|
+
|
|
167
|
+
### Step 4: Pre-write self-audit
|
|
168
|
+
|
|
169
|
+
Pre-write self-audit: run `agentera lint --artifact <ARTIFACT> --text "<DRAFT>"` (or `--file <PATH>`; schema names such as `decisions` auto-resolve the artifact file when no input is given) on the draft entry to check verbosity overruns (per-artifact budget), abstraction creep (>=1 concrete anchor), and filler accumulation (banned patterns).
|
|
170
|
+
Max 3 revision attempts. Flag with [post-audit-flagged] if still failing.
|
|
171
|
+
|
|
172
|
+
Narration voice (riff, don't script):
|
|
173
|
+
|
|
174
|
+
- "Tightening this up..." · "Cutting the filler first..." · "One more pass..."
|
|
175
|
+
|
|
176
|
+
### Step 5: Write DOCS.md
|
|
177
|
+
|
|
178
|
+
Write the approved convention map to `.agentera/docs.yaml`. After writing, proceed to the originally requested mode, or stop if the survey was the entire request.
|
|
179
|
+
|
|
180
|
+
Artifact writing follows contract Section 24 (Artifact Writing Conventions): banned verbosity patterns, 25-word sentence cap, preferred vocabulary, and lead-with-conclusion structure.
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
## Intent-first mode (docs before code)
|
|
185
|
+
|
|
186
|
+
Docs-first workflow: document what a feature SHOULD do before building. Docs become the spec.
|
|
187
|
+
|
|
188
|
+
Step markers: display `── step N/5: verb` before each step.
|
|
189
|
+
Steps: understand, write, audit, update, suggest.
|
|
190
|
+
|
|
191
|
+
### Step 1: Understand the intent
|
|
192
|
+
|
|
193
|
+
Brief conversation (2-4 questions): what, who reads it, what format, what detail level.
|
|
194
|
+
|
|
195
|
+
Read VISION.md for direction/audience and decision profile per protocol confidence scale (CS1-CS5) conventions for doc style preferences if they exist.
|
|
196
|
+
|
|
197
|
+
### Step 2: Write the documentation
|
|
198
|
+
|
|
199
|
+
Write docs in the appropriate location: project-level (README, CLAUDE.md) to standard paths, feature docs to the project's docs directory, inline docs to source files.
|
|
200
|
+
|
|
201
|
+
**Principles**: follow DOCS.md style conventions, infer details from existing docs. Write as intended steady state (evergreen, non-temporal). Primary audience first. Concrete examples. DRY across doc files.
|
|
202
|
+
|
|
203
|
+
When presenting drafts, introduce what you wrote and why: what choices you made, what you left out on purpose, what you'd want feedback on. Don't just dump the doc.
|
|
204
|
+
|
|
205
|
+
Present draft for approval before writing.
|
|
206
|
+
|
|
207
|
+
### Step 3: Pre-write self-audit
|
|
208
|
+
|
|
209
|
+
Pre-write self-audit: run `agentera lint --artifact <ARTIFACT> --text "<DRAFT>"` (or `--file <PATH>`; schema names such as `decisions` auto-resolve the artifact file when no input is given) on the draft entry to check verbosity overruns (per-artifact budget), abstraction creep (>=1 concrete anchor), and filler accumulation (banned patterns).
|
|
210
|
+
Max 3 revision attempts. Flag with [post-audit-flagged] if still failing.
|
|
211
|
+
|
|
212
|
+
Narration voice (riff, don't script):
|
|
213
|
+
|
|
214
|
+
- "Tightening this up..." · "Cutting the filler first..." · "One more pass..."
|
|
215
|
+
|
|
216
|
+
### Step 4: Update DOCS.md
|
|
217
|
+
|
|
218
|
+
Add or update the relevant entry in DOCS.md:
|
|
219
|
+
|
|
220
|
+
- Document name and path
|
|
221
|
+
- Date written
|
|
222
|
+
- Status: `current`
|
|
223
|
+
|
|
224
|
+
Output constraint: ≤15 words per index entry description.
|
|
225
|
+
|
|
226
|
+
Artifact writing follows contract Section 24 (Artifact Writing Conventions): banned verbosity patterns, 25-word sentence cap, preferred vocabulary, and lead-with-conclusion structure.
|
|
227
|
+
|
|
228
|
+
### Step 5: Suggest next steps
|
|
229
|
+
|
|
230
|
+
- Feature docs: suggest ≡ planera to plan implementation
|
|
231
|
+
- Standalone docs: suggest update mode later for verification
|
|
232
|
+
|
|
233
|
+
---
|
|
234
|
+
|
|
235
|
+
## Explore-and-generate mode (docs for existing code)
|
|
236
|
+
|
|
237
|
+
Code exists, docs don't. Read codebase and generate.
|
|
238
|
+
|
|
239
|
+
Step markers: display `── step N/5: verb` before each step.
|
|
240
|
+
Steps: explore, gaps, generate, audit, update.
|
|
241
|
+
|
|
242
|
+
### Step 1: Explore
|
|
243
|
+
|
|
244
|
+
1. Map directory structure, read dependency manifests
|
|
245
|
+
2. Read existing docs to see what's already documented
|
|
246
|
+
3. Read key source files: architecture, public APIs, patterns
|
|
247
|
+
4. Read VISION.md, PROGRESS.md, DECISIONS.md, decision profile if they exist; use `agentera decisions --format json` for normal decision context and carry returned `missing_fields`, `compacted`, `caveats`, and `satisfaction.review_needed` pressure into documentation scope instead of raw-reading missing historical decision context.
|
|
248
|
+
5. `git log --oneline -20` for context
|
|
249
|
+
|
|
250
|
+
**Exit-early stop condition**: If DOCS.md exists with coverage at 100% and no files have changed since the last dokumentera audit (`git log --since` the last audit date in DOCS.md shows no changes), report exit signal `complete` (EX1): documentation current, and stop.
|
|
251
|
+
|
|
252
|
+
### Step 2: Identify gaps
|
|
253
|
+
|
|
254
|
+
Compare what exists against what should be documented: README.md accuracy, CLAUDE.md/AGENTS.md presence, API docs, CLI docs with usage, configuration docs, architectural decision docs.
|
|
255
|
+
|
|
256
|
+
### Step 3: Generate
|
|
257
|
+
|
|
258
|
+
Write docs for gaps, prioritized: (1) README, (2) CLAUDE.md, (3) API/CLI docs, (4) architecture docs. Follow DOCS.md style conventions.
|
|
259
|
+
|
|
260
|
+
When presenting drafts, introduce what you wrote and why: what you learned from the code, what design choices the doc reflects, what you're less sure about. Don't just dump the doc.
|
|
261
|
+
|
|
262
|
+
Present drafts for approval.
|
|
263
|
+
|
|
264
|
+
### Step 4: Pre-write self-audit
|
|
265
|
+
|
|
266
|
+
Pre-write self-audit: run `agentera lint --artifact <ARTIFACT> --text "<DRAFT>"` (or `--file <PATH>`; schema names such as `decisions` auto-resolve the artifact file when no input is given) on the draft entry to check verbosity overruns (per-artifact budget), abstraction creep (>=1 concrete anchor), and filler accumulation (banned patterns).
|
|
267
|
+
Max 3 revision attempts. Flag with [post-audit-flagged] if still failing.
|
|
268
|
+
|
|
269
|
+
Narration voice (riff, don't script):
|
|
270
|
+
|
|
271
|
+
- "Tightening this up..." · "Cutting the filler first..." · "One more pass..."
|
|
272
|
+
|
|
273
|
+
### Step 5: Update DOCS.md
|
|
274
|
+
|
|
275
|
+
Create or update DOCS.md with all items. Edit specific YAML entries when updating status/dates. If DOCS.md doesn't exist, run first-run survey first.
|
|
276
|
+
|
|
277
|
+
Artifact writing follows contract Section 24 (Artifact Writing Conventions): banned verbosity patterns, 25-word sentence cap, preferred vocabulary, and lead-with-conclusion structure.
|
|
278
|
+
|
|
279
|
+
---
|
|
280
|
+
|
|
281
|
+
## Update-and-verify mode (audit-driven)
|
|
282
|
+
|
|
283
|
+
Docs exist but may be out of sync with implementation.
|
|
284
|
+
|
|
285
|
+
Step markers: display `── step N/6: verb` before each step.
|
|
286
|
+
Steps: discover, verify, prose-enforce, report, audit, update.
|
|
287
|
+
|
|
288
|
+
### Step 1: Discover
|
|
289
|
+
|
|
290
|
+
Identify all doc files: root (README, CLAUDE.md, etc.), directories (docs/, .github/), config comments. Read DOCS.md for current index. Track auto-generated docs as `generated`. Skip node_modules/, .git/, vendor/.
|
|
291
|
+
|
|
292
|
+
### Step 2: Verify
|
|
293
|
+
|
|
294
|
+
Check each doc file on four dimensions:
|
|
295
|
+
|
|
296
|
+
- **Gaps**: documented features/APIs/behaviors that don't exist in code
|
|
297
|
+
- **Staleness**: changed signatures, removed features, outdated setup instructions
|
|
298
|
+
- **Redundancies**: duplicated content across doc files
|
|
299
|
+
- **Misalignments**: docs contradict actual code behavior
|
|
300
|
+
|
|
301
|
+
For each finding: quote the doc section, reference code location (file:line), explain the discrepancy.
|
|
302
|
+
|
|
303
|
+
### Step 3: Doc-prose enforcement
|
|
304
|
+
|
|
305
|
+
Check all docs indexed in DOCS.md against the 3 self-audit rules:
|
|
306
|
+
|
|
307
|
+
1. **Read DOCS.md index**: if DOCS.md is absent, run first-run survey to bootstrap it, then continue. Extract tracked docs from the `index` list. Skip entries with `generated` or `missing` status.
|
|
308
|
+
2. **For each doc**, read the file and check against the 3 rules:
|
|
309
|
+
- **Verbosity overrun**: entry word counts exceeding token budgets for the artifact's scope. Flag entries that exceed budget without compaction.
|
|
310
|
+
- **Abstraction creep**: sections lacking ≥1 concrete anchor (file path, line number, commit hash, metric value, identifier, direct quote). Flag entries that narrate concepts without evidence.
|
|
311
|
+
- **Filler accumulation**: scan for banned verbosity patterns: meta-commentary about writing, hedging qualifiers, redundant transitions, self-referential process narration, filler introductions, summary preambles, excessive justification. Flag entries containing banned patterns.
|
|
312
|
+
3. **Surface `[post-audit-flagged]` entries**: scan each doc for the `[post-audit-flagged]` marker. Report any flagged entries as warning-level findings.
|
|
313
|
+
4. **Report findings** at standard severity levels:
|
|
314
|
+
- **critical** (SF1): doc section contradicts code, or instructions that would cause user errors
|
|
315
|
+
- **warning** (SF2): verbosity above budgets, abstraction creep, accumulated filler patterns, pre-existing `[post-audit-flagged]` markers
|
|
316
|
+
- **info** (SF3): minor style issues, single banned pattern in an otherwise clean entry
|
|
317
|
+
|
|
318
|
+
### Step 4: Report and fix
|
|
319
|
+
|
|
320
|
+
By severity: ⇶ critical (VT5, causes user errors), ⇉ warning (VT6, causes confusion), ⇢ info (VT8, cosmetic). For each finding, offer to: fix the doc, file to TODO.md (code is wrong per the docs-first workflow), or skip.
|
|
321
|
+
|
|
322
|
+
### Step 5: Pre-write self-audit
|
|
323
|
+
|
|
324
|
+
Pre-write self-audit: run `agentera lint --artifact <ARTIFACT> --text "<DRAFT>"` (or `--file <PATH>`; schema names such as `decisions` auto-resolve the artifact file when no input is given) on the draft entry to check verbosity overruns (per-artifact budget), abstraction creep (>=1 concrete anchor), and filler accumulation (banned patterns).
|
|
325
|
+
Max 3 revision attempts. Flag with [post-audit-flagged] if still failing.
|
|
326
|
+
|
|
327
|
+
Narration voice (riff, don't script):
|
|
328
|
+
|
|
329
|
+
- "Tightening this up..." · "Cutting the filler first..." · "One more pass..."
|
|
330
|
+
|
|
331
|
+
### Step 6: Update DOCS.md
|
|
332
|
+
|
|
333
|
+
Update the index with:
|
|
334
|
+
|
|
335
|
+
- ▸ Audit date
|
|
336
|
+
- ▸ Status changes (■ current / ▣ stale / □ missing)
|
|
337
|
+
- ▸ Coverage numbers
|
|
338
|
+
- ▸ Audit log entry
|
|
339
|
+
|
|
340
|
+
---
|
|
341
|
+
|
|
342
|
+
## Safety rails
|
|
343
|
+
|
|
344
|
+
<critical>
|
|
345
|
+
- NEVER modify documentation without explicit user approval. Present drafts and get confirmation.
|
|
346
|
+
- NEVER update docs to match broken code. Per the docs-first workflow, if code diverges from docs, the code is wrong. Document the divergence as an issue in TODO.md.
|
|
347
|
+
- NEVER write temporal documentation (changelogs, "we recently added..."). Write as the intended steady state, evergreen and non-temporal.
|
|
348
|
+
- NEVER duplicate information across doc files. Keep it DRY: reference, don't repeat.
|
|
349
|
+
- NEVER write generic filler documentation. Every sentence should be specific to this project. If there's nothing useful to say about a section, omit it.
|
|
350
|
+
- NEVER skip the verification step in update mode. Every doc claim must be checked against code.
|
|
351
|
+
- NEVER auto-generate documentation without reading the code it describes. Understanding precedes documentation.
|
|
352
|
+
</critical>
|
|
353
|
+
|
|
354
|
+
---
|
|
355
|
+
|
|
356
|
+
## Exit signals
|
|
357
|
+
|
|
358
|
+
Report one of these statuses at workflow completion (protocol refs: EX1-EX4).
|
|
359
|
+
|
|
360
|
+
Format: `▤ dokumentera · <status>` followed by a summary sentence.
|
|
361
|
+
For flagged, stuck, and waiting: add `▸` (VT15) bullet details below the summary.
|
|
362
|
+
|
|
363
|
+
- **complete** (EX1): Documentation was written, updated, or audited successfully; DOCS.md is current, and all drafted content received user approval before writing.
|
|
364
|
+
- **flagged** (EX2): Documentation tasks completed but gaps remain (e.g., some doc files could not be verified against code, coverage is partial, or the audit found issues that were logged but not yet fixed).
|
|
365
|
+
- **stuck** (EX3): Cannot proceed because a user approval step was declined, a required artifact (VISION.md, source code) is missing or inaccessible, or a contradicting doc-vs-code situation requires a decision the capability should not make autonomously.
|
|
366
|
+
- **waiting** (EX4): The documentation intent is unclear: the target audience, format, or scope of what to document was not specified and cannot be inferred from the codebase or DOCS.md.
|
|
367
|
+
|
|
368
|
+
---
|
|
369
|
+
|
|
370
|
+
## Cross-capability integration
|
|
371
|
+
|
|
372
|
+
Dokumentera is part of a twelve-capability suite. It is the documentation layer and owns the docs-first workflow.
|
|
373
|
+
|
|
374
|
+
### Dokumentera feeds planera (docs-first workflow)
|
|
375
|
+
|
|
376
|
+
In the strict docs-first workflow, dokumentera writes intent docs first, then planera breaks them into implementation tasks. The docs become the spec that planera's acceptance criteria verify against. When the plan includes documentation tasks, dokumentera handles them.
|
|
377
|
+
|
|
378
|
+
### Dokumentera feeds realisera
|
|
379
|
+
|
|
380
|
+
When dokumentera writes intent-first docs for a feature that doesn't exist yet, realisera implements code to match those docs. The docs are the target state; if code diverges from docs, the code is wrong per the docs-first workflow.
|
|
381
|
+
|
|
382
|
+
### Dokumentera is informed by inspektera
|
|
383
|
+
|
|
384
|
+
HEALTH.md findings may include documentation gaps. Inspektera's architecture alignment dimension can surface undocumented modules or APIs.
|
|
385
|
+
|
|
386
|
+
### Dokumentera is informed by visionera
|
|
387
|
+
|
|
388
|
+
VISION.md sets the project's direction and audience. Dokumentera reads it to understand who the documentation is for and what tone to use.
|
|
389
|
+
|
|
390
|
+
### Dokumentera is informed by profilera
|
|
391
|
+
|
|
392
|
+
The decision profile calibrates documentation style: the user's preferences for detail level, tone, format, and which docs they consider essential.
|
|
393
|
+
|
|
394
|
+
### Dokumentera reads visualisera output
|
|
395
|
+
|
|
396
|
+
DESIGN.md provides visual identity context that dokumentera respects when generating user-facing documentation, ensuring docs match the project's declared aesthetic and voice.
|
|
397
|
+
|
|
398
|
+
### Dokumentera feeds profilera
|
|
399
|
+
|
|
400
|
+
Documentation decisions (what to document, how, at what depth) are signal for profilera's extraction scripts.
|
|
401
|
+
|
|
402
|
+
---
|
|
403
|
+
|
|
404
|
+
## Getting started
|
|
405
|
+
|
|
406
|
+
### Docs-first workflow: document before building
|
|
407
|
+
|
|
408
|
+
1. ▤ dokumentera: write intent docs for the feature (what it should do, how it should work)
|
|
409
|
+
2. ≡ planera: plan the implementation with acceptance criteria derived from the docs
|
|
410
|
+
3. ⧉ realisera: build to match the docs
|
|
411
|
+
4. ▤ dokumentera: update mode to verify docs still match implementation
|
|
412
|
+
|
|
413
|
+
### Document existing code
|
|
414
|
+
|
|
415
|
+
1. ▤ dokumentera: explore-and-generate mode reads the codebase and writes docs for what exists
|
|
416
|
+
2. Review generated docs for accuracy and completeness
|
|
417
|
+
|
|
418
|
+
### Audit and maintain
|
|
419
|
+
|
|
420
|
+
1. ▤ dokumentera: update-and-verify mode checks all docs against code
|
|
421
|
+
2. Fix findings or file code issues to TODO.md
|
|
422
|
+
|
|
423
|
+
### Project bootstrap
|
|
424
|
+
|
|
425
|
+
1. ⛥ visionera: create VISION.md (strategic direction)
|
|
426
|
+
2. ▤ dokumentera: create README.md, CLAUDE.md, AGENTS.md (project documentation)
|
|
427
|
+
3. ≡ planera: plan first features
|
|
428
|
+
4. ⧉ realisera: start building
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
ARTIFACTS:
|
|
2
|
+
1:
|
|
3
|
+
id: A1
|
|
4
|
+
artifact_id: docs
|
|
5
|
+
local_role: produces_and_consumes
|
|
6
|
+
description: >-
|
|
7
|
+
Documentation contract with conventions, artifact mapping, and
|
|
8
|
+
documentation index. Dokumentera writes and reads doc root, style
|
|
9
|
+
conventions, auto-generated doc tracking, project-local artifact mappings,
|
|
10
|
+
and a status index (current/stale/missing) for tracked docs. During
|
|
11
|
+
closeout, Dokumentera consumes docs state through CLI `closeout_context`
|
|
12
|
+
before raw artifact fallback.
|
|
13
|
+
2:
|
|
14
|
+
id: A2
|
|
15
|
+
artifact_id: vision
|
|
16
|
+
local_role: consumes
|
|
17
|
+
description: >-
|
|
18
|
+
Dokumentera reads this to understand who the documentation is for
|
|
19
|
+
and what tone to use.
|
|
20
|
+
3:
|
|
21
|
+
id: A3
|
|
22
|
+
artifact_id: progress
|
|
23
|
+
local_role: consumes
|
|
24
|
+
description: >-
|
|
25
|
+
Dokumentera reads this during explore-and-generate mode to understand
|
|
26
|
+
recent project context. During closeout, latest progress evidence and
|
|
27
|
+
verification pointers are consumed through CLI `closeout_context` before
|
|
28
|
+
raw artifact fallback.
|
|
29
|
+
4:
|
|
30
|
+
id: A4
|
|
31
|
+
artifact_id: decisions
|
|
32
|
+
local_role: consumes
|
|
33
|
+
description: >-
|
|
34
|
+
Dokumentera reads this during explore-and-generate mode for project
|
|
35
|
+
context and decision awareness.
|
|
36
|
+
5:
|
|
37
|
+
id: A5
|
|
38
|
+
artifact_id: health
|
|
39
|
+
local_role: consumes
|
|
40
|
+
description: >-
|
|
41
|
+
Dokumentera reads this to discover documentation gaps surfaced
|
|
42
|
+
during health audits.
|
|
43
|
+
6:
|
|
44
|
+
id: A6
|
|
45
|
+
artifact_id: todo
|
|
46
|
+
local_role: produces_and_consumes
|
|
47
|
+
description: >-
|
|
48
|
+
Dokumentera writes to this when code diverges from docs (per DTC,
|
|
49
|
+
the code is wrong). Also reads for context during documentation work;
|
|
50
|
+
closeout blocker state is consumed through CLI `closeout_context` before
|
|
51
|
+
raw artifact fallback.
|
|
52
|
+
7:
|
|
53
|
+
id: A7
|
|
54
|
+
artifact_id: design
|
|
55
|
+
local_role: consumes
|
|
56
|
+
description: >-
|
|
57
|
+
Dokumentera reads this to respect the declared aesthetic and voice
|
|
58
|
+
when generating user-facing documentation.
|
|
59
|
+
8:
|
|
60
|
+
id: A8
|
|
61
|
+
artifact_id: profile
|
|
62
|
+
local_role: consumes
|
|
63
|
+
description: >-
|
|
64
|
+
Dokumentera reads this to calibrate documentation style preferences:
|
|
65
|
+
detail level, tone, format.
|
|
66
|
+
9:
|
|
67
|
+
id: A9
|
|
68
|
+
artifact_id: changelog
|
|
69
|
+
local_role: consumes
|
|
70
|
+
description: >-
|
|
71
|
+
Dokumentera reads this during closeout synchronization through CLI
|
|
72
|
+
`closeout_context` to preserve the changelog boundary and avoid inventing
|
|
73
|
+
release, tag, publication, or remote state.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
EXIT_CONDITIONS:
|
|
2
|
+
1:
|
|
3
|
+
id: E1
|
|
4
|
+
condition: complete
|
|
5
|
+
description: >-
|
|
6
|
+
Documentation was written, updated, or audited successfully.
|
|
7
|
+
DOCS.md is current, and all drafted content received user
|
|
8
|
+
approval before writing.
|
|
9
|
+
exit_signal: complete
|
|
10
|
+
2:
|
|
11
|
+
id: E2
|
|
12
|
+
condition: flagged
|
|
13
|
+
description: >-
|
|
14
|
+
Documentation tasks completed but gaps remain. Possible causes:
|
|
15
|
+
some doc files could not be verified against code, coverage is
|
|
16
|
+
partial, or the audit found issues that were logged but not yet
|
|
17
|
+
fixed.
|
|
18
|
+
exit_signal: flagged
|
|
19
|
+
3:
|
|
20
|
+
id: E3
|
|
21
|
+
condition: stuck
|
|
22
|
+
description: >-
|
|
23
|
+
Cannot proceed because a user approval step was declined, a
|
|
24
|
+
required artifact (VISION.md, source code) is missing or
|
|
25
|
+
inaccessible, or a contradicting doc-vs-code situation requires
|
|
26
|
+
a decision the capability should not make autonomously.
|
|
27
|
+
exit_signal: stuck
|
|
28
|
+
4:
|
|
29
|
+
id: E4
|
|
30
|
+
condition: waiting
|
|
31
|
+
description: >-
|
|
32
|
+
The documentation intent is unclear: the target audience, format,
|
|
33
|
+
or scope of what to document was not specified and cannot be
|
|
34
|
+
inferred from the codebase or DOCS.md.
|
|
35
|
+
exit_signal: waiting
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
TRIGGERS:
|
|
2
|
+
1:
|
|
3
|
+
id: T1
|
|
4
|
+
description: >-
|
|
5
|
+
Direct invocation by name or slash command. Matches when the user
|
|
6
|
+
explicitly requests dokumentera.
|
|
7
|
+
priority: high
|
|
8
|
+
patterns:
|
|
9
|
+
- "dokumentera"
|
|
10
|
+
- "/dokumentera"
|
|
11
|
+
2:
|
|
12
|
+
id: T2
|
|
13
|
+
description: >-
|
|
14
|
+
Documentation creation requests. Matches when the user wants to
|
|
15
|
+
write or create documentation, including DTC-first workflows.
|
|
16
|
+
priority: medium
|
|
17
|
+
patterns:
|
|
18
|
+
- "write docs"
|
|
19
|
+
- "document this"
|
|
20
|
+
- "create README"
|
|
21
|
+
- "write CLAUDE.md"
|
|
22
|
+
- "write AGENTS.md"
|
|
23
|
+
- "docs first"
|
|
24
|
+
- "document before building"
|
|
25
|
+
3:
|
|
26
|
+
id: T3
|
|
27
|
+
description: >-
|
|
28
|
+
Documentation maintenance and audit requests. Matches when the user
|
|
29
|
+
wants to update, check, or verify existing documentation.
|
|
30
|
+
priority: medium
|
|
31
|
+
patterns:
|
|
32
|
+
- "update the docs"
|
|
33
|
+
- "audit docs"
|
|
34
|
+
- "check documentation"
|
|
35
|
+
- "docs out of sync"
|