scaffold-agent-specs 0.1.4 → 0.1.6

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.
@@ -3,7 +3,9 @@
3
3
  "6bdd5aa7149e0e3a53ddf1ff3fc067c3797e0c9942844cbb00b34c228204183c"
4
4
  ],
5
5
  ".agent-specs/templates/conventions/CONVENTION.md": [
6
- "462a9cbf6c502f6692c9813a2da02e796a3547d02fb58058e2153bf4e3dc91d3"
6
+ "462a9cbf6c502f6692c9813a2da02e796a3547d02fb58058e2153bf4e3dc91d3",
7
+ "636e0b91189004f35c12da1d31bca6a26d5b6e6460547ac7b052f6dcfe4122c8",
8
+ "6f048a218b8fa094fe8d12ee1978d0600849db4d8142ca56502e986b5af7dfaa"
7
9
  ],
8
10
  ".agent-specs/templates/feature/ACCEPTANCE_MATRIX.md": [
9
11
  "0efef77a6c06737d224289611ab9cd7640a987395bcb526fff4f4b5f86295753"
@@ -36,7 +38,8 @@
36
38
  "c08f3412d558b6992b0a2e003d5be0de201502846453c2b2da70c2d682d5815a",
37
39
  "bc70d6dee9f3f76affb0636ff804a112885b0973aaa2753ac970fc83d0260b5e",
38
40
  "a09404a3dce7e2c1f7aa0efce59c5b075943ad768a02b62dc51e08e44a050318",
39
- "53776f37c6f55ece45c4b4d32d2a48749031c90e77047d9a730c3f150af0d79f"
41
+ "53776f37c6f55ece45c4b4d32d2a48749031c90e77047d9a730c3f150af0d79f",
42
+ "3753a29898a4209208fdbb8f1e9a3de206d845d95e60d8c543f48c2c239780bf"
40
43
  ],
41
44
  "CLAUDE.md": [
42
45
  "272bcb5a9f136af56c1c93203c21976e02a09ed0a59d2515fad23d24b6c34408"
@@ -45,7 +48,9 @@
45
48
  "0712abf011e6632fcdaee95c9b0c7bcad39808b5d28678c25aa0c05d281f795f",
46
49
  "637e83ce425e97ee9751a8500f5928d1f1ed2536e8d1a02b85bf6e11bc937192",
47
50
  "9dd7762484311d7a2a59620d4e89c61e4eb68688d9ebe1b3e2f2ac6d114373fd",
48
- "049b5a682f613a0bb2dab7bd39e79645860eb30202d358ed9a879dbe238e84bc"
51
+ "049b5a682f613a0bb2dab7bd39e79645860eb30202d358ed9a879dbe238e84bc",
52
+ "8f66846159f0f049af2035fd71be7b289cc999099ad2ac6c1aa3b61745754745",
53
+ "4e12aed278f410305dc640a9f9cb0fa5135e28b0963c2a9bc4a8b7810e4af63f"
49
54
  ],
50
55
  "docs/adr/README.md": [
51
56
  "2f27a4a5ecfb92725875c0b859194588b0ed367ac87b7d321ba063062abf25d5"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "scaffold-agent-specs",
3
- "version": "0.1.4",
3
+ "version": "0.1.6",
4
4
  "description": "A tiny, spec-driven workflow scaffold for AI coding agents",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -1,6 +1,6 @@
1
1
  # [Topic] Conventions
2
2
 
3
- > **Optional project document.** When a stable convention applies across multiple features, copy this template to `docs/conventions/[topic].md`. Keep concrete rules here, not generic agent-process instructions. Prefer existing formatters, linters, and tooling as the source of truth for mechanically enforced rules.
3
+ > **Optional project document.** When a stable convention applies across multiple features, copy this template to `docs/conventions/[topic].md`. Keep concrete rules here, not generic agent-process instructions or decisions specific to one feature (record those in an ADR and link it). Prefer existing formatters, linters, and tooling as the source of truth for mechanically enforced rules.
4
4
 
5
5
  ## Scope
6
6
 
@@ -17,3 +17,5 @@
17
17
  ## Exceptions and evolution
18
18
 
19
19
  [Known exceptions, how to propose changes, and links to relevant ADRs or tooling.]
20
+
21
+ Rules specific to one feature belong in that feature's plan or an ADR; link them here instead of restating them.
@@ -50,7 +50,7 @@ Existing-feature work and ordinary fixes should follow the user's requested scop
50
50
  - Do not write speculative ADRs during feature discovery or initial specification. Capture proposed approaches and uncertainties in `PLAN.md` instead.
51
51
  - Keep docs concise and accurate; remove stale claims rather than merely appending new text.
52
52
  - Practice **progressive documentation**: create an optional document only to solve a concrete problem. Prefer updating an existing source of truth over producing redundant or empty files.
53
- - If maintained, keep `docs/ARCHITECTURE.md` aligned with the _implemented_ system, `docs/GLOSSARY.md` aligned with shared domain language, and `docs/conventions/` aligned with stable project-specific practices. Create them only when useful, from `.agent-specs/templates/project/` or `.agent-specs/templates/conventions/`. When closing a feature, check whether one has become useful and propose it to the user (see [`docs/WORKFLOW.md`](docs/WORKFLOW.md), Phase 5). An adopted architecture decision still belongs in an ADR.
53
+ - If maintained, keep `docs/ARCHITECTURE.md` aligned with the _implemented_ system, `docs/GLOSSARY.md` aligned with shared domain language, and `docs/conventions/` aligned with stable project-specific practices. Create them only when useful, from `.agent-specs/templates/project/` or `.agent-specs/templates/conventions/`. When closing a feature, check whether one has become useful and report your recommendation to the user (see [`docs/WORKFLOW.md`](docs/WORKFLOW.md), Phase 5). An adopted architecture decision still belongs in an ADR.
54
54
 
55
55
  ## Verification and completion
56
56
 
@@ -5,6 +5,7 @@ This document expands the feature lifecycle required by [`AGENTS.md`](../AGENTS.
5
5
  ## Phase 1: Discover (conversation only)
6
6
 
7
7
  - Read existing code and documentation when relevant, then explore the user's idea collaboratively.
8
+ - Check for overlap with existing features: list `docs/features/` and judge by folder names. Open a feature's `PLAN.md` only when its name suggests related scope, and read its summary and approved scope rather than the whole folder. If scope overlaps, say so in the proposal and settle with the user which feature owns it.
8
9
  - Ask focused clarifying questions, using the agent's interactive question interface where available or normal chat otherwise. Prefer small, purposeful batches over long questionnaires.
9
10
  - Establish the problem, target users, expected behaviors, important edge cases, constraints, dependencies, and exclusions.
10
11
  - Offer sensible defaults and surface tradeoffs; do not silently make consequential product decisions.
@@ -68,7 +69,7 @@ Write the approved scope into `PLAN.md`. Draft acceptance criteria and tasks tha
68
69
  - Review each acceptance criterion against observable evidence. Use `Pass`, `Fail`, `Blocked`, or `Not run`; never invent a result. If a criterion is waived or removed, record the user's approval and update scope accordingly.
69
70
  - Run applicable checks and document anything not run.
70
71
  - Update affected user/developer/project documentation in the same change. Maintain `docs/ARCHITECTURE.md`, `docs/GLOSSARY.md`, and `docs/conventions/` when they exist and are affected by the change.
71
- - Check whether a missing project document has become useful. If this feature relied on a rule that earlier features also relied on and that the code doesn't make obvious (one whose violation would be a silent bug), propose recording it in `docs/conventions/`. If domain terms are now used across several features, propose `docs/GLOSSARY.md`. Propose rather than create, and include the proposal in your report.
72
+ - Check whether a missing project document has become useful. Consider `docs/conventions/` for a rule that earlier features also relied on and that the code doesn't make obvious (one whose violation would be a silent bug), and `docs/GLOSSARY.md` for domain terms used across several features or easily confused with each other. **Always include the outcome in your report**: name each candidate and say whether you recommend it and why, even if you recommend against it. The user decides; don't create the document until they agree.
72
73
  - Create ADRs for meaningful architectural decisions **actually adopted**. Normally do this after the implementation is known; for a consequential choice adopted earlier, record it at that point.
73
74
  - Report what shipped, what was validated, any limitations, and whether the feature is complete. A feature is not complete while required acceptance criteria remain failing, blocked, or unverified.
74
75
  - Set the `TASKS.md` status to `Complete` only when that holds; otherwise use `Implemented (verification pending)` and list what remains.
@@ -82,6 +83,6 @@ Write the approved scope into `PLAN.md`. Draft acceptance criteria and tasks tha
82
83
  - `RESEARCH.md`, if present, preserves meaningful investigation and uncertainty, not decisions.
83
84
  - `HANDOFF.md`, if present, is a snapshot for resumption and may be deleted once unnecessary.
84
85
  - ADRs document _adopted_, broadly relevant architecture decisions; feature plans retain proposals and feature-local tradeoffs.
85
- - `docs/ARCHITECTURE.md` describes the implemented system; `docs/GLOSSARY.md` defines shared domain terminology; `docs/conventions/` records reusable project practices. Create these documents only when they provide value. Templates are under `.agent-specs/templates/`.
86
+ - `docs/ARCHITECTURE.md` describes the implemented system; `docs/GLOSSARY.md` defines shared domain terminology; `docs/conventions/` records reusable project practices, not decisions specific to one feature (those belong in an ADR or the feature's plan; link them instead of restating them). Create these documents only when they provide value. Templates are under `.agent-specs/templates/`.
86
87
 
87
88
  Approved scope changes must be brought back to the user before being incorporated as commitments. Keep artifacts understandable to someone resuming the project without the original chat history. **Progressive documentation:** do not create an optional document just because a template exists; prefer updating a single authoritative source over duplicating content.