@alexandrealvaro/agentic 0.5.1-beta.1 → 0.6.0-beta.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 CHANGED
@@ -88,6 +88,38 @@ npm install -g @alexandrealvaro/agentic@beta
88
88
  agentic init
89
89
  ```
90
90
 
91
+ ## Recommended daily sequence
92
+
93
+ The kit ships nine universal skills plus three conditional ones — twelve discrete capabilities. The sequence below is a happy path through them for the three flows that cover most daily work. Skip steps that don't apply; the kit never enforces order.
94
+
95
+ **Greenfield project, first non-trivial feature:**
96
+
97
+ 1. `agentic init` — install skills.
98
+ 2. `/agentic-bootstrap` — produce `AGENTS.md` (operational guide).
99
+ 3. `/agentic-architecture` — produce `ARCHITECTURE.md` once load-bearing patterns emerge.
100
+ 4. `/agentic-spec` — feature-level spec at `doc/specs/NNNN-<slug>.md` (User Scenarios, Requirements, Success Criteria).
101
+ 5. `/agentic-adr` — only when the feature forces a binding architectural decision worth recording for posterity.
102
+ 6. `/agentic-task` — work-unit decomposition; reference the spec via `Spec ref`.
103
+ 7. `/agentic-ground` — four-source research before code (`agentic-philosophy` auto-loads in parallel).
104
+ 8. Implement.
105
+ 9. `/agentic-review main..HEAD` — fresh-context §10 review before merge.
106
+ 10. `/agentic-audit` — periodic drift check across operational docs and specs.
107
+
108
+ **Brownfield project, quick fix:**
109
+
110
+ 1. `agentic update` (only if you want upstream kit changes).
111
+ 2. Fix. `agentic-philosophy` auto-loads if the change is non-trivial.
112
+ 3. `/agentic-review` only if the fix is non-trivial. Trivial diffs skip the review.
113
+ 4. Commit.
114
+
115
+ **Brownfield project, research-only ("what's the best way to add X?"):**
116
+
117
+ 1. `/agentic-ground` — runs the four-source research pass and surfaces the happy path with citations.
118
+ 2. Decide whether the answer becomes a spec (`/agentic-spec`) or a one-off task (`/agentic-task`).
119
+ 3. Continue from step 6 of the greenfield flow.
120
+
121
+ The kit's discipline scales with the project's maturity. A solo PoC may legitimately skip `/agentic-spec` and `/agentic-adr` (the WORKFLOW §1 prune principle applies — don't add an artifact that wouldn't change agent behavior). A team product running on this kit is expected to use the full sequence; CI + hooks (deferred — see Task 0013) will eventually enforce the gates that today are advisory.
122
+
91
123
  ## Manual prompts
92
124
 
93
125
  If you prefer to skip the installer, the same artifacts can be generated by pasting prompts directly into your agent. Each prompt file has the literal text to copy, plus the matching template structure:
package/WORKFLOW.md CHANGED
@@ -62,16 +62,18 @@ Comments are exceptions. They justify *why* a non-obvious choice was made — ne
62
62
 
63
63
  ### Documentation Discipline
64
64
 
65
- Eight rules apply to every document the agent or the human writes in the project. They are framed against the failure modes the kit has actually seen bloated `AGENTS.md`, README pages that drift into changelogs, decision artifacts diluted by speculation.
65
+ The agent's authoritative copy of the eight-rule documentation discipline lives in the `agentic-philosophy` skill (`Documentation Discipline` section). The rules are summarized below for reference; the skill carries the full text agents read at session time. ADR-0008 records the canonical decision and the reconciliations against ADR-0004 (file-based task tracking) and ADR-0005 (universal agent behavior as a skill).
66
66
 
67
- 1. **Definitions and decisions only.** Documentation captures what is true now and the decisions that brought it there. Speculation, history, and unfounded plans are out. A deferred decision is in scope when it is *recorded* — an accepted ADR or a task file is fundamentação; "we might do X later" without a record is speculation and is cut.
68
- 2. **No dates, version stamps, `DRAFT` markers, or changelogs in narrative documents.** Applies to `README.md`, `AGENTS.md` / `CLAUDE.md`, `ARCHITECTURE.md`, `DESIGN.md`, specs, and any prose page. **Decision-record artifacts are exempt** — ADRs under `doc/adr/` (Nygard `Status` lifecycle requires a date) and tasks under `doc/tasks/` (append-only `Notes` log is the auditability surface). Use git history for narrative-doc evolution; keep the dated lifecycle inside the artifacts that need it.
69
- 3. **No emoji anywhere.** Not in docs, code, source comments, commit messages, PR bodies, or skill outputs. Severity tags use plain words (`Blocker / Concern / Note`); status uses words (`accepted / superseded`); structural cues use Markdown.
70
- 4. **Business context first.** Every document opens with *why* — the problem, the constraint, the user — before *what* and *how*. The first paragraph answers "what would break if this document didn't exist".
71
- 5. **One scope per document. No duplication.** If two documents would say the same thing, link instead of copying. The canonical location owns the content; everywhere else references it.
72
- 6. **Code is the primary documentation of behavior.** Comments justify *why* a non-obvious choice was made — never restate *what* the line does. If the comment is needed to explain *what*, rename or refactor.
73
- 7. **No commented-out code; no orphan `TODO` / `FIXME` in source.** Every deferred item references a tracked work item — a GitHub Issue, or a per-task file under `doc/tasks/NNNN-*.md` (the kit's file-based tracking surface). The trace must be addressable from the source line.
74
- 8. **Tests are living documentation of behavior.** Test names and assertions should read as the spec they enforce. When the spec changes, the test changes; when the test changes, the spec it documents must already have changed.
67
+ 1. **Definitions and decisions only.** No speculation, history, or unfounded plans.
68
+ 2. **No dates, version stamps, `DRAFT` markers, or changelogs in narrative documents.** Decision-record artifacts under `doc/adr/`, `doc/tasks/`, `doc/specs/` are exempt their lifecycle fields are the auditability primitive.
69
+ 3. **No emoji anywhere.**
70
+ 4. **Business context first.**
71
+ 5. **One scope per document. No duplication.**
72
+ 6. **Code is the primary documentation of behavior.**
73
+ 7. **No commented-out code; no orphan `TODO` / `FIXME` in source.** Every deferred item references a GitHub Issue or a `doc/tasks/NNNN-*.md` task.
74
+ 8. **Tests are living documentation of behavior.**
75
+
76
+ The skill body explains the rationale per rule, lists the failure modes the rules counter (bloated `AGENTS.md`, README pages drifting into changelogs, decision artifacts diluted by speculation), and walks through the reconciliations. Generator skills (`agentic-bootstrap`, `agentic-architecture`, `agentic-spec`, `agentic-task`, `agentic-adr`, `agentic-design`) reject violations of these rules at write time; `agentic-audit` flags drift across narrative docs and decision-record artifacts on demand.
75
77
 
76
78
  ## 3. Format by Evidence
77
79
 
@@ -86,29 +88,17 @@ Use XML when the prompt mixes instructions, retrieved context, examples, user in
86
88
 
87
89
  No format is universally best. **An observation from my practice, not benchmarked:** I've seen consistent gains when shifting prompts to XML — most noticeably with autonomous agents, where the prompt has to land alone without conversational refinement. Direct interactive use (Claude Code, Codex) tolerates loose Markdown; unattended agents don't. Claude in particular seems to respond well to XML, which I attribute to its training, but I haven't benchmarked it. Treat this as a starting hypothesis worth testing on your own target model and task before standardizing.
88
90
 
89
- ## 4. Find the Happy Path
90
-
91
- Before implementing, ask:
92
-
93
- > *"What is the canonical, idiomatic way to implement [X] in [stack]? Cite official docs. List common deviations and why people take them."*
94
-
95
- Then check continuously, especially mid-implementation:
96
-
97
- > *"We are at step Y. Are we still on the happy path? If we deviated, was it deliberate?"*
98
-
99
- Sometimes you can't follow the happy path — that's fine. But always know where it is and why you left it.
100
-
101
- The kit ships `agentic-ground` (workflow-operational skill) as the bound implementation of §4 + §5: it runs a four-source research pass (official docs, validated open-source examples, in-repo patterns, git history), synthesizes the happy path with citations, and gates any deviation behind an irrefutable justification before code is written.
91
+ ## 4–5. Research Before Implementation
102
92
 
103
- ## 5. Ground in Real Patterns
93
+ Combines Find the Happy Path (canonical / idiomatic baseline) and Ground in Real Patterns (anchoring in project-specific examples). The kit treats both as one indivisible flow via `agentic-ground`; two prose sections would frame one operation as two separate practices.
104
94
 
105
- Don't dump the codebase into context. Anchor the model in a specific, project-relevant example.
95
+ Two sub-practices, joined into one indivisible pass.
106
96
 
107
- > *"Find an existing example of [similar feature]; use that exact structure."*
97
+ **Find the happy path.** Before implementing, ask: *"What is the canonical, idiomatic way to implement [X] in [stack]? Cite official docs. List common deviations and why people take them."* Mid-implementation: *"Are we still on the happy path? If we deviated, was it deliberate?"* Sometimes you can't follow the happy path — that's fine. Always know where it is and why you left it.
108
98
 
109
- Cite specific files, not "the codebase." Use just-in-time retrieval: pass paths or IDs and let the agent fetch via tools when it needs to read them.
99
+ **Ground in real patterns.** Don't dump the codebase into context. Anchor the model in a specific, project-relevant example: *"Find an existing example of [similar feature]; use that exact structure."* Cite specific files, not "the codebase." Use just-in-time retrieval pass paths or IDs and let the agent fetch via tools.
110
100
 
111
- `agentic-ground` (see §4) is the workflow-operational skill that combines this with the other three research sources — official docs, validated OSS, and git history — into one indivisible pre-implementation pass.
101
+ The kit ships `agentic-ground` as the workflow-operational implementation of both. It runs a four-source research pass — official docs, validated open-source examples, in-repo patterns, git history — joined by AND not OR, synthesizes the happy path with citations from each source, and gates any deviation behind an irrefutable justification before code is written. Splitting the two sub-practices into separate skills would force two invocations with overlapping research outputs and fragment the synthesis context (ADR-0010).
112
102
 
113
103
  ## 6. Explore → Plan → Implement → Commit
114
104
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alexandrealvaro/agentic",
3
- "version": "0.5.1-beta.1",
3
+ "version": "0.6.0-beta.1",
4
4
  "description": "Bootstrap and audit AGENTS.md, ARCHITECTURE.md, ADRs, skills, and subagents for engineering production code with LLMs",
5
5
  "type": "module",
6
6
  "bin": {
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: agentic-audit
3
- description: Read-only drift audit — compare AGENTS.md, ARCHITECTURE.md, and ADR statuses against what the code actually does. Outputs a drift list, never writes files. Use when the user wants to audit, review for drift, sanity-check, or report inconsistencies between the repo's docs and its code.
3
+ description: Read-only drift audit — compare AGENTS.md, ARCHITECTURE.md, ADR statuses, feature specs in doc/specs/, and documentation discipline against what the code actually does. Outputs a drift list, never writes files. Use when the user wants to audit, review for drift, sanity-check, or report inconsistencies between the repo's docs and its code.
4
4
  allowed-tools: Read, Glob, Grep, Bash
5
5
  ---
6
6
 
@@ -10,7 +10,7 @@ Read-only. Produces a drift list comparing the repo's operational docs against w
10
10
 
11
11
  ## Step 1 — Decide what to audit
12
12
 
13
- If the user names an artifact (`AGENTS.md`, `ARCHITECTURE.md`, ADRs), audit only that. Otherwise audit all three categories below.
13
+ If the user names an artifact (`AGENTS.md`, `ARCHITECTURE.md`, ADRs, specs), audit only that. Otherwise audit all categories below.
14
14
 
15
15
  ## Step 2 — Run checks
16
16
 
@@ -34,6 +34,16 @@ If the user names an artifact (`AGENTS.md`, `ARCHITECTURE.md`, ADRs), audit only
34
34
  * Status field — every ADR has one of `proposed | accepted | deprecated | superseded by ADR-NNNN`.
35
35
  * Superseded chains — every "superseded by ADR-NNNN" target exists.
36
36
 
37
+ ### Spec drift (if `doc/specs/` exists)
38
+
39
+ Structural integrity only — does **not** deep-audit spec text against shipped code (deferred per [ADR-0011](../../doc/adr/0011-agentic-spec-skill.md) Consequences).
40
+
41
+ * Numbering — gaps or duplicates in `doc/specs/NNNN-*.md`?
42
+ * Status field — every spec has one of `draft | accepted | shipped | superseded by SPEC-NNNN`.
43
+ * Superseded chains — every "superseded by SPEC-NNNN" target exists.
44
+ * Reciprocity — every task under `doc/tasks/NNNN-*.md` whose `Spec ref` field is non-empty points to a spec that exists. And every spec with `Status: accepted` or `shipped` has at least one entry in its `Related → Tasks` list (an accepted spec with no implementing task is a smell).
45
+ * Success Criteria coverage — when every task that references a spec is `done`, the spec's Success Criteria checkboxes should all be checked. A spec with all tasks `done` but unchecked Success Criteria boxes is drift between work-unit completion and feature-level claim.
46
+
37
47
  ### Documentation discipline drift (`WORKFLOW.md` §2 / ADR-0008)
38
48
 
39
49
  Audit narrative documents — `README.md`, `AGENTS.md` / `CLAUDE.md`, `ARCHITECTURE.md`, `DESIGN.md`, any prose page under `doc/` that is not a decision-record artifact under `doc/adr/` or `doc/tasks/`:
@@ -20,12 +20,9 @@ Before implementing:
20
20
 
21
21
  ## Ground Before Coding
22
22
 
23
- **Anchor in real patterns. Research the canonical path.**
23
+ **Anchor in real patterns before writing code.**
24
24
 
25
- - Find the canonical/idiomatic way to do it. Note where you deviate and why.
26
- - Find an existing example in the codebase; reuse its structure.
27
- - Cite specific files, not "the codebase". Fetch via tools — don't dump code into context.
28
- - For non-trivial changes, explore (read-only) → plan → implement → commit. Skip for diffs you can describe in one sentence.
25
+ For non-trivial changes, invoke `/agentic-ground` — the workflow-operational skill that runs the four-source research pass (official docs, validated open-source examples, in-repo patterns, git history) and synthesizes a happy path with citations. The skill carries the prescriptive deviation gate; this section carries the posture only. Skip for diffs you can describe in one sentence.
29
26
 
30
27
  ## Simplicity First
31
28
 
@@ -29,6 +29,13 @@ ADR drift (if `doc/adr/` exists):
29
29
  - Status field — every ADR has one of `proposed | accepted | deprecated | superseded by ADR-NNNN`.
30
30
  - Superseded chains — every "superseded by ADR-NNNN" target exists.
31
31
 
32
+ Spec drift (if `doc/specs/` exists; structural integrity only — does NOT deep-audit spec text against code, deferred per ADR-0011):
33
+ - Numbering — gaps or duplicates in `doc/specs/NNNN-*.md`?
34
+ - Status field — every spec has one of `draft | accepted | shipped | superseded by SPEC-NNNN`.
35
+ - Superseded chains — every "superseded by SPEC-NNNN" target exists.
36
+ - Reciprocity — every task with non-empty `Spec ref` points to a spec that exists; every accepted/shipped spec has at least one entry in its Related → Tasks list.
37
+ - Success Criteria coverage — when every task referencing a spec is done, the spec's Success Criteria checkboxes should all be checked.
38
+
32
39
  Documentation discipline drift (`WORKFLOW.md` §2 / ADR-0008). Audit narrative documents — `README.md`, `AGENTS.md` / `CLAUDE.md`, `ARCHITECTURE.md`, `DESIGN.md`, any prose page under `doc/` that is not a decision-record artifact under `doc/adr/` or `doc/tasks/`:
33
40
  - Emoji — any present? Rule 3 forbids emoji anywhere (docs, code, comments, commits, skill outputs).
34
41
  - Dates / version stamps / `DRAFT` markers / changelog blocks in narrative documents — Rule 2 forbids these. Decision-record artifacts under `doc/adr/` and `doc/tasks/` are exempt.
@@ -10,7 +10,7 @@ Six behaviors apply to every non-trivial change. Bias toward caution over speed;
10
10
  <instructions>
11
11
  **Think Before Coding.** Don't assume. Don't hide confusion. Surface tradeoffs. State assumptions explicitly; ask when uncertain. If multiple interpretations exist, present them — don't pick silently. If a simpler approach exists, say so. If something is unclear, stop, name the confusion, ask.
12
12
 
13
- **Ground Before Coding.** Anchor in real patterns. Find the canonical/idiomatic way; note where you deviate and why. Find an existing example in the codebase and reuse its structure. Cite specific files, not "the codebase". Fetch via tools don't dump code into context. For non-trivial changes, explore plan implement commit. Skip for diffs describable in one sentence.
13
+ **Ground Before Coding.** Anchor in real patterns before writing code. For non-trivial changes, invoke `/agentic-ground` the workflow-operational skill that runs the four-source research pass (official docs, validated open-source examples, in-repo patterns, git history) and synthesizes a happy path with citations. The skill carries the prescriptive deviation gate; this section carries posture only. Skip for diffs describable in one sentence.
14
14
 
15
15
  **Simplicity First.** Minimum code that solves the problem. No features beyond what was asked. No abstractions for single-use code. No "flexibility" or "configurability" that wasn't requested. No error handling for impossible scenarios. Comments justify why, not what. No commented-out code; no orphan `TODO`/`FIXME` without an issue/ADR/follow-up reference. If 200 lines could be 50, rewrite.
16
16