@zalom/plastic 1.0.0-beta.9 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/PLASTIC-reference.md +133 -0
  2. package/PLASTIC.md +398 -82
  3. package/README.md +99 -82
  4. package/agents/plastic-brainstorming.md +12 -9
  5. package/agents/plastic-enforcer.md +52 -12
  6. package/agents/plastic-executor.md +10 -10
  7. package/agents/plastic-future-intent-researcher.md +4 -8
  8. package/agents/plastic-intent-curator.md +12 -14
  9. package/agents/plastic-intent-discovery.md +35 -0
  10. package/agents/plastic-planner.md +15 -10
  11. package/agents/plastic-spec-specialist.md +15 -10
  12. package/bin/plastic.js +7 -3
  13. package/hooks/code-gate +10 -1
  14. package/hooks/hooks.json +28 -3
  15. package/hooks/lock-gate +21 -0
  16. package/hooks/retrieval-gate +10 -0
  17. package/hooks/savepoint-pre +10 -0
  18. package/hooks/statusline +48 -6
  19. package/package.json +2 -1
  20. package/scripts/agent-report +21 -0
  21. package/scripts/dashboard.rb +98 -23
  22. package/scripts/doctor.rb +232 -5
  23. package/scripts/hook-auto-arm +1 -1
  24. package/scripts/hook-bash-gate +22 -4
  25. package/scripts/hook-code-gate +11 -6
  26. package/scripts/hook-continue +17 -0
  27. package/scripts/hook-create-gate +45 -9
  28. package/scripts/hook-gate-check +24 -23
  29. package/scripts/hook-lock-gate +83 -0
  30. package/scripts/hook-retrieval-gate +148 -0
  31. package/scripts/hook-savepoint-pre +32 -0
  32. package/scripts/hook-session-start +1 -1
  33. package/scripts/insight-append +51 -0
  34. package/scripts/install.rb +44 -7
  35. package/scripts/lib/agent_models.rb +43 -0
  36. package/scripts/lib/bridge.rb +924 -84
  37. package/scripts/lib/dashboard_banner.rb +42 -0
  38. package/scripts/lib/hook_registry.rb +95 -0
  39. package/scripts/lib/insights.rb +86 -0
  40. package/scripts/lib/installer_core.rb +100 -60
  41. package/scripts/lib/link_suggestions.rb +319 -0
  42. package/scripts/lib/lock.rb +375 -0
  43. package/scripts/lib/power_tools.rb +22 -21
  44. package/scripts/lib/preflight.rb +79 -0
  45. package/scripts/lib/qmd_sync.rb +15 -0
  46. package/scripts/lib/retrieval_gate.rb +211 -0
  47. package/scripts/lib/worktree.rb +384 -0
  48. package/scripts/link-suggest +213 -0
  49. package/scripts/new-intent +9 -1
  50. package/scripts/plastic-lock +164 -0
  51. package/scripts/read-config +4 -0
  52. package/scripts/spawn-preamble +11 -3
  53. package/scripts/update.rb +16 -7
  54. package/skills/auto/SKILL.md +126 -19
  55. package/skills/auto/references/agent-architecture.md +7 -4
  56. package/skills/auto/references/agent-report-contract.md +36 -1
  57. package/skills/auto/references/end-tail.md +56 -0
  58. package/skills/auto/references/human-report-contract.md +55 -0
  59. package/skills/auto/references/tiers.md +77 -0
  60. package/skills/brainstorming/SKILL.md +7 -34
  61. package/skills/brainstorming/references/design-principles.md +49 -0
  62. package/skills/continuing/SKILL.md +26 -7
  63. package/skills/creating-intent/SKILL.md +13 -28
  64. package/skills/creating-project/SKILL.md +11 -74
  65. package/skills/creating-project/references/project-scaffolding.md +97 -0
  66. package/skills/creating-skills/SKILL.md +65 -0
  67. package/skills/creating-skills/evals/evals.json +108 -0
  68. package/skills/creating-skills/references/agents.md +168 -0
  69. package/skills/creating-skills/references/evals.md +41 -0
  70. package/skills/creating-skills/references/hooks.md +248 -0
  71. package/skills/creating-skills/references/progressive-disclosure.md +176 -0
  72. package/skills/creating-skills/references/scripts.md +166 -0
  73. package/skills/creating-skills/references/skills.md +165 -0
  74. package/skills/creating-skills/scripts/scaffold.rb +313 -0
  75. package/skills/dashboard/SKILL.md +13 -11
  76. package/skills/dashboard/references/classification.md +22 -0
  77. package/skills/doctor/SKILL.md +10 -7
  78. package/skills/executing-plan/SKILL.md +4 -4
  79. package/skills/humanizer/SKILL.md +39 -0
  80. package/skills/humanizer/evals/evals.json +70 -0
  81. package/skills/humanizer/references/always-on-snippet.md +9 -0
  82. package/skills/humanizer/references/examples.md +48 -0
  83. package/skills/install/SKILL.md +75 -84
  84. package/skills/intent-curator/SKILL.md +5 -1
  85. package/skills/intent-discovery/SKILL.md +47 -0
  86. package/skills/intent-starting/SKILL.md +130 -0
  87. package/skills/intent-starting/evals/evals.json +117 -0
  88. package/skills/intent-starting/references/boarding-matrix.md +35 -0
  89. package/skills/linking-intents/SKILL.md +48 -12
  90. package/skills/lock/SKILL.md +41 -0
  91. package/skills/managing-index/SKILL.md +6 -0
  92. package/skills/releasing/SKILL.md +44 -29
  93. package/skills/releasing/references/promotion-and-tagging.md +60 -0
  94. package/skills/roadmap/SKILL.md +51 -0
  95. package/skills/roadmap/references/file-format.md +91 -0
  96. package/skills/roadmap/references/operations.md +78 -0
  97. package/skills/uninstall/SKILL.md +29 -11
  98. package/skills/update/SKILL.md +34 -23
  99. package/skills/versions/SKILL.md +27 -12
  100. package/skills/writing-plans/SKILL.md +10 -88
  101. package/skills/writing-plans/references/plan-format.md +102 -0
  102. package/templates/config.yml +8 -0
  103. package/templates/outcome.md +3 -0
  104. package/templates/revisions.md +58 -0
  105. package/templates/roadmap.md +30 -0
  106. package/skills/writing-instructions/SKILL.md +0 -159
  107. package/skills/writing-instructions/references/agentskills-spec.md +0 -135
@@ -13,58 +13,69 @@ description: Use when updating Plastic. Runs the `update` verb, which reads the
13
13
  ## What it does
14
14
 
15
15
  `update` is a single deterministic command. It reads `~/.plastic/VERSION`, derives the
16
- channel from the version string (`-alpha`/`-beta`/none stable), queries `npm` dist-tags,
16
+ channel from the version string (`-alpha`/`-beta`/none -> stable), queries `npm` dist-tags,
17
17
  and advances to the **next version on the current channel**. "Already up to date" is a
18
- clean no-op. You do not compute the target yourself the script does.
18
+ clean no-op. You do not compute the target yourself, the script does.
19
+
20
+ ## Channel rule
21
+
22
+ If Plastic is installed, derive `<channel>` from `~/.plastic/VERSION`: a version containing
23
+ `-alpha` means `@alpha`, `-beta` means `@beta`, otherwise `@latest`. If not installed
24
+ (first install), default to `@beta`. The user can always override with
25
+ `--alpha` / `--beta` / `--latest`.
19
26
 
20
27
  ## Flags
21
28
 
22
29
  | Flag | Behaviour |
23
30
  |------|-----------|
24
31
  | (none) | Advance to the next version on the **current** channel |
25
- | `--latest` | Switch to / advance the **stable** channel (toward stability frictionless) |
32
+ | `--latest` | Switch to / advance the **stable** channel (toward stability, frictionless) |
26
33
  | `--beta` | Switch to / advance the **beta** channel |
27
- | `--alpha` | Switch to / advance the **alpha** channel (bleeding edge confirmed if moving down in stability) |
34
+ | `--alpha` | Switch to / advance the **alpha** channel (bleeding edge, confirmed if moving down in stability) |
28
35
 
29
36
  Switching toward a more stable channel is frictionless; switching toward bleeding edge is
30
37
  confirmed. To roll **back** to a previously-installed version, use `plastic-versions`.
31
38
 
32
39
  ## Prerequisites
33
40
 
34
- Plastic must be installed (`~/.plastic/VERSION` present). If not, run
35
- `npx @zalom/plastic install --claude` first.
41
+ Plastic must be installed (`~/.plastic/VERSION` present). If not, run `plastic-install`
42
+ first (or `npx -y @zalom/plastic@beta install --claude` directly).
36
43
 
37
44
  ## Procedure
38
45
 
39
46
  ### Step 1: Run the update
40
47
 
41
48
  ```bash
42
- npx @zalom/plastic update # next version on the current channel
43
- # or: npx @zalom/plastic update --beta / --latest / --alpha
49
+ npx -y @zalom/plastic@<channel> update --claude
50
+ # channel switch: append --beta / --latest / --alpha
51
+ # other agents: append --codex / --hermes / --all
44
52
  ```
45
53
 
46
- Append the agent flag(s) if not just Claude (`--codex`, `--hermes`, `--all`).
47
- The command prints the transition (`vX vY`) or "already up to date", and records the
48
- move in the append-only `~/.plastic/versions.json` ledger.
54
+ `bunx -y @zalom/plastic@<channel> update --claude` works as a fallback if `npx` is
55
+ unavailable. The command prints the transition (`vX -> vY`) or "already up to date", runs
56
+ a post-update doctor summary, and records the move in the append-only
57
+ `~/.plastic/versions.json` ledger.
49
58
 
50
- ### Step 2: Announce key changes
59
+ ### Step 2: Relay the result, announce convention changes
51
60
 
52
- After it completes, read `~/.plastic/PLASTIC.md` and announce convention changes that
53
- affect the current session:
61
+ Relay what `update` printed, do not recompute the version transition or the doctor
62
+ summary:
54
63
 
55
64
  ```
56
- Plastic updated to vX.Y.Z (channel).
57
-
58
- Key changes:
59
- - [notable convention changes, if any]
60
-
61
- Recommendation: run /clear for a clean session with all new conventions loaded.
65
+ Plastic update (<channel>)
66
+ Command: npx -y @zalom/plastic@<channel> update --claude <flags>
67
+ Version: <before> -> <after>
68
+ Doctor: <relayed summary, or "all clear">
62
69
  ```
63
70
 
64
- ### Step 3: Health check
71
+ Then read `~/.plastic/PLASTIC.md` and announce convention changes that affect the
72
+ current session, and recommend `/clear` for a clean session with all new conventions
73
+ loaded.
74
+
75
+ ### Step 3: Health check only on a relayed failure
65
76
 
66
- Invoke `plastic-doctor`. If all checks pass: **"Health check: all clear."** Otherwise show
67
- the report and offer to fix.
77
+ If the relayed doctor summary shows a failure, invoke `plastic-doctor` for the full
78
+ report and offer to fix. If it already reads clean, do not re-run doctor.
68
79
 
69
80
  ### Step 4: Commit + clear update cache
70
81
 
@@ -3,7 +3,7 @@ name: plastic-versions
3
3
  description: Use when the user wants to see their Plastic version history or roll back to a previously-installed version after a bad release. Manages the local, append-only versions.json ledger and steps between versions the user has actually run. For moving to a brand-new release, use plastic-update instead.
4
4
  ---
5
5
 
6
- # Plastic Versions local version time-machine
6
+ # Plastic Versions: local version time-machine
7
7
 
8
8
  ## When to Use
9
9
  - "show plastic versions", "version history", "what versions have I run"
@@ -11,11 +11,18 @@ description: Use when the user wants to see their Plastic version history or rol
11
11
  - A new version broke something and the user wants their last known-good build
12
12
 
13
13
  For upgrading to a **new** release, use `plastic-update`. This skill only navigates
14
- versions you have **already installed** the ones recorded in the ledger.
14
+ versions you have **already installed**, the ones recorded in the ledger.
15
+
16
+ ## Channel rule
17
+
18
+ `versions` restores whichever build you pick from the ledger, it does not take a channel
19
+ flag for the target. The pinned `<channel>` below is only the npx invocation itself:
20
+ derive it from `~/.plastic/VERSION` the same way as the other lifecycle skills,
21
+ `-alpha` -> `@alpha`, `-beta` -> `@beta`, otherwise `@latest`.
15
22
 
16
23
  ## The ledger
17
24
 
18
- `~/.plastic/versions.json` is an **append-only JSONL** ledger one line per version
25
+ `~/.plastic/versions.json` is an **append-only JSONL** ledger, one line per version
19
26
  change, never modified or deleted:
20
27
 
21
28
  ```json
@@ -23,15 +30,16 @@ change, never modified or deleted:
23
30
  {"version":"1.0.0-alpha.18","action":"update","at":"..."}
24
31
  ```
25
32
 
26
- `action` `install | reinstall | update | downgrade` (derived from version direction; the
27
- channel is derived from the version string, never stored). It is a troubleshooting record.
33
+ `action` is one of `install`, `reinstall`, `update`, `downgrade` (derived from version
34
+ direction; the channel is derived from the version string, never stored). It is a
35
+ troubleshooting record.
28
36
 
29
37
  ## Procedure
30
38
 
31
39
  ### Show history
32
40
 
33
41
  ```bash
34
- npx @zalom/plastic versions
42
+ npx -y @zalom/plastic@<channel> versions
35
43
  ```
36
44
 
37
45
  Prints the table with the currently-installed version marked. If the most recent action was
@@ -40,8 +48,8 @@ a `downgrade`, it asks whether to keep rolling back.
40
48
  ### Roll back
41
49
 
42
50
  ```bash
43
- npx @zalom/plastic versions --downgrade # one step back
44
- npx @zalom/plastic versions --downgrade --version 1.0.0-alpha.15 # to a specific run
51
+ npx -y @zalom/plastic@<channel> versions --downgrade # one step back
52
+ npx -y @zalom/plastic@<channel> versions --downgrade --version 1.0.0-alpha.15 # to a specific run
45
53
  ```
46
54
 
47
55
  Rollback targets are restricted to versions in the ledger (only builds you have actually
@@ -51,15 +59,22 @@ re-fetched from npm and re-synced; your intent store, config, and the ledger are
51
59
  ### Step forward (after a rollback)
52
60
 
53
61
  ```bash
54
- npx @zalom/plastic versions --upgrade # one step forward in your history
62
+ npx -y @zalom/plastic@<channel> versions --upgrade # one step forward in your history
55
63
  ```
56
64
 
57
65
  ### After any change
58
66
 
59
- Run `plastic-doctor` to confirm health, and suggest `/clear` so the session picks up the
60
- swapped conventions.
67
+ Run `plastic-doctor` to confirm health, then emit the reporting block and suggest
68
+ `/clear` so the session picks up the swapped conventions:
69
+
70
+ ```
71
+ Plastic versions (<channel>)
72
+ Command: npx -y @zalom/plastic@<channel> versions <flags>
73
+ Version: <before> -> <after>
74
+ Doctor: <summary or "all clear">
75
+ ```
61
76
 
62
77
  ## Notes
63
- - The ledger is **never** edited or pruned it is the audit trail.
78
+ - The ledger is **never** edited or pruned, it is the audit trail.
64
79
  - Downgrades cannot un-migrate a store-format change; if a warning appears, surface it to
65
80
  the user rather than forcing the rollback.
@@ -48,70 +48,13 @@ This structure informs the task decomposition. Each task should produce self-con
48
48
  - "Run the tests and make sure they pass" - step
49
49
  - "Commit" - step
50
50
 
51
- ## Plan Document Header
51
+ ## Plan Format
52
52
 
53
- **Every plan MUST start with this header:**
54
-
55
- ```markdown
56
- # [Feature Name] Implementation Plan
57
-
58
- > **For agentic workers:** Use `plastic-executing-plan` to implement this plan task-by-task.
59
-
60
- **Goal:** [One sentence describing what this builds]
61
-
62
- **Architecture:** [2-3 sentences about approach]
63
-
64
- **Tech Stack:** [Key technologies/libraries]
65
-
66
- **Intent:** {id} — {name}
67
-
68
- ---
69
- ```
70
-
71
- ## Task Structure
72
-
73
- ````markdown
74
- ### Task N: [Component Name]
75
-
76
- **Files:**
77
- - Create: `exact/path/to/file.rb`
78
- - Modify: `exact/path/to/existing.rb:123-145`
79
- - Test: `test/exact/path/to/test.rb`
80
-
81
- - [ ] **Step 1: Write the failing test**
82
-
83
- ```ruby
84
- def test_specific_behavior
85
- result = function(input)
86
- assert_equal expected, result
87
- end
88
- ```
89
-
90
- - [ ] **Step 2: Run test to verify it fails**
91
-
92
- Run: `ruby -Itest test/path/test.rb --name test_specific_behavior`
93
- Expected: FAIL with "undefined method"
94
-
95
- - [ ] **Step 3: Write minimal implementation**
96
-
97
- ```ruby
98
- def function(input)
99
- expected
100
- end
101
- ```
102
-
103
- - [ ] **Step 4: Run test to verify it passes**
104
-
105
- Run: `ruby -Itest test/path/test.rb --name test_specific_behavior`
106
- Expected: PASS
107
-
108
- - [ ] **Step 5: Commit**
109
-
110
- ```bash
111
- git add test/path/test.rb lib/path/file.rb
112
- git commit -m "feat: add specific feature"
113
- ```
114
- ````
53
+ For the exact plan/task/checklist/action format (the Plan Document Header
54
+ template, the full Task Structure worked example, and the checklist.md /
55
+ actions/ACTION_N.md templates), read `references/plan-format.md` before
56
+ writing plan.md. Every plan starts with the header template and decomposes
57
+ into tasks matching the Task Structure shape.
115
58
 
116
59
  ## No Placeholders
117
60
 
@@ -144,31 +87,10 @@ If you find issues, fix them inline. No need to re-review — just fix and move
144
87
  ## Plastic Artifacts
145
88
 
146
89
  After writing `plan.md`, create two additional artifacts in the intent directory:
147
-
148
- ### checklist.md
149
-
150
- Execution registry with one checkbox per task. Format:
151
-
152
- ```markdown
153
- # Checklist — Intent {id}: {name}
154
-
155
- - [ ] Task 1: {task title}
156
- - [ ] Task 2: {task title}
157
- - [ ] Task 3: {task title}
158
- ...
159
- ```
160
-
161
- ### actions/ACTION_N.md
162
-
163
- One file per task. Each action is self-contained — a subagent can execute it without reading the plan.
164
-
165
- ```markdown
166
- # Action {N}: {task title}
167
-
168
- {Full task text copied from plan.md — all steps, all code, all commands. Nothing omitted.}
169
- ```
170
-
171
- Create the `actions/` directory inside the intent directory: `{intent_dir}/actions/`
90
+ `checklist.md` (execution registry with one checkbox per task) and
91
+ `actions/ACTION_N.md` (one self-contained file per task, in an `actions/`
92
+ directory inside the intent directory). For the exact format of both, read
93
+ `references/plan-format.md`.
172
94
 
173
95
  ## Git Commit
174
96
 
@@ -0,0 +1,102 @@
1
+ # Plan, Checklist, and Action Format
2
+
3
+ The exact templates for `plan.md`'s header and task structure, and for the
4
+ `checklist.md` and `actions/ACTION_N.md` artifacts. Read this before writing
5
+ plan.md so the shape matches on the first pass.
6
+
7
+ ## Table of Contents
8
+
9
+ - [Plan Document Header](#plan-document-header)
10
+ - [Task Structure (worked example)](#task-structure-worked-example)
11
+ - [checklist.md format](#checklistmd-format)
12
+ - [actions/ACTION_N.md format](#actionsaction_nmd-format)
13
+
14
+ ## Plan Document Header
15
+
16
+ **Every plan MUST start with this header:**
17
+
18
+ ```markdown
19
+ # [Feature Name] Implementation Plan
20
+
21
+ > **For agentic workers:** Use `plastic-executing-plan` to implement this plan task-by-task.
22
+
23
+ **Goal:** [One sentence describing what this builds]
24
+
25
+ **Architecture:** [2-3 sentences about approach]
26
+
27
+ **Tech Stack:** [Key technologies/libraries]
28
+
29
+ **Intent:** {id} — {name}
30
+
31
+ ---
32
+ ```
33
+
34
+ ## Task Structure (worked example)
35
+
36
+ ````markdown
37
+ ### Task N: [Component Name]
38
+
39
+ **Files:**
40
+ - Create: `exact/path/to/file.rb`
41
+ - Modify: `exact/path/to/existing.rb:123-145`
42
+ - Test: `test/exact/path/to/test.rb`
43
+
44
+ - [ ] **Step 1: Write the failing test**
45
+
46
+ ```ruby
47
+ def test_specific_behavior
48
+ result = function(input)
49
+ assert_equal expected, result
50
+ end
51
+ ```
52
+
53
+ - [ ] **Step 2: Run test to verify it fails**
54
+
55
+ Run: `ruby -Itest test/path/test.rb --name test_specific_behavior`
56
+ Expected: FAIL with "undefined method"
57
+
58
+ - [ ] **Step 3: Write minimal implementation**
59
+
60
+ ```ruby
61
+ def function(input)
62
+ expected
63
+ end
64
+ ```
65
+
66
+ - [ ] **Step 4: Run test to verify it passes**
67
+
68
+ Run: `ruby -Itest test/path/test.rb --name test_specific_behavior`
69
+ Expected: PASS
70
+
71
+ - [ ] **Step 5: Commit**
72
+
73
+ ```bash
74
+ git add test/path/test.rb lib/path/file.rb
75
+ git commit -m "feat: add specific feature"
76
+ ```
77
+ ````
78
+
79
+ ## checklist.md format
80
+
81
+ Execution registry with one checkbox per task. Format:
82
+
83
+ ```markdown
84
+ # Checklist — Intent {id}: {name}
85
+
86
+ - [ ] Task 1: {task title}
87
+ - [ ] Task 2: {task title}
88
+ - [ ] Task 3: {task title}
89
+ ...
90
+ ```
91
+
92
+ ## actions/ACTION_N.md format
93
+
94
+ One file per task. Each action is self-contained — a subagent can execute it without reading the plan.
95
+
96
+ ```markdown
97
+ # Action {N}: {task title}
98
+
99
+ {Full task text copied from plan.md — all steps, all code, all commands. Nothing omitted.}
100
+ ```
101
+
102
+ Create the `actions/` directory inside the intent directory: `{intent_dir}/actions/`
@@ -11,3 +11,11 @@ agent:
11
11
  parallel_mode: linear
12
12
  architect:
13
13
  style:
14
+
15
+ # Per-agent model override (intent 116). Uncomment and set to a Claude Code
16
+ # alias (opus, sonnet, haiku) to override the shipped tier for one agent. With
17
+ # no entry, the shipped default applies. Never resolves to Fable.
18
+ # agents:
19
+ # models:
20
+ # plastic-executor: sonnet
21
+ # plastic-enforcer: opus
@@ -1,3 +1,6 @@
1
+ ---
2
+ disposition: delivered|abandoned
3
+ ---
1
4
  # Outcome: <intent name>
2
5
 
3
6
  ## Summary
@@ -0,0 +1,58 @@
1
+ # revisions.md
2
+
3
+ <!--
4
+ FORM reference. A live revisions.md exists in an intent directory ONLY when structural
5
+ maintenance actually happened. It is never scaffolded at intent birth, it carries no
6
+ placeholder sentinel, and its mere presence signals that this intent underwent structural
7
+ (not conceptual) change.
8
+
9
+ Rules:
10
+ - Append-only. Newest entry at the BOTTOM. Never edit or reorder past entries.
11
+ - One entry per relocated item (one section, one file, or one ref per entry).
12
+ - Move-and-record: remove the misplaced thing from its artifact and preserve it IN FULL
13
+ here. Never rewrite, summarize, or reinterpret delivered meaning. A change to delivered
14
+ meaning is a new intent, not a revision.
15
+ - Header form: "## Revision vN - YYYY-MM-DD-HH:MM" (N increments by one per entry).
16
+
17
+ Fields:
18
+ - Why: one sentence naming the broken rule, ending with "[rule: <tag>]".
19
+ - Prior location: the artifact plus the section or path the content came from.
20
+ - Content held: the verbatim removed content, as an indented block (block form), OR
21
+ - Change: a one-line "removed X (before: ... -> after: ...)" for a frontmatter
22
+ edit, used instead of a Content held block.
23
+
24
+ Stray file: embed the file's full content as the Content held block and delete the
25
+ original; Prior location names the filename. revisions.md is the single container.
26
+
27
+ Violation-tag catalog (starter set; free-text tags are allowed):
28
+ - unsanctioned-section : a top-level section the sanctioned-section rule now rejects
29
+ - phantom-section : a section referenced but not present or not sanctioned
30
+ - stray-file : a file that does not belong in the intent directory
31
+ - dangling-ref : a link or reference to something that no longer exists
32
+ - broken-chain : a chain frontmatter edge to an intent that no longer exists
33
+ - broken-source : a sources frontmatter edge to an intent that no longer exists
34
+ - misplaced-content : content that belongs in a different artifact or section
35
+
36
+ The examples below show the three variants. Delete them when you write the first real
37
+ entry; keep the "# revisions.md" title line above.
38
+ -->
39
+
40
+ ## Revision v1 - 2026-06-30-14:35
41
+ - Why: unsanctioned top-level section left over from an early draft [rule: unsanctioned-section]
42
+ - Prior location: intent.md - ## Scope
43
+ - Content held:
44
+
45
+ ## Scope
46
+ <the full content that was removed, verbatim>
47
+
48
+ ## Revision v2 - 2026-06-30-15:02
49
+ - Why: chain edge to an intent that no longer exists [rule: broken-chain]
50
+ - Prior location: intent.md frontmatter - chain
51
+ - Change: removed "99x" (before: ["4a1a", "99x"] -> after: ["4a1a"])
52
+
53
+ ## Revision v3 - 2026-06-30-15:20
54
+ - Why: a stray notes file that does not belong in the intent directory [rule: stray-file]
55
+ - Prior location: notes-old.md
56
+ - Content held:
57
+
58
+ <the full content of notes-old.md, verbatim; the original file is then deleted>
@@ -0,0 +1,30 @@
1
+ # Roadmap: <name>
2
+
3
+ (one-line meta: what this roadmap delivers, and which tier it lives in. `roadmaps/` is a sibling
4
+ of `INDEX.md` — a project's root or the global `~/.plastic/`, never inside `store/`. When this
5
+ roadmap's goal is reached, move this file from `roadmaps/{slug}.md` to
6
+ `roadmaps/archived/{slug}.md`; `roadmaps/` itself lists only live roadmaps.)
7
+
8
+ ## Goal
9
+ (a checkable prose condition — one or a few sentences a human or coordinator reads to decide the
10
+ roadmap is done. Not an executable checker.)
11
+
12
+ ## Waves
13
+ Entries in a wave are parallel-safe; waves run top to bottom. The checkbox is checked once an entry
14
+ is delivered, unchecked otherwise; the trailing token after the em-dash is the precise mirrored
15
+ status (queued | delivering | delivered | abandoned | blocked) from INDEX.md. INDEX always wins on
16
+ any conflict between the checkbox/token here and INDEX's real status.
17
+
18
+ ### Wave 1
19
+ - [ ] <intent-id> <title> — queued
20
+ - [ ] <intent-id> <title> — queued
21
+
22
+ ### Wave 2
23
+ - [x] <intent-id> <title> — delivered
24
+
25
+ ## Log
26
+ (append-only, dated, one line per event. Each line is one plain-language, EM-to-CTO-voice sentence:
27
+ what shipped and its impact for a non-expert reader, no jargon or internal codenames, ending with a
28
+ link to that entry-intent's `outcome.md`. Never restate outcome detail here; link to it instead.
29
+ Newest at the bottom.)
30
+ - 2026-01-01 00:00 UTC Shipped the first wave of this roadmap; see store/<intent-id>--<slug>/outcome.md.
@@ -1,159 +0,0 @@
1
- ---
2
- name: plastic-writing-instructions
3
- description: >
4
- Write or restructure agent instructions, conventions files, and SKILL.md
5
- content using progressive disclosure and the agentskills.io specification.
6
- Use when creating PLASTIC.md, rewriting convention docs, authoring new
7
- skills, restructuring large instruction files to fit context budgets,
8
- or when instructions feel too long, too vague, or agents aren't following
9
- them. Also use when the user says "progressive disclosure", "restructure
10
- instructions", or "the instructions are too big".
11
- ---
12
-
13
- # Writing Agent Instructions
14
-
15
- Based on the [agentskills.io specification](https://agentskills.io).
16
-
17
- ## Progressive Disclosure Architecture
18
-
19
- All agent instructions follow three loading stages. Design for this — it's the
20
- architecture, not a nice-to-have.
21
-
22
- | Stage | What loads | Budget | Design for |
23
- |-------|-----------|--------|------------|
24
- | **Discovery** | name + description | ~100 tokens | Trigger accuracy |
25
- | **Activation** | Full instruction body | <5000 tokens / <500 lines | Core procedures |
26
- | **Execution** | references/, scripts/, assets/ | As needed | Deep detail |
27
-
28
- **The description carries the entire burden of triggering.** If agents aren't
29
- activating your skill, the description is the problem.
30
-
31
- ## Procedure
32
-
33
- ### Step 1: Audit the content
34
-
35
- Before writing or restructuring, classify every piece of content:
36
-
37
- | Classification | Where it goes | Example |
38
- |---------------|---------------|---------|
39
- | **Trigger context** | description field | "Use when...", keywords |
40
- | **Core procedure** | SKILL.md body | Step-by-step workflows |
41
- | **Gotchas** | SKILL.md body (early) | Facts that defy assumptions |
42
- | **Deep reference** | references/ | API details, full schemas |
43
- | **Templates** | assets/ or inline | Output format examples |
44
- | **Executable logic** | scripts/ | Validation, data processing |
45
-
46
- Ask for each piece: "Would the agent get this wrong without this?"
47
- If no — cut it. If unsure — test it.
48
-
49
- ### Step 2: Write the description
50
-
51
- The description must convey WHEN to use, not just WHAT it does.
52
-
53
- **Rules:**
54
- - Imperative phrasing: "Use this skill when..." not "This skill does..."
55
- - Focus on user intent, not implementation
56
- - Err on the side of being pushy — list contexts explicitly
57
- - Include cases where user doesn't name the domain directly
58
- - Under 1024 characters (hard limit)
59
- - Include specific trigger keywords
60
-
61
- **Template:**
62
- ```yaml
63
- description: >
64
- [One sentence: what it does]. Use when [primary trigger context],
65
- [secondary trigger], or when [indirect trigger where user doesn't
66
- name the domain]. Also use when [edge case trigger].
67
- ```
68
-
69
- ### Step 3: Write the body
70
-
71
- **Principles (in priority order):**
72
-
73
- 1. **Procedures over declarations** — Teach HOW to approach a class of problems,
74
- not WHAT to produce for a specific instance
75
- 2. **Defaults, not menus** — Pick one approach, mention alternatives briefly.
76
- "Use X. For Y cases, use Z instead." Never present options as equals.
77
- 3. **Calibrate control to fragility** — Prescriptive for fragile/sequential tasks,
78
- flexible when multiple approaches are valid. Most skills have a mix.
79
- 4. **Reasoning over rigid directives** — "Do X because Y tends to cause Z" beats
80
- "ALWAYS do X, NEVER do Y"
81
- 5. **Add what the agent lacks, omit what it knows** — No explaining HTTP, PDFs,
82
- or what a migration is. Jump to what's non-obvious.
83
-
84
- **Structure:**
85
- ```markdown
86
- # Title
87
-
88
- [1-2 sentence purpose statement]
89
-
90
- ## Gotchas
91
- - [Highest-value content first — facts that defy assumptions]
92
- - [Each gotcha is a concrete correction, not general advice]
93
-
94
- ## Procedure
95
- ### Step 1: ...
96
- ### Step 2: ...
97
-
98
- ## Patterns
99
- [Only if the skill covers multiple approaches to similar problems]
100
- ```
101
-
102
- ### Step 4: Extract to references/
103
-
104
- Anything over 500 lines or 5000 tokens goes to `references/`. But tell the
105
- agent WHEN to load each file — conditional references, not a generic "see
106
- references/ for details."
107
-
108
- **Good:** "Read `references/api-errors.md` if the API returns a non-200 status"
109
- **Bad:** "See references/ for more information"
110
-
111
- ### Step 5: Validate
112
-
113
- Run through this checklist:
114
-
115
- - [ ] Description under 1024 chars
116
- - [ ] Body under 500 lines / 5000 tokens
117
- - [ ] Every instruction passes "would the agent get this wrong without it?"
118
- - [ ] Gotchas are concrete corrections, not general advice
119
- - [ ] Defaults chosen, not menus presented
120
- - [ ] Control calibrated: prescriptive where fragile, flexible where tolerant
121
- - [ ] References have conditional load triggers
122
- - [ ] No explaining what the agent already knows
123
-
124
- For structured evaluation beyond this checklist (paired evals, pass rate
125
- tracking, regression testing), use `plastic-evaluating-skills`.
126
-
127
- ## Gotchas
128
-
129
- - Hook `additionalContext` truncates at **10,000 characters**. If instructions
130
- must load via hooks (not skills), they must fit this budget.
131
- - `~/.claude/rules/*.md` files load fully with no truncation — use for
132
- always-loaded conventions that don't fit in a skill.
133
- - CLAUDE.md supports `@path/to/file` imports (max depth 4) — another way
134
- to load large instruction sets without truncation.
135
- - Agents only consult skills for tasks beyond what they can handle alone.
136
- Simple one-step requests may not trigger even with a perfect description.
137
- - Content from real domain expertise (runbooks, incident reports, code review)
138
- dramatically outperforms LLM-generated instructions without project context.
139
- - The most common cause of agents not following instructions: the instruction
140
- was too vague, didn't apply to the current task, or presented too many
141
- options without a clear default. Read execution traces to diagnose.
142
-
143
- ## For Convention Files (PLASTIC.md, CLAUDE.md)
144
-
145
- Convention files aren't skills — they load differently. Apply progressive
146
- disclosure by splitting:
147
-
148
- | Layer | Mechanism | Budget | Content |
149
- |-------|-----------|--------|---------|
150
- | **Always-on** | `~/.claude/rules/` or hook | <10K chars | Core identity, gotchas, critical procedures |
151
- | **On-demand** | Skills (SKILL.md) | <5K tokens each | Specific workflows activated by task |
152
- | **Deep reference** | `references/` in skills | Unlimited | Full specs, schemas, examples |
153
-
154
- **The always-on layer should answer: "What does this agent need to know about
155
- every single task?"** Everything else activates on demand.
156
-
157
- ## References
158
-
159
- - Read `references/agentskills-spec.md` for the complete agentskills.io specification including frontmatter fields, description optimization methodology, evaluation framework, and script design requirements