@plainconceptsplatform/agent-harness 3.3.0 → 3.4.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/LICENSE +21 -21
- package/README.md +454 -454
- package/cli/commands/join.js +259 -259
- package/cli/commands/migrate.js +310 -310
- package/cli/commands/shared.js +27 -27
- package/cli/commands/single.js +79 -79
- package/cli/commands/wizard.js +134 -134
- package/cli/fragments/ops-backlog/az.md +28 -28
- package/cli/fragments/ops-backlog/gh.md +28 -28
- package/cli/fragments/ops-backlog/jira.md +28 -28
- package/cli/fragments/ops-review/az.md +62 -62
- package/cli/fragments/ops-review/gh.md +51 -51
- package/cli/fragments/ops-review/gl.md +55 -55
- package/cli/fragments/ops-ship/gh.md +67 -67
- package/cli/fragments/ops-ship/gl.md +84 -84
- package/cli/index.js +116 -116
- package/cli/presets/clean.json +21 -21
- package/cli/presets/models.json +68 -68
- package/cli/presets/optimization.json +32 -32
- package/cli/presets/platforms.json +76 -76
- package/cli/presets/source.json +23 -23
- package/cli/steps/clean/index.js +120 -120
- package/cli/steps/copy/agents.js +120 -120
- package/cli/steps/copy/fullstack-engineer.js +89 -89
- package/cli/steps/copy/opencode-json.js +324 -324
- package/cli/steps/copy/skills.js +316 -307
- package/cli/steps/models/format.js +88 -88
- package/cli/steps/models/index.js +64 -64
- package/cli/steps/openspec/index.js +136 -136
- package/cli/steps/optimization/codegraph.js +141 -141
- package/cli/steps/optimization/detect.js +66 -66
- package/cli/steps/optimization/humanizer.js +17 -17
- package/cli/steps/optimization/index.js +158 -158
- package/cli/steps/optimization/memory.js +91 -91
- package/cli/steps/optimization/patch-guardrails.js +111 -111
- package/cli/steps/optimization/simple-english.js +17 -17
- package/cli/steps/optimization/skills-lock.js +30 -30
- package/cli/steps/platform/index.js +109 -109
- package/cli/steps/source/index.js +123 -123
- package/cli/utils/agent-color.js +111 -111
- package/cli/utils/copy.js +134 -134
- package/cli/utils/exec-spinner.js +47 -47
- package/cli/utils/exec.js +134 -134
- package/cli/utils/legacy-check.js +30 -30
- package/cli/utils/models-cache.js +58 -58
- package/cli/utils/models-pricing.js +42 -42
- package/cli/utils/paths.js +81 -80
- package/cli/utils/process.js +3 -3
- package/cli/utils/terminal.js +6 -6
- package/cli/utils/update-manifest.js +75 -75
- package/harness/.opencode/_gitignore +10 -9
- package/harness/.opencode/commands/ops-backlog.md +10 -10
- package/harness/.opencode/commands/ops-review.md +10 -8
- package/harness/.opencode/commands/ops-ship.md +9 -9
- package/harness/.opencode/commands/plan-archive.md +7 -5
- package/harness/.opencode/commands/plan-explore.md +11 -9
- package/harness/.opencode/commands/plan-propose.md +11 -9
- package/harness/.opencode/commands/plan-quick.md +7 -5
- package/harness/.opencode/commands/plan-story.md +11 -9
- package/harness/.opencode/commands/repo-audit.md +7 -5
- package/harness/.opencode/commands/repo-help.md +5 -5
- package/harness/.opencode/package.json +5 -5
- package/harness/.opencode/plugins/pc-subagent-monitor.js +184 -184
- package/harness/.opencode/plugins/pc-subagent-tiers.js +367 -354
- package/harness/.opencode/plugins/pc-system-reminders.js +386 -386
- package/harness/.opencode/scripts/check-diff.mjs +244 -244
- package/harness/.opencode/scripts/code-rules.mjs +288 -288
- package/harness/ARCHITECTURE.md +13 -13
- package/harness/DESIGN.md +13 -13
- package/harness/opencode.jsonc +36 -36
- package/harness/openspec/config.yaml +20 -20
- package/harness/skills-lock.json +17 -17
- package/package.json +12 -14
- package/skills/agent-harness-cli/SKILL.md +86 -86
- package/skills/pc-guardrails-generic/SKILL.md +53 -53
- package/skills/pc-guardrails-project/SKILL.md +8 -8
- package/skills/pc-make-architecture/structure-template.md +64 -64
- package/skills/pc-make-engineer/SKILL.md +59 -59
- package/skills/pc-make-engineer/template.md +36 -36
- package/skills/pc-make-guardrails/category-reference.md +112 -112
- package/skills/pc-make-merge-risk-assess/SKILL.md +70 -70
- package/skills/pc-make-merge-risk-assess/category-reference.md +114 -114
- package/skills/pc-ops-ship/SKILL.md +22 -22
- package/skills/pc-plan-apply/SKILL.md +86 -86
- package/skills/pc-plan-apply/simple-mode.md +21 -21
- package/skills/pc-plan-explore/SKILL.md +21 -21
- package/skills/pc-plan-goal/SKILL.md +91 -91
- package/skills/pc-plan-goal/failure-policy.md +30 -30
- package/skills/pc-plan-goal/output-mode.md +10 -10
- package/skills/pc-plan-propose/SKILL.md +125 -125
- package/skills/pc-plan-propose/task-annotation.md +39 -39
- package/skills/pc-plan-quick/SKILL.md +46 -46
- package/skills/pc-repo-audit/SKILL.md +44 -44
- package/skills/pc-repo-help/SKILL.md +87 -87
- package/skills/pc-repo-verify/SKILL.md +150 -150
package/harness/opencode.jsonc
CHANGED
|
@@ -1,36 +1,36 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://opencode.ai/config.json",
|
|
3
|
-
"mcp": {
|
|
4
|
-
"servers": {
|
|
5
|
-
"agent-browser": {
|
|
6
|
-
"type": "local",
|
|
7
|
-
"command": ["agent-browser", "mcp", "--tools", "core"],
|
|
8
|
-
"disabled": false
|
|
9
|
-
}
|
|
10
|
-
},
|
|
11
|
-
"timeout": {
|
|
12
|
-
"catalog": 300000,
|
|
13
|
-
"execution": 300000
|
|
14
|
-
}
|
|
15
|
-
},
|
|
16
|
-
"compaction": {
|
|
17
|
-
"auto": true,
|
|
18
|
-
"buffer": 10000
|
|
19
|
-
},
|
|
20
|
-
"permissions": [
|
|
21
|
-
{ "action": "question", "resource": "*", "effect": "allow" },
|
|
22
|
-
{ "action": "skill", "resource": "*", "effect": "allow" }
|
|
23
|
-
],
|
|
24
|
-
"skills": [".agents/skills"],
|
|
25
|
-
"default_agent": "plan",
|
|
26
|
-
"agents": {
|
|
27
|
-
"build": { "mode": "primary" },
|
|
28
|
-
"plan": {
|
|
29
|
-
"mode": "primary",
|
|
30
|
-
"permissions": [
|
|
31
|
-
{ "action": "edit", "resource": "*", "effect": "deny" },
|
|
32
|
-
{ "action": "subagent", "resource": "*", "effect": "deny" }
|
|
33
|
-
]
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://opencode.ai/config.json",
|
|
3
|
+
"mcp": {
|
|
4
|
+
"servers": {
|
|
5
|
+
"agent-browser": {
|
|
6
|
+
"type": "local",
|
|
7
|
+
"command": ["agent-browser", "mcp", "--tools", "core"],
|
|
8
|
+
"disabled": false
|
|
9
|
+
}
|
|
10
|
+
},
|
|
11
|
+
"timeout": {
|
|
12
|
+
"catalog": 300000,
|
|
13
|
+
"execution": 300000
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"compaction": {
|
|
17
|
+
"auto": true,
|
|
18
|
+
"buffer": 10000
|
|
19
|
+
},
|
|
20
|
+
"permissions": [
|
|
21
|
+
{ "action": "question", "resource": "*", "effect": "allow" },
|
|
22
|
+
{ "action": "skill", "resource": "*", "effect": "allow" }
|
|
23
|
+
],
|
|
24
|
+
"skills": [".agents/skills"],
|
|
25
|
+
"default_agent": "plan",
|
|
26
|
+
"agents": {
|
|
27
|
+
"build": { "mode": "primary" },
|
|
28
|
+
"plan": {
|
|
29
|
+
"mode": "primary",
|
|
30
|
+
"permissions": [
|
|
31
|
+
{ "action": "edit", "resource": "*", "effect": "deny" },
|
|
32
|
+
{ "action": "subagent", "resource": "*", "effect": "deny" }
|
|
33
|
+
]
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
schema: spec-driven
|
|
2
|
-
|
|
3
|
-
# Project context (optional)
|
|
4
|
-
# This is shown to AI when creating artifacts.
|
|
5
|
-
# Add your tech stack, conventions, style guides, domain knowledge, etc.
|
|
6
|
-
# Example:
|
|
7
|
-
# context: |
|
|
8
|
-
# Tech stack: TypeScript, React, Node.js
|
|
9
|
-
# We use conventional commits
|
|
10
|
-
# Domain: e-commerce platform
|
|
11
|
-
|
|
12
|
-
# Per-artifact rules (optional)
|
|
13
|
-
# Add custom rules for specific artifacts.
|
|
14
|
-
# Example:
|
|
15
|
-
# rules:
|
|
16
|
-
# proposal:
|
|
17
|
-
# - Keep proposals under 500 words
|
|
18
|
-
# - Always include a "Non-goals" section
|
|
19
|
-
# tasks:
|
|
20
|
-
# - Break tasks into chunks of max 2 hours
|
|
1
|
+
schema: spec-driven
|
|
2
|
+
|
|
3
|
+
# Project context (optional)
|
|
4
|
+
# This is shown to AI when creating artifacts.
|
|
5
|
+
# Add your tech stack, conventions, style guides, domain knowledge, etc.
|
|
6
|
+
# Example:
|
|
7
|
+
# context: |
|
|
8
|
+
# Tech stack: TypeScript, React, Node.js
|
|
9
|
+
# We use conventional commits
|
|
10
|
+
# Domain: e-commerce platform
|
|
11
|
+
|
|
12
|
+
# Per-artifact rules (optional)
|
|
13
|
+
# Add custom rules for specific artifacts.
|
|
14
|
+
# Example:
|
|
15
|
+
# rules:
|
|
16
|
+
# proposal:
|
|
17
|
+
# - Keep proposals under 500 words
|
|
18
|
+
# - Always include a "Non-goals" section
|
|
19
|
+
# tasks:
|
|
20
|
+
# - Break tasks into chunks of max 2 hours
|
package/harness/skills-lock.json
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 1,
|
|
3
|
-
"skills": {
|
|
4
|
-
"find-skills": {
|
|
5
|
-
"source": "vercel-labs/skills",
|
|
6
|
-
"sourceType": "github",
|
|
7
|
-
"skillPath": "skills/find-skills/SKILL.md",
|
|
8
|
-
"computedHash": "781bd6d3f9b19f8c9af6b53d8d0e4876d0183841b565db34ca7092ffa412d111"
|
|
9
|
-
},
|
|
10
|
-
"user-story": {
|
|
11
|
-
"source": "deanpeters/product-manager-skills",
|
|
12
|
-
"sourceType": "github",
|
|
13
|
-
"skillPath": "skills/user-story/SKILL.md",
|
|
14
|
-
"computedHash": "user-story-placeholder"
|
|
15
|
-
}
|
|
16
|
-
}
|
|
17
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"skills": {
|
|
4
|
+
"find-skills": {
|
|
5
|
+
"source": "vercel-labs/skills",
|
|
6
|
+
"sourceType": "github",
|
|
7
|
+
"skillPath": "skills/find-skills/SKILL.md",
|
|
8
|
+
"computedHash": "781bd6d3f9b19f8c9af6b53d8d0e4876d0183841b565db34ca7092ffa412d111"
|
|
9
|
+
},
|
|
10
|
+
"user-story": {
|
|
11
|
+
"source": "deanpeters/product-manager-skills",
|
|
12
|
+
"sourceType": "github",
|
|
13
|
+
"skillPath": "skills/user-story/SKILL.md",
|
|
14
|
+
"computedHash": "user-story-placeholder"
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@plainconceptsplatform/agent-harness",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.4.1",
|
|
4
4
|
"description": "Installs the Plain Concepts Platform Harness into any codebase, and keeps it up to date. Wires OpenCode, OpenSpec, codegraph, and agentmemory into a multi-agent workflow that runs on native parallel subagents.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"opencode",
|
|
@@ -42,7 +42,6 @@
|
|
|
42
42
|
"engines": {
|
|
43
43
|
"node": ">=18"
|
|
44
44
|
},
|
|
45
|
-
"packageManager": "pnpm@11.10.0",
|
|
46
45
|
"dependencies": {
|
|
47
46
|
"@inquirer/prompts": "^7.0.0",
|
|
48
47
|
"chalk": "^5.0.0",
|
|
@@ -51,17 +50,6 @@
|
|
|
51
50
|
"jsonc-parser": "^3.3.1",
|
|
52
51
|
"ora": "^8.0.0"
|
|
53
52
|
},
|
|
54
|
-
"scripts": {
|
|
55
|
-
"lint": "eslint .",
|
|
56
|
-
"lint:fix": "eslint . --fix",
|
|
57
|
-
"lint:md": "markdownlint-cli2 \"**/*.md\"",
|
|
58
|
-
"lint:md:fix": "markdownlint-cli2 --fix \"**/*.md\"",
|
|
59
|
-
"test": "vitest run",
|
|
60
|
-
"test:watch": "vitest",
|
|
61
|
-
"prepublishOnly": "npm run lint && npm run lint:md && npm run test",
|
|
62
|
-
"release:dry": "pnpm publish --dry-run --no-git-checks --access public",
|
|
63
|
-
"release": "pnpm publish --no-git-checks --access public"
|
|
64
|
-
},
|
|
65
53
|
"devDependencies": {
|
|
66
54
|
"@eslint/js": "^9.0.0",
|
|
67
55
|
"eslint": "^9.0.0",
|
|
@@ -71,5 +59,15 @@
|
|
|
71
59
|
},
|
|
72
60
|
"vitest": {
|
|
73
61
|
"environment": "node"
|
|
62
|
+
},
|
|
63
|
+
"scripts": {
|
|
64
|
+
"lint": "eslint .",
|
|
65
|
+
"lint:fix": "eslint . --fix",
|
|
66
|
+
"lint:md": "markdownlint-cli2 \"**/*.md\"",
|
|
67
|
+
"lint:md:fix": "markdownlint-cli2 --fix \"**/*.md\"",
|
|
68
|
+
"test": "vitest run",
|
|
69
|
+
"test:watch": "vitest",
|
|
70
|
+
"release:dry": "pnpm publish --dry-run --no-git-checks --access public",
|
|
71
|
+
"release": "pnpm publish --no-git-checks --access public"
|
|
74
72
|
}
|
|
75
|
-
}
|
|
73
|
+
}
|
|
@@ -1,86 +1,86 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: agent-harness-cli
|
|
3
|
-
description: Drive the agent-harness CLI - install the Plain Concepts Platform Harness into a repository, bring an existing one up to date, set up a teammate's machine, or rerun a single step. Load when asked to install, update, or repair the Platform Harness, when a repo needs AI/agent scaffolding set up, or when a command like `npx @plainconceptsplatform/agent-harness` fails and needs diagnosing.
|
|
4
|
-
license: MIT
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# agent-harness CLI
|
|
8
|
-
|
|
9
|
-
`agent-harness` installs the **Plain Concepts Platform Harness** into a repository and keeps it up to date. The harness is Plain Concepts' own, and it is the set of files agents work from: slash commands, `pc-*` skills (the `pc-` is Plain Concepts), an agent team, OpenCode plugins, an OpenSpec workspace, and generated `ARCHITECTURE.md` and `DESIGN.md`.
|
|
10
|
-
|
|
11
|
-
Everything runs against the **current working directory**. `cd` into the target repository first; there is no `--path` flag.
|
|
12
|
-
|
|
13
|
-
## Pick the right verb
|
|
14
|
-
|
|
15
|
-
Read the repo before running anything. `.opencode/harness.json` is the marker for "harness already installed".
|
|
16
|
-
|
|
17
|
-
| Situation | Command |
|
|
18
|
-
| --- | --- |
|
|
19
|
-
| No `.opencode/harness.json` | `npx @plainconceptsplatform/agent-harness@latest` (the install wizard) |
|
|
20
|
-
| Harness present, want the latest release's files | `npx @plainconceptsplatform/agent-harness@latest update` |
|
|
21
|
-
| Harness present, new machine or new teammate | `npx @plainconceptsplatform/agent-harness join` |
|
|
22
|
-
| One specific thing needs redoing | a single step command, see below |
|
|
23
|
-
|
|
24
|
-
Requires Node.js 18+.
|
|
25
|
-
|
|
26
|
-
## The install wizard is interactive
|
|
27
|
-
|
|
28
|
-
The wizard asks about source scope, backlog and repository platform, three models, and optional token-optimization tools. **Do not run it in a non-interactive shell.** It will hang or abort. If you cannot present prompts to a human, say so and hand the command to the user rather than trying to drive it.
|
|
29
|
-
|
|
30
|
-
Everything else (`update`, and the single-step commands other than `platform`, `models`, `optimization`) runs without prompts.
|
|
31
|
-
|
|
32
|
-
## Single-step commands
|
|
33
|
-
|
|
34
|
-
Run one step without the full wizard. Each reuses context from `.opencode/harness.json` when it needs to.
|
|
35
|
-
|
|
36
|
-
```
|
|
37
|
-
clean Remove pre-existing AI files (AGENTS.md, .cursorrules, CLAUDE.md, ...)
|
|
38
|
-
platform Choose backlog + repository platform
|
|
39
|
-
copy Copy agents, skills, commands, docs into the repo
|
|
40
|
-
openspec Initialize the OpenSpec workspace
|
|
41
|
-
models Choose plan / build / fast models
|
|
42
|
-
optimization Configure RTK, quota, Simple English, codegraph, agentmemory, humanizer
|
|
43
|
-
browser Install agent-browser (npm package + its Chrome for Testing)
|
|
44
|
-
metadata Rewrite .opencode/harness.json
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
`metadata` last if you ran several, because it refreshes the config the others read.
|
|
48
|
-
|
|
49
|
-
## What lands in the repo
|
|
50
|
-
|
|
51
|
-
```
|
|
52
|
-
.opencode/
|
|
53
|
-
harness.json harness config: platform, models, agents.maxConcurrent
|
|
54
|
-
harness-managed.json hash per managed file, so update spares your edits
|
|
55
|
-
harness.user.json per-developer model override (gitignored)
|
|
56
|
-
harness-run.json live subagent wave state (gitignored)
|
|
57
|
-
commands/ slash commands
|
|
58
|
-
plugins/ pc-subagent-monitor, pc-subagent-tiers, pc-system-reminders
|
|
59
|
-
agents/ fullstack-engineer + user-created *-engineer files
|
|
60
|
-
.agents/skills/ pc-* skills
|
|
61
|
-
AGENTS.md ARCHITECTURE.md DESIGN.md
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
After a fresh install, the next move is `/repo-initialize` inside OpenCode. That is what generates real `ARCHITECTURE.md` and `DESIGN.md` and activates the agent team. Installing the harness alone does not do it.
|
|
65
|
-
|
|
66
|
-
## `update` is edit-safe
|
|
67
|
-
|
|
68
|
-
`update` compares each managed file against the hash recorded in `.opencode/harness-managed.json`. Files you changed by hand are left alone and reported as preserved. Generated skills (`pc-guardrails-project`, `pc-merge-risk-assess`) are never overwritten once populated. So `update` is safe to run repeatedly, and a second consecutive run should report no changes.
|
|
69
|
-
|
|
70
|
-
## Diagnosing failures
|
|
71
|
-
|
|
72
|
-
**"This project was set up by opencode-onboard v1".** The repo has v1 state files or `ob-*` skills. v2 renamed both and does not migrate. Re-onboard on a clean branch; do not try to rename the files by hand, because the marker comments inside the installed skills changed too.
|
|
73
|
-
|
|
74
|
-
**"No config found. Run the wizard first."** `update` or a step needs `.opencode/harness.json` and it is absent. Run the wizard.
|
|
75
|
-
|
|
76
|
-
**A platform step reports nothing and changes nothing.** Platform content is injected into `<!-- PC-PLATFORM-*-START/END -->` marker pairs. If a marker pair is missing from the target file, injection is skipped silently. Check the markers exist before concluding the step worked.
|
|
77
|
-
|
|
78
|
-
**Skills missing after install.** Skill installation ends with `npx skills experimental_install --yes`, run once at the end of the optimization step. If it failed, rerun it directly in the repo.
|
|
79
|
-
|
|
80
|
-
**Platform CLI warnings.** The harness expects `gh` (GitHub), `az` + azure-devops extension (Azure DevOps), `acli` (Jira), `glab` (GitLab), each authenticated. These are warnings, not fatal; the harness installs, but the matching `/ops-*` flows will not work until the CLI is present.
|
|
81
|
-
|
|
82
|
-
## Rules
|
|
83
|
-
|
|
84
|
-
- Never edit `.opencode/harness.json` by hand to change models. Use `/make-user-model <tier> <model>` inside OpenCode, or the `models` step.
|
|
85
|
-
- Never commit `harness.user.json` or `harness-run.json`. Both belong in `.opencode/.gitignore`, which `join` verifies.
|
|
86
|
-
- `clean` deletes files. Confirm with the user before running it on a repo that already has AI configuration worth keeping.
|
|
1
|
+
---
|
|
2
|
+
name: agent-harness-cli
|
|
3
|
+
description: Drive the agent-harness CLI - install the Plain Concepts Platform Harness into a repository, bring an existing one up to date, set up a teammate's machine, or rerun a single step. Load when asked to install, update, or repair the Platform Harness, when a repo needs AI/agent scaffolding set up, or when a command like `npx @plainconceptsplatform/agent-harness` fails and needs diagnosing.
|
|
4
|
+
license: MIT
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# agent-harness CLI
|
|
8
|
+
|
|
9
|
+
`agent-harness` installs the **Plain Concepts Platform Harness** into a repository and keeps it up to date. The harness is Plain Concepts' own, and it is the set of files agents work from: slash commands, `pc-*` skills (the `pc-` is Plain Concepts), an agent team, OpenCode plugins, an OpenSpec workspace, and generated `ARCHITECTURE.md` and `DESIGN.md`.
|
|
10
|
+
|
|
11
|
+
Everything runs against the **current working directory**. `cd` into the target repository first; there is no `--path` flag.
|
|
12
|
+
|
|
13
|
+
## Pick the right verb
|
|
14
|
+
|
|
15
|
+
Read the repo before running anything. `.opencode/harness.json` is the marker for "harness already installed".
|
|
16
|
+
|
|
17
|
+
| Situation | Command |
|
|
18
|
+
| --- | --- |
|
|
19
|
+
| No `.opencode/harness.json` | `npx @plainconceptsplatform/agent-harness@latest` (the install wizard) |
|
|
20
|
+
| Harness present, want the latest release's files | `npx @plainconceptsplatform/agent-harness@latest update` |
|
|
21
|
+
| Harness present, new machine or new teammate | `npx @plainconceptsplatform/agent-harness join` |
|
|
22
|
+
| One specific thing needs redoing | a single step command, see below |
|
|
23
|
+
|
|
24
|
+
Requires Node.js 18+.
|
|
25
|
+
|
|
26
|
+
## The install wizard is interactive
|
|
27
|
+
|
|
28
|
+
The wizard asks about source scope, backlog and repository platform, three models, and optional token-optimization tools. **Do not run it in a non-interactive shell.** It will hang or abort. If you cannot present prompts to a human, say so and hand the command to the user rather than trying to drive it.
|
|
29
|
+
|
|
30
|
+
Everything else (`update`, and the single-step commands other than `platform`, `models`, `optimization`) runs without prompts.
|
|
31
|
+
|
|
32
|
+
## Single-step commands
|
|
33
|
+
|
|
34
|
+
Run one step without the full wizard. Each reuses context from `.opencode/harness.json` when it needs to.
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
clean Remove pre-existing AI files (AGENTS.md, .cursorrules, CLAUDE.md, ...)
|
|
38
|
+
platform Choose backlog + repository platform
|
|
39
|
+
copy Copy agents, skills, commands, docs into the repo
|
|
40
|
+
openspec Initialize the OpenSpec workspace
|
|
41
|
+
models Choose plan / build / fast models
|
|
42
|
+
optimization Configure RTK, quota, Simple English, codegraph, agentmemory, humanizer
|
|
43
|
+
browser Install agent-browser (npm package + its Chrome for Testing)
|
|
44
|
+
metadata Rewrite .opencode/harness.json
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
`metadata` last if you ran several, because it refreshes the config the others read.
|
|
48
|
+
|
|
49
|
+
## What lands in the repo
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
.opencode/
|
|
53
|
+
harness.json harness config: platform, models, agents.maxConcurrent
|
|
54
|
+
harness-managed.json hash per managed file, so update spares your edits
|
|
55
|
+
harness.user.json per-developer model override (gitignored)
|
|
56
|
+
harness-run.json live subagent wave state (gitignored)
|
|
57
|
+
commands/ slash commands
|
|
58
|
+
plugins/ pc-subagent-monitor, pc-subagent-tiers, pc-system-reminders
|
|
59
|
+
agents/ fullstack-engineer + user-created *-engineer files
|
|
60
|
+
.agents/skills/ pc-* skills
|
|
61
|
+
AGENTS.md ARCHITECTURE.md DESIGN.md
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
After a fresh install, the next move is `/repo-initialize` inside OpenCode. That is what generates real `ARCHITECTURE.md` and `DESIGN.md` and activates the agent team. Installing the harness alone does not do it.
|
|
65
|
+
|
|
66
|
+
## `update` is edit-safe
|
|
67
|
+
|
|
68
|
+
`update` compares each managed file against the hash recorded in `.opencode/harness-managed.json`. Files you changed by hand are left alone and reported as preserved. Generated skills (`pc-guardrails-project`, `pc-merge-risk-assess`) are never overwritten once populated. So `update` is safe to run repeatedly, and a second consecutive run should report no changes.
|
|
69
|
+
|
|
70
|
+
## Diagnosing failures
|
|
71
|
+
|
|
72
|
+
**"This project was set up by opencode-onboard v1".** The repo has v1 state files or `ob-*` skills. v2 renamed both and does not migrate. Re-onboard on a clean branch; do not try to rename the files by hand, because the marker comments inside the installed skills changed too.
|
|
73
|
+
|
|
74
|
+
**"No config found. Run the wizard first."** `update` or a step needs `.opencode/harness.json` and it is absent. Run the wizard.
|
|
75
|
+
|
|
76
|
+
**A platform step reports nothing and changes nothing.** Platform content is injected into `<!-- PC-PLATFORM-*-START/END -->` marker pairs. If a marker pair is missing from the target file, injection is skipped silently. Check the markers exist before concluding the step worked.
|
|
77
|
+
|
|
78
|
+
**Skills missing after install.** Skill installation ends with `npx skills experimental_install --yes`, run once at the end of the optimization step. If it failed, rerun it directly in the repo.
|
|
79
|
+
|
|
80
|
+
**Platform CLI warnings.** The harness expects `gh` (GitHub), `az` + azure-devops extension (Azure DevOps), `acli` (Jira), `glab` (GitLab), each authenticated. These are warnings, not fatal; the harness installs, but the matching `/ops-*` flows will not work until the CLI is present.
|
|
81
|
+
|
|
82
|
+
## Rules
|
|
83
|
+
|
|
84
|
+
- Never edit `.opencode/harness.json` by hand to change models. Use `/make-user-model <tier> <model>` inside OpenCode, or the `models` step.
|
|
85
|
+
- Never commit `harness.user.json` or `harness-run.json`. Both belong in `.opencode/.gitignore`, which `join` verifies.
|
|
86
|
+
- `clean` deletes files. Confirm with the user before running it on a repo that already has AI configuration worth keeping.
|
|
@@ -1,53 +1,53 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: pc-guardrails-generic
|
|
3
|
-
description: Generic guardrails, foundational rules that all agents follow. Users add specialized guardrails skills for specific concerns. Covers secrets, code quality, security, tool usage, and engineer workflow.
|
|
4
|
-
license: MIT
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Transitive loads (optimization skills)
|
|
8
|
-
|
|
9
|
-
The marker sections below name the optimization skills this project selected. Load each before doing any work.
|
|
10
|
-
|
|
11
|
-
## Secrets
|
|
12
|
-
|
|
13
|
-
- Treat `.env` files as write-only: write to them when configuring, read credentials at runtime from the environment or secret store.
|
|
14
|
-
- Never put a credential, API key, or token in a log line, output, or commit in anything but encrypted or template form.
|
|
15
|
-
|
|
16
|
-
## Code
|
|
17
|
-
|
|
18
|
-
- Zero comments by default. Write one only for what the code cannot show and we do not control: a vendor bug, an external contract, a legal rule. Leave every file you touch with no comment slop, old or new.
|
|
19
|
-
- Never add a file that collects unrelated things — `constants.js`, `types.ts`, `utils.ts`. One responsibility per file, split by domain. A file importing from many unrelated modules is already the symptom.
|
|
20
|
-
|
|
21
|
-
## Temporary files
|
|
22
|
-
|
|
23
|
-
- Never write outside `$REPO_ROOT` or an OS temp directory: the next agent cannot see it and nobody cleans it up. Scratch goes under `$REPO_ROOT/.opencode/.tmp/` (enforced by pc-system-reminders).
|
|
24
|
-
- Never report a `.tmp/` path as a deliverable. Copy or move the artifact to its repository path first. Never leave scratch files behind unless they are evidence for a failure you are reporting.
|
|
25
|
-
|
|
26
|
-
## Tests
|
|
27
|
-
|
|
28
|
-
- Never write more tests than the change requires. A bug fix gets one regression test. A new function gets tests for its public contract, not every internal branch. Never aim for a coverage number.
|
|
29
|
-
- Never test framework or library internals. Test your code's contract, not that EF Core saves a tracked entity.
|
|
30
|
-
- Never generate integration, e2e, or snapshot tests unless explicitly asked. Mock nothing you do not own — use a fake that records state. Never add a test that duplicates a type-check or linter rule.
|
|
31
|
-
- `node .opencode/scripts/check-diff.mjs` enforces the comment and test rules on the diff and must exit 0.
|
|
32
|
-
|
|
33
|
-
<!-- PC-GUARDRAILS-RTK-START -->
|
|
34
|
-
<!-- PC-GUARDRAILS-RTK-END -->
|
|
35
|
-
|
|
36
|
-
<!-- PC-GUARDRAILS-CODEGRAPH-START -->
|
|
37
|
-
<!-- PC-GUARDRAILS-CODEGRAPH-END -->
|
|
38
|
-
|
|
39
|
-
<!-- PC-GUARDRAILS-MEMORY-START -->
|
|
40
|
-
<!-- PC-GUARDRAILS-MEMORY-END -->
|
|
41
|
-
|
|
42
|
-
<!-- PC-GUARDRAILS-SIMPLE-ENGLISH-START -->
|
|
43
|
-
<!-- PC-GUARDRAILS-SIMPLE-ENGLISH-END -->
|
|
44
|
-
|
|
45
|
-
<!-- PC-GUARDRAILS-HUMANIZER-START -->
|
|
46
|
-
<!-- PC-GUARDRAILS-HUMANIZER-END -->
|
|
47
|
-
|
|
48
|
-
## Engineer workflow (when spawned)
|
|
49
|
-
|
|
50
|
-
The lead puts your task IDs and their text in your prompt. Two things about that are not up to you:
|
|
51
|
-
|
|
52
|
-
- Load every skill under your `## Abilities` before you start, guardrails first, one `skill` call per `@skill-name`. Editing, shell and spawning are blocked until you have (pc-system-reminders).
|
|
53
|
-
- Edit only files in your assigned scope, then return: task IDs done, files changed, tests and lint result, decisions made. Then exit. Never poll for more work or claim a task the lead did not give you.
|
|
1
|
+
---
|
|
2
|
+
name: pc-guardrails-generic
|
|
3
|
+
description: Generic guardrails, foundational rules that all agents follow. Users add specialized guardrails skills for specific concerns. Covers secrets, code quality, security, tool usage, and engineer workflow.
|
|
4
|
+
license: MIT
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Transitive loads (optimization skills)
|
|
8
|
+
|
|
9
|
+
The marker sections below name the optimization skills this project selected. Load each before doing any work.
|
|
10
|
+
|
|
11
|
+
## Secrets
|
|
12
|
+
|
|
13
|
+
- Treat `.env` files as write-only: write to them when configuring, read credentials at runtime from the environment or secret store.
|
|
14
|
+
- Never put a credential, API key, or token in a log line, output, or commit in anything but encrypted or template form.
|
|
15
|
+
|
|
16
|
+
## Code
|
|
17
|
+
|
|
18
|
+
- Zero comments by default. Write one only for what the code cannot show and we do not control: a vendor bug, an external contract, a legal rule. Leave every file you touch with no comment slop, old or new.
|
|
19
|
+
- Never add a file that collects unrelated things — `constants.js`, `types.ts`, `utils.ts`. One responsibility per file, split by domain. A file importing from many unrelated modules is already the symptom.
|
|
20
|
+
|
|
21
|
+
## Temporary files
|
|
22
|
+
|
|
23
|
+
- Never write outside `$REPO_ROOT` or an OS temp directory: the next agent cannot see it and nobody cleans it up. Scratch goes under `$REPO_ROOT/.opencode/.tmp/` (enforced by pc-system-reminders).
|
|
24
|
+
- Never report a `.tmp/` path as a deliverable. Copy or move the artifact to its repository path first. Never leave scratch files behind unless they are evidence for a failure you are reporting.
|
|
25
|
+
|
|
26
|
+
## Tests
|
|
27
|
+
|
|
28
|
+
- Never write more tests than the change requires. A bug fix gets one regression test. A new function gets tests for its public contract, not every internal branch. Never aim for a coverage number.
|
|
29
|
+
- Never test framework or library internals. Test your code's contract, not that EF Core saves a tracked entity.
|
|
30
|
+
- Never generate integration, e2e, or snapshot tests unless explicitly asked. Mock nothing you do not own — use a fake that records state. Never add a test that duplicates a type-check or linter rule.
|
|
31
|
+
- `node .opencode/scripts/check-diff.mjs` enforces the comment and test rules on the diff and must exit 0.
|
|
32
|
+
|
|
33
|
+
<!-- PC-GUARDRAILS-RTK-START -->
|
|
34
|
+
<!-- PC-GUARDRAILS-RTK-END -->
|
|
35
|
+
|
|
36
|
+
<!-- PC-GUARDRAILS-CODEGRAPH-START -->
|
|
37
|
+
<!-- PC-GUARDRAILS-CODEGRAPH-END -->
|
|
38
|
+
|
|
39
|
+
<!-- PC-GUARDRAILS-MEMORY-START -->
|
|
40
|
+
<!-- PC-GUARDRAILS-MEMORY-END -->
|
|
41
|
+
|
|
42
|
+
<!-- PC-GUARDRAILS-SIMPLE-ENGLISH-START -->
|
|
43
|
+
<!-- PC-GUARDRAILS-SIMPLE-ENGLISH-END -->
|
|
44
|
+
|
|
45
|
+
<!-- PC-GUARDRAILS-HUMANIZER-START -->
|
|
46
|
+
<!-- PC-GUARDRAILS-HUMANIZER-END -->
|
|
47
|
+
|
|
48
|
+
## Engineer workflow (when spawned)
|
|
49
|
+
|
|
50
|
+
The lead puts your task IDs and their text in your prompt. Two things about that are not up to you:
|
|
51
|
+
|
|
52
|
+
- Load every skill under your `## Abilities` before you start, guardrails first, one `skill` call per `@skill-name`. Editing, shell and spawning are blocked until you have (pc-system-reminders).
|
|
53
|
+
- Edit only files in your assigned scope, then return: task IDs done, files changed, tests and lint result, decisions made. Then exit. Never poll for more work or claim a task the lead did not give you.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: pc-guardrails-project
|
|
3
|
-
description: Project-specific guardrails extracted from ARCHITECTURE.md and project config files. Populated by /make-guardrails. Load this skill before implementing any change to understand boundaries, conventions, and constraints for this codebase.
|
|
4
|
-
license: MIT
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
<!-- This skill is a placeholder until /make-guardrails is run. -->
|
|
8
|
-
<!-- /make-guardrails will populate this file with project-specific rules. -->
|
|
1
|
+
---
|
|
2
|
+
name: pc-guardrails-project
|
|
3
|
+
description: Project-specific guardrails extracted from ARCHITECTURE.md and project config files. Populated by /make-guardrails. Load this skill before implementing any change to understand boundaries, conventions, and constraints for this codebase.
|
|
4
|
+
license: MIT
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<!-- This skill is a placeholder until /make-guardrails is run. -->
|
|
8
|
+
<!-- /make-guardrails will populate this file with project-specific rules. -->
|
|
@@ -1,64 +1,64 @@
|
|
|
1
|
-
# ARCHITECTURE.md structure template
|
|
2
|
-
|
|
3
|
-
Write (or update) `ARCHITECTURE.md` following this structure. Only include sections relevant to the project; omit sections with no evidence.
|
|
4
|
-
|
|
5
|
-
- Architecture Overview: what the system is, what problem it solves, major architectural style
|
|
6
|
-
- 1. Project Structure: annotated directory tree with purpose of each major directory
|
|
7
|
-
- 2. High-Level System Diagram: Mermaid diagram of actors, services, data stores, external systems
|
|
8
|
-
- 3. Core Components: each major component: name, responsibility, key files, technologies, inputs/outputs
|
|
9
|
-
- 3.1 Frontend / User Interface (if present)
|
|
10
|
-
- 3.2 Backend / Server / API (if present)
|
|
11
|
-
- 3.3 Shared Libraries / Common Code (if present)
|
|
12
|
-
- 3.4 CLI / Scripts / Automation (if present)
|
|
13
|
-
- 4. Data Flow: request lifecycle, key user journeys, sequence diagram for main runtime flow
|
|
14
|
-
- 5. Data Stores: all persistent storage: type, purpose, schemas, migration approach
|
|
15
|
-
- 6. External Integrations / APIs: each integration: method, config location, auth, failure behavior
|
|
16
|
-
- 7. Key Technologies: full stack summary with architectural relevance of each
|
|
17
|
-
- 8. Deployment & Infrastructure: build artifacts, env config, containerization, CI/CD, hosting
|
|
18
|
-
- 9. Security Architecture: auth, authz, secrets, input validation, trust boundaries
|
|
19
|
-
- 10. Monitoring & Observability: logging, metrics, tracing, error reporting
|
|
20
|
-
- 11. Performance & Scalability: caching, batching, concurrency, known bottlenecks
|
|
21
|
-
- 12. Development Workflow: local setup, install/dev/test/build/lint commands
|
|
22
|
-
- 13. Testing Strategy: test frameworks, locations, coverage gates, gaps
|
|
23
|
-
- 14. Architectural Decisions & Rationale: key choices with evidence and tradeoffs
|
|
24
|
-
- 15. Constraints, Risks, and Technical Debt: tight coupling, TODOs, operational risks
|
|
25
|
-
- 16. Future Considerations: documented roadmap + reasonable recommendations (labeled as such)
|
|
26
|
-
- 17. Project Identification: name, language, type, runtime, date of review, maintainer
|
|
27
|
-
- 18. Glossary / Acronyms: project-specific terms an agent or new developer needs to know
|
|
28
|
-
|
|
29
|
-
Append at the very end of the file:
|
|
30
|
-
```
|
|
31
|
-
<!-- Last updated: <current ISO timestamp> -->
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
Rules:
|
|
35
|
-
- Be specific and concrete: include actual directories, files, modules, commands.
|
|
36
|
-
- Mark anything undiscoverable as "Not evident from the repository".
|
|
37
|
-
- Use Mermaid diagrams where helpful.
|
|
38
|
-
- Write as if this document will be committed and maintained over time.
|
|
39
|
-
|
|
40
|
-
## Writing rules
|
|
41
|
-
|
|
42
|
-
These rules govern the voice and shape of every section. The ARCHITECTURE.md is the primary artifact an agent reads to understand the system's invariants — it must teach constraints, not just inventory structure. These are enforced by re-reading each section after generation (see the self-check in the skill).
|
|
43
|
-
|
|
44
|
-
1. **Every section must answer "what breaks if this is violated," not just "what exists."** A section that only describes structure without stating the constraint it protects and the consequence of crossing it is reference material, not architecture. "The system has four modules" is structure; "Modules must not cross-reference each other in Domain or Application, and flow goes through port interfaces or domain events" is a constraint.
|
|
45
|
-
|
|
46
|
-
2. **Architectural decisions must carry their rationale and what they superseded.** A decision table row that says "Adopt X" is a fact; "Adopt X because Y, supersedes decision Z which assumed W" is a constraint that teaches an agent why a change would be wrong. If a decision was reached after rejecting an alternative, name the alternative and why it was rejected.
|
|
47
|
-
|
|
48
|
-
3. **State boundaries as prohibitions with consequences.** "Layering is enforced: Api → Application → Domain" is a constraint. "Api → Application → Domain" alone is a dependency list. "Only the Composition namespace in Api reaches Infrastructure" is a constraint; "Api depends on Infrastructure" is a fact. Prefer the constraint form: name the boundary, state who must not cross it, and what breaks when it is crossed.
|
|
49
|
-
|
|
50
|
-
4. **Include what was tried and rejected, not just what was chosen.** The most valuable architecture decisions are the ones where an alternative was tested and found wanting. A section that says "dynamic sessions were rejected because they accept no volumes, cost more at scale, and are blocked by policy" teaches an agent more than "the engine runs as a container app."
|
|
51
|
-
|
|
52
|
-
5. **Narrative over inventory.** Describe how the system behaves, what holds it together, and where the seams are. A reader who understands the constraints can infer the structure; a reader who only sees the structure cannot infer the constraints.
|
|
53
|
-
|
|
54
|
-
## Self-check (before writing the file)
|
|
55
|
-
|
|
56
|
-
Re-read every section you are about to write. Then:
|
|
57
|
-
|
|
58
|
-
1. **Identify inventory-only sections.** If a section describes what exists without stating what breaks when its constraints are violated, rewrite it as constraint-embedded prose or cut it.
|
|
59
|
-
|
|
60
|
-
2. **Check decision rows.** Every row in the decisions table must carry its rationale. If a decision has no "why," it is a fact, not a decision — cut it or find the rationale.
|
|
61
|
-
|
|
62
|
-
3. **Scan for bare dependency lists.** "Api depends on Application depends on Domain" is a fact. Rewrite it as: name the boundary, state who must not cross it, and what breaks when it is crossed.
|
|
63
|
-
|
|
64
|
-
4. **Verify rejected alternatives are present where they matter.** If a significant architectural choice was made, the rejected alternative and the reason for rejection should be in the document. An agent that does not know what was rejected will propose it again.
|
|
1
|
+
# ARCHITECTURE.md structure template
|
|
2
|
+
|
|
3
|
+
Write (or update) `ARCHITECTURE.md` following this structure. Only include sections relevant to the project; omit sections with no evidence.
|
|
4
|
+
|
|
5
|
+
- Architecture Overview: what the system is, what problem it solves, major architectural style
|
|
6
|
+
- 1. Project Structure: annotated directory tree with purpose of each major directory
|
|
7
|
+
- 2. High-Level System Diagram: Mermaid diagram of actors, services, data stores, external systems
|
|
8
|
+
- 3. Core Components: each major component: name, responsibility, key files, technologies, inputs/outputs
|
|
9
|
+
- 3.1 Frontend / User Interface (if present)
|
|
10
|
+
- 3.2 Backend / Server / API (if present)
|
|
11
|
+
- 3.3 Shared Libraries / Common Code (if present)
|
|
12
|
+
- 3.4 CLI / Scripts / Automation (if present)
|
|
13
|
+
- 4. Data Flow: request lifecycle, key user journeys, sequence diagram for main runtime flow
|
|
14
|
+
- 5. Data Stores: all persistent storage: type, purpose, schemas, migration approach
|
|
15
|
+
- 6. External Integrations / APIs: each integration: method, config location, auth, failure behavior
|
|
16
|
+
- 7. Key Technologies: full stack summary with architectural relevance of each
|
|
17
|
+
- 8. Deployment & Infrastructure: build artifacts, env config, containerization, CI/CD, hosting
|
|
18
|
+
- 9. Security Architecture: auth, authz, secrets, input validation, trust boundaries
|
|
19
|
+
- 10. Monitoring & Observability: logging, metrics, tracing, error reporting
|
|
20
|
+
- 11. Performance & Scalability: caching, batching, concurrency, known bottlenecks
|
|
21
|
+
- 12. Development Workflow: local setup, install/dev/test/build/lint commands
|
|
22
|
+
- 13. Testing Strategy: test frameworks, locations, coverage gates, gaps
|
|
23
|
+
- 14. Architectural Decisions & Rationale: key choices with evidence and tradeoffs
|
|
24
|
+
- 15. Constraints, Risks, and Technical Debt: tight coupling, TODOs, operational risks
|
|
25
|
+
- 16. Future Considerations: documented roadmap + reasonable recommendations (labeled as such)
|
|
26
|
+
- 17. Project Identification: name, language, type, runtime, date of review, maintainer
|
|
27
|
+
- 18. Glossary / Acronyms: project-specific terms an agent or new developer needs to know
|
|
28
|
+
|
|
29
|
+
Append at the very end of the file:
|
|
30
|
+
```
|
|
31
|
+
<!-- Last updated: <current ISO timestamp> -->
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Rules:
|
|
35
|
+
- Be specific and concrete: include actual directories, files, modules, commands.
|
|
36
|
+
- Mark anything undiscoverable as "Not evident from the repository".
|
|
37
|
+
- Use Mermaid diagrams where helpful.
|
|
38
|
+
- Write as if this document will be committed and maintained over time.
|
|
39
|
+
|
|
40
|
+
## Writing rules
|
|
41
|
+
|
|
42
|
+
These rules govern the voice and shape of every section. The ARCHITECTURE.md is the primary artifact an agent reads to understand the system's invariants — it must teach constraints, not just inventory structure. These are enforced by re-reading each section after generation (see the self-check in the skill).
|
|
43
|
+
|
|
44
|
+
1. **Every section must answer "what breaks if this is violated," not just "what exists."** A section that only describes structure without stating the constraint it protects and the consequence of crossing it is reference material, not architecture. "The system has four modules" is structure; "Modules must not cross-reference each other in Domain or Application, and flow goes through port interfaces or domain events" is a constraint.
|
|
45
|
+
|
|
46
|
+
2. **Architectural decisions must carry their rationale and what they superseded.** A decision table row that says "Adopt X" is a fact; "Adopt X because Y, supersedes decision Z which assumed W" is a constraint that teaches an agent why a change would be wrong. If a decision was reached after rejecting an alternative, name the alternative and why it was rejected.
|
|
47
|
+
|
|
48
|
+
3. **State boundaries as prohibitions with consequences.** "Layering is enforced: Api → Application → Domain" is a constraint. "Api → Application → Domain" alone is a dependency list. "Only the Composition namespace in Api reaches Infrastructure" is a constraint; "Api depends on Infrastructure" is a fact. Prefer the constraint form: name the boundary, state who must not cross it, and what breaks when it is crossed.
|
|
49
|
+
|
|
50
|
+
4. **Include what was tried and rejected, not just what was chosen.** The most valuable architecture decisions are the ones where an alternative was tested and found wanting. A section that says "dynamic sessions were rejected because they accept no volumes, cost more at scale, and are blocked by policy" teaches an agent more than "the engine runs as a container app."
|
|
51
|
+
|
|
52
|
+
5. **Narrative over inventory.** Describe how the system behaves, what holds it together, and where the seams are. A reader who understands the constraints can infer the structure; a reader who only sees the structure cannot infer the constraints.
|
|
53
|
+
|
|
54
|
+
## Self-check (before writing the file)
|
|
55
|
+
|
|
56
|
+
Re-read every section you are about to write. Then:
|
|
57
|
+
|
|
58
|
+
1. **Identify inventory-only sections.** If a section describes what exists without stating what breaks when its constraints are violated, rewrite it as constraint-embedded prose or cut it.
|
|
59
|
+
|
|
60
|
+
2. **Check decision rows.** Every row in the decisions table must carry its rationale. If a decision has no "why," it is a fact, not a decision — cut it or find the rationale.
|
|
61
|
+
|
|
62
|
+
3. **Scan for bare dependency lists.** "Api depends on Application depends on Domain" is a fact. Rewrite it as: name the boundary, state who must not cross it, and what breaks when it is crossed.
|
|
63
|
+
|
|
64
|
+
4. **Verify rejected alternatives are present where they matter.** If a significant architectural choice was made, the rejected alternative and the reason for rejection should be in the document. An agent that does not know what was rejected will propose it again.
|