@cr8rcho/alkahest 0.1.74 → 0.1.76
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/package.json +1 -1
- package/presets/as-built/CLAUDE-snippet.md +4 -4
- package/presets/as-built/preset.json +2 -2
- package/presets/as-built/scaffold/docs/README.md +1 -1
- package/presets/as-built/scaffold/docs/decisions/README.md +13 -1
- package/presets/as-built/skills/adr.md +8 -1
- package/presets/as-built/skills/as-built-docs.md +4 -4
- package/presets/index.json +1 -1
package/package.json
CHANGED
|
@@ -3,15 +3,15 @@
|
|
|
3
3
|
|
|
4
4
|
This repo keeps **as-built documentation** under `docs/` (four layers: system / components /
|
|
5
5
|
features / modules — see docs/README.md) and **ADRs** under `docs/decisions/`. The writing
|
|
6
|
-
instructions live in the account skills `as-built-docs` and `adr` — read them via the
|
|
6
|
+
instructions live in the account skills `alkahest/as-built-docs` and `alkahest/adr` — read them via the
|
|
7
7
|
alkahest MCP `skills` tool before writing docs.
|
|
8
8
|
|
|
9
9
|
1. **After finishing any code change, update the affected docs in the same session.**
|
|
10
|
-
The layer mapping and the update checklist are in the `as-built-docs` skill. Write an
|
|
10
|
+
The layer mapping and the update checklist are in the `alkahest/as-built-docs` skill. Write an
|
|
11
11
|
ADR only for decisions whose "why" a code diff cannot reconstruct (criteria and the
|
|
12
|
-
template are in the `adr` skill).
|
|
12
|
+
template are in the `alkahest/adr` skill).
|
|
13
13
|
2. **First documentation pass (repo has no docs yet)?** Follow the bootstrap protocol in
|
|
14
|
-
the `as-built-docs` skill: one system map + 2–3 core modules + ADR-001 (architecture
|
|
14
|
+
the `alkahest/as-built-docs` skill: one system map + 2–3 core modules + ADR-001 (architecture
|
|
15
15
|
snapshot) — small first, then mirror and hand the user the note-map link. Grow the rest
|
|
16
16
|
incrementally with later work.
|
|
17
17
|
3. **After changing `docs/`, mirror it to the hosted note maps** by running
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
"name": "as-built docs",
|
|
4
4
|
"description": "Living as-built documentation + an ADR log, written by your agent and mirrored to note maps.",
|
|
5
5
|
"skills": [
|
|
6
|
-
{ "name": "as-built-docs", "file": "skills/as-built-docs.md" },
|
|
7
|
-
{ "name": "adr", "file": "skills/adr.md" }
|
|
6
|
+
{ "name": "alkahest/as-built-docs", "file": "skills/as-built-docs.md" },
|
|
7
|
+
{ "name": "alkahest/adr", "file": "skills/adr.md" }
|
|
8
8
|
],
|
|
9
9
|
"scaffold": "scaffold",
|
|
10
10
|
"snippet": "CLAUDE-snippet.md",
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
This directory holds this repository's **as-built documentation** — documents that record
|
|
4
4
|
how the system is actually built (never plans or PRDs). Writing instructions live in the
|
|
5
|
-
`as-built-docs` account skill (read it via the alkahest MCP `skills` tool).
|
|
5
|
+
`alkahest/as-built-docs` account skill (read it via the alkahest MCP `skills` tool).
|
|
6
6
|
|
|
7
7
|
## Layers
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
This folder collects **Architecture Decision Records** — the why / alternatives /
|
|
4
4
|
trade-offs of decisions, frozen at decision time. Writing instructions and the template
|
|
5
|
-
live in the `adr` account skill (read it via the alkahest MCP `skills` tool).
|
|
5
|
+
live in the `alkahest/adr` account skill (read it via the alkahest MCP `skills` tool).
|
|
6
6
|
|
|
7
7
|
Quick rules:
|
|
8
8
|
|
|
@@ -10,3 +10,15 @@ Quick rules:
|
|
|
10
10
|
- Append-only: a changed decision gets a NEW ADR with `Supersedes:`; the old one keeps its
|
|
11
11
|
body and gets `Status: Superseded by …`.
|
|
12
12
|
- Start the practice with **ADR-001 — architecture snapshot** of the current code.
|
|
13
|
+
|
|
14
|
+
## Tag vocabulary
|
|
15
|
+
|
|
16
|
+
Every ADR opens with `tags:` frontmatter, and **this table is the vocabulary** — pick from
|
|
17
|
+
it; extend it deliberately (add the row in the same commit as the ADR that needs it). On the
|
|
18
|
+
hosted `adr` note map each tag becomes a hub node, so the vocabulary's shape IS the map's
|
|
19
|
+
shape: one **surface** tag per ADR (the product/code area it touches) plus at most two
|
|
20
|
+
**arc** tags (a storyline several ADRs share), and keep each tag attached to roughly 3–12
|
|
21
|
+
ADRs. The first documentation pass seeds the surface rows from the codebase's actual areas.
|
|
22
|
+
|
|
23
|
+
| Tag | Kind | Meaning |
|
|
24
|
+
|---|---|---|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# adr — decision records
|
|
1
|
+
# alkahest/adr — decision records
|
|
2
2
|
|
|
3
3
|
ADRs (`docs/decisions/NNN-kebab-title.md`) record the **why** of decisions: context,
|
|
4
4
|
alternatives, trade-offs. They are a separate axis from as-built docs — as-built documents
|
|
@@ -38,6 +38,13 @@ one **surface** tag (the area of the product it touches) plus at most two **arc*
|
|
|
38
38
|
node — keep every tag attached to roughly 3–12 ADRs so the map stays legible, and prefer
|
|
39
39
|
reusing an existing tag over inventing a new one.
|
|
40
40
|
|
|
41
|
+
**The vocabulary lives in `docs/decisions/README.md`'s tag table, and the repo owns it.**
|
|
42
|
+
On the bootstrap pass, seed it: derive 3–7 surface tags from the codebase's *actual* areas
|
|
43
|
+
(the folders/verticals you just documented), record them in the table, and tag ADR-001 from
|
|
44
|
+
that set. Afterwards, every ADR picks from the table; a genuinely new tag means adding its
|
|
45
|
+
row in the same commit. Arc tags are not invented up front — they emerge when several ADRs
|
|
46
|
+
turn out to share a storyline.
|
|
47
|
+
|
|
41
48
|
## Template
|
|
42
49
|
|
|
43
50
|
```markdown
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# as-built-docs — writing instructions
|
|
1
|
+
# alkahest/as-built-docs — writing instructions
|
|
2
2
|
|
|
3
3
|
You are maintaining this repository's **as-built documentation**: documents that record how
|
|
4
4
|
the system **is actually built**. Never plans, PRDs, or aspirations — present tense, code as
|
|
@@ -25,7 +25,7 @@ summary + link in the other.
|
|
|
25
25
|
Title each document with a **classed H1**: `# System — <name>`, `# Component — <name>`,
|
|
26
26
|
`# Feature — <name>`, `# Module — <name>`. The note-map mirror strips the class prefix,
|
|
27
27
|
so the hosted note is titled just `<name>` while the file stays unambiguous in the repo.
|
|
28
|
-
(ADRs have their own H1 shape — see the `adr` skill.)
|
|
28
|
+
(ADRs have their own H1 shape — see the `alkahest/adr` skill.)
|
|
29
29
|
|
|
30
30
|
## Bootstrap — when the repo has no docs yet
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ the user sees a map fast:
|
|
|
35
35
|
1. `docs/system/<app>.md` — one system map: layers, data flow, key dependencies, honest
|
|
36
36
|
Known Limitations.
|
|
37
37
|
2. Two or three `docs/modules/*.md` for the load-bearing modules only.
|
|
38
|
-
3. One decision record (see the `adr` skill): **ADR-001, an architecture snapshot** — the
|
|
38
|
+
3. One decision record (see the `alkahest/adr` skill): **ADR-001, an architecture snapshot** — the
|
|
39
39
|
decisions already embedded in the current code.
|
|
40
40
|
4. Add each document to the index in `docs/README.md`, then **mirror to the note maps and
|
|
41
41
|
hand the user the map link** (the mirroring rule lives in this repo's CLAUDE.md).
|
|
@@ -52,7 +52,7 @@ code changes touch.
|
|
|
52
52
|
- **As-built, present tense** — "this is how it is built." Cite real file paths, function
|
|
53
53
|
names, and constants so readers can jump straight to code.
|
|
54
54
|
- **Decision history is a separate axis** — why / alternatives / trade-offs belong in ADRs
|
|
55
|
-
(`docs/decisions/`, see the `adr` skill), not in these documents.
|
|
55
|
+
(`docs/decisions/`, see the `alkahest/adr` skill), not in these documents.
|
|
56
56
|
- **Known Limitations, honestly** — the most valuable section of a post-hoc document.
|
|
57
57
|
Remove limitations you fixed; add the ones you introduced.
|
|
58
58
|
- **Overwrite freely** — these documents always describe the present. (ADRs are the
|
package/presets/index.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"id": "as-built",
|
|
5
5
|
"name": "as-built docs",
|
|
6
6
|
"description": "Living as-built documentation + an ADR log, written by your agent and mirrored to note maps.",
|
|
7
|
-
"skills": ["as-built-docs", "adr"],
|
|
7
|
+
"skills": ["alkahest/as-built-docs", "alkahest/adr"],
|
|
8
8
|
"maps": ["as-built", "adr"],
|
|
9
9
|
"contents": ["skills", "scaffold", "claude-snippet", "sync-script"]
|
|
10
10
|
}
|