@tacuchi/agent-workflow-cli 15.1.0 → 16.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.
- package/package.json +1 -1
- package/skills/w/README.md +14 -14
- package/skills/w/SKILL.md +96 -75
- package/skills/w/artifacts/README.md +6 -6
- package/skills/w/artifacts/artifacts-core/SESSION.md +1 -7
- package/skills/w/artifacts/artifacts-core/TASKS.md +1 -1
- package/skills/w/artifacts/artifacts-exec/TECHNICAL-NOTE.md +9 -54
- package/skills/w/artifacts/artifacts-research/CONCLUSIONS.md +1 -1
- package/skills/w/commands/README.md +22 -22
- package/skills/w/commands/export-diagrams.md +9 -9
- package/skills/w/commands/export-manuals.md +9 -9
- package/skills/w/commands/export-reports.md +9 -9
- package/skills/w/commands/export-scripts.md +9 -9
- package/skills/w/commands/fix-git.md +12 -12
- package/skills/w/commands/plan-exec.md +19 -19
- package/skills/w/commands/plan-new.md +18 -18
- package/skills/w/commands/plan-refine.md +22 -22
- package/skills/w/commands/quick.md +16 -16
- package/skills/w/commands/spec-new.md +35 -34
- package/skills/w/commands/spec-refine.md +16 -16
- package/skills/w/commands/status.md +18 -16
- package/skills/w/commands/workspace-init.md +14 -14
- package/skills/w/exports/README.md +5 -5
- package/skills/w/exports/export-diagrams/SKILL.md +58 -58
- package/skills/w/exports/export-manuals/SKILL.md +61 -61
- package/skills/w/exports/export-reports/SKILL.md +51 -51
- package/skills/w/exports/export-scripts/SKILL.md +60 -60
- package/skills/w/harness/SKILL.md +48 -47
- package/skills/w/loops/CHASSIS.md +104 -97
- package/skills/w/loops/CODE-POLICIES.md +21 -21
- package/skills/w/loops/README.md +30 -29
- package/skills/w/loops/plan-exec-loop/SKILL.md +77 -80
- package/skills/w/loops/plan-new-loop/SKILL.md +88 -58
- package/skills/w/loops/plan-refine-loop/SKILL.md +69 -45
- package/skills/w/loops/quick-loop/SKILL.md +79 -79
- package/skills/w/loops/spec-refine-loop/SKILL.md +93 -97
- package/skills/w/roles/README.md +2 -2
- package/skills/w/roles/diagrams/SKILL.md +50 -47
- package/skills/w/roles/git/SKILL.md +58 -58
- package/skills/w/roles/research/SKILL.md +65 -62
- package/skills/w/roles/sql/SKILL.md +59 -55
- package/skills/w/roles/ui-spec/SKILL.md +60 -74
|
@@ -1,125 +1,125 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: export-diagrams
|
|
3
|
-
description: "
|
|
3
|
+
description: "Generates the workspace's architecture and flow diagrams in `docs/diagrams/` consolidating the sources' code + the plan-doc (`Current state (AS-IS)` / `Target state (TO-BE)`, `Impacted`) of N sessions. Produces context, containers, components, integrations and data model (when read-only MCP is available). Default `mermaid` (renders on GitHub, `mermaid.ink` link for preview); `c4`/structurizr opt-in via `--engine`. Output in `docs/diagrams/NNN-export-diagrams-YYYY-MM-DD/` (or `.md`). Read-only/report: emits only the diagram source (the reader renders it); never commits nor mutates anything; MCP reads only. Composes the `diagrams` capability. Use for 'system diagram', 'workspace C4', 'architecture/flow map'. User-invoked via `/w:export-diagrams`."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# export-diagrams —
|
|
6
|
+
# export-diagrams — architecture and flow diagrams from code + plan-doc
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Generates a diagram dossier (**architecture and flows**) of the workspace, aggregating the sources' structure and the sessions' delta. **Read-only / report** — it emits only the diagram **source** (Mermaid / DSL); the reader renders it. It never commits, never mutates anything; MCP reads only.
|
|
9
9
|
|
|
10
|
-
>
|
|
10
|
+
> `export-*` family (the only artifact→`docs/` path). Design: `docs/referencias/workflow-exports/export-diagrams.md`.
|
|
11
11
|
|
|
12
12
|
## Category
|
|
13
13
|
|
|
14
|
-
`docs/diagrams` —
|
|
14
|
+
`docs/diagrams` — the **only** `docs/` folder this export writes.
|
|
15
15
|
|
|
16
16
|
## Composes
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
The **`diagrams`** capability (built-in default `diagrams`), resolved via `.workflow/skills.toml`. It contributes the render engine (native Mermaid C4 / Structurizr DSL), the C1–C4 levels and the preview-link convention. This export does **not** own that logic: it composes it. Rebindable or `off` by config.
|
|
19
19
|
|
|
20
20
|
## When to use
|
|
21
21
|
|
|
22
|
-
- "
|
|
23
|
-
- "
|
|
24
|
-
-
|
|
22
|
+
- "System diagram", "workspace C4", "architecture map".
|
|
23
|
+
- "Flow diagram" across touched components / integrations.
|
|
24
|
+
- Technical onboarding; before structural changes (validate the current architecture); technical audit.
|
|
25
25
|
|
|
26
26
|
## What it does
|
|
27
27
|
|
|
28
|
-
1.
|
|
29
|
-
2.
|
|
30
|
-
3. (
|
|
31
|
-
4.
|
|
32
|
-
5.
|
|
33
|
-
6.
|
|
28
|
+
1. Inspects the workspace sources' code (structure, wiring, integrations, technologies).
|
|
29
|
+
2. Reads the plan-doc from the sessions: `Current state (AS-IS)` / `Target state (TO-BE)` and `Impacted` (what changed and where).
|
|
30
|
+
3. (Optional) With read-only MCP available and a data-model request: queries DB schemas (reads only).
|
|
31
|
+
4. Resolves the engine (`--engine`) and consolidates the architecture/flows touched by the N sessions.
|
|
32
|
+
5. Renders the diagrams (composes `diagrams`): context, containers, components, integrations, data model (when it applies).
|
|
33
|
+
6. Writes the dossier to `docs/diagrams/NNN-export-diagrams-YYYY-MM-DD/` with a `README.md` (index + how to read).
|
|
34
34
|
|
|
35
35
|
## What it does NOT do
|
|
36
36
|
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
- **
|
|
41
|
-
-
|
|
42
|
-
-
|
|
37
|
+
- Run commits, merges, push, or SQL.
|
|
38
|
+
- Mutate sessions, the plan-doc or the code (read-only). MCP **reads only** (never DML/DDL).
|
|
39
|
+
- Write any `docs/` folder other than `docs/diagrams/` (invariant: one category).
|
|
40
|
+
- **Visually render** the diagram: it emits only the source (Mermaid / DSL); the reader renders with their tools (or the `mermaid.ink` link).
|
|
41
|
+
- Validate that the integrations work (that is doctor work) or invent absent components.
|
|
42
|
+
- Overwrite previous dossiers (always next-number).
|
|
43
43
|
|
|
44
44
|
## Read-only sandbox
|
|
45
45
|
|
|
46
|
-
|
|
46
|
+
In plan mode it **describes**, never writes: the resolved engine, the levels/sections that would appear (resolved by args), the sources to inspect + detected integrations, and — with a data-model request — the proposed MCP queries with their estimated cost. It does **not** run `Write`, MCP mutations, or effectful `aw next-number`.
|
|
47
47
|
|
|
48
48
|
## Inputs
|
|
49
49
|
|
|
50
|
-
|
|
50
|
+
**`agent-workflow` CLI (alias `aw`)** — never read hardcoded paths:
|
|
51
51
|
|
|
52
|
-
- `aw sessions` / `aw release-data [--since sessionNNN] [--source <alias>]` —
|
|
53
|
-
- `aw session-artifacts --code <NNN> --dump objetivo` —
|
|
54
|
-
- `aw next-number docs/diagrams` —
|
|
52
|
+
- `aw sessions` / `aw release-data [--since sessionNNN] [--source <alias>]` — enumerates the corpus (input for the AS-IS/TO-BE delta).
|
|
53
|
+
- `aw session-artifacts --code <NNN> --dump objetivo` — locates the session and its plan-doc reference; `AS-IS`/`TO-BE`/`Impacted` are read from the plan-doc by its path.
|
|
54
|
+
- `aw next-number docs/diagrams` — deterministic numbering (the CLI handles destination-folder resolution).
|
|
55
55
|
|
|
56
|
-
**Filesystem /
|
|
56
|
+
**Filesystem / code**:
|
|
57
57
|
|
|
58
|
-
-
|
|
59
|
-
- `docs/diagrams/`
|
|
58
|
+
- The declared sources' code (structure, wiring, technology manifests).
|
|
59
|
+
- Existing `docs/diagrams/` (to complement / avoid collisions).
|
|
60
60
|
|
|
61
|
-
**
|
|
61
|
+
**Read-only MCP** (optional, only with a data-model request and configuration): `\d <table>`, `SELECT count(*)`, FK relations for the `erDiagram`. With the cost guard.
|
|
62
62
|
|
|
63
|
-
**Args** (
|
|
63
|
+
**Args** (no lifecycle *structured-choice*; harness capability — see [`../../harness/SKILL.md`](../../harness/SKILL.md)):
|
|
64
64
|
|
|
65
65
|
```
|
|
66
66
|
/w:export-diagrams [--sessions NNN[,NNN]] [--since sessionNNN] [--source <alias>]
|
|
67
67
|
[--engine mermaid|c4] [--scope c4|integrations|data|todo] [--dry-run]
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
| Flag |
|
|
70
|
+
| Flag | Behavior |
|
|
71
71
|
|---|---|
|
|
72
|
-
| `--sessions NNN[,NNN]` |
|
|
73
|
-
| `--since sessionNNN` |
|
|
74
|
-
| `--source <alias>` |
|
|
75
|
-
| `--engine mermaid\|c4` | Default `mermaid` (
|
|
76
|
-
| `--scope` |
|
|
77
|
-
| `--dry-run` |
|
|
72
|
+
| `--sessions NNN[,NNN]` | Discrete filter by code (takes precedence over `--since`); affects the AS-IS/TO-BE delta |
|
|
73
|
+
| `--since sessionNNN` | Only sessions after NNN (exclusive: NNN itself is out; use `--sessions` to include it) |
|
|
74
|
+
| `--source <alias>` | Limits to one source (multi-source workspace) |
|
|
75
|
+
| `--engine mermaid\|c4` | Default `mermaid` (renders on GitHub); `c4` = opt-in Structurizr DSL |
|
|
76
|
+
| `--scope` | Which sections appear: `c4` (context/containers/components), `integrations`, `data` (only with MCP), `todo` (default: all) |
|
|
77
|
+
| `--dry-run` | Propositional report, no files written |
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
No args: `--engine mermaid --scope todo`. The system **snapshot** is always the last known state; `--since`/`--sessions` modulate the delta emphasis (what was touched), not the base snapshot.
|
|
80
80
|
|
|
81
81
|
## Flow
|
|
82
82
|
|
|
83
|
-
###
|
|
83
|
+
### Step 1 — Resolve context and corpus
|
|
84
84
|
|
|
85
|
-
`aw sessions` / `release-data`
|
|
85
|
+
`aw sessions` / `release-data` applying `--sessions`/`--since`/`--source`. The CLI handles destination-folder resolution.
|
|
86
86
|
|
|
87
|
-
###
|
|
87
|
+
### Step 2 — Inspect the sources
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
Per source: basic structure, internal components (modules, services, commands, hooks, configured MCP), technologies per manifest (`package.json`, `pom.xml`, …), external integrations.
|
|
90
90
|
|
|
91
|
-
###
|
|
91
|
+
### Step 3 — Read the corpus delta
|
|
92
92
|
|
|
93
|
-
|
|
93
|
+
Per filtered session (`aw session-artifacts --code <NNN> --dump objetivo`): follow the plan-doc reference and read `Current state (AS-IS)` / `Target state (TO-BE)` and `Impacted`. Used to highlight what changed over the current snapshot.
|
|
94
94
|
|
|
95
|
-
###
|
|
95
|
+
### Step 4 — Inspect MCP (optional)
|
|
96
96
|
|
|
97
|
-
|
|
97
|
+
If `--scope` includes `data` and read-only MCP exists: `\d <table>`, `count(*)`, FK relations (with the cost guard). Not available → omit the "Data model" section with an inline note.
|
|
98
98
|
|
|
99
|
-
###
|
|
99
|
+
### Step 5 — Render (composes `diagrams`)
|
|
100
100
|
|
|
101
|
-
|
|
101
|
+
Per `--engine`: `mermaid` → native Mermaid C4 blocks (`C4Context`/`C4Container`/`C4Component`) and `flowchart` for flows; `c4` → a separate Structurizr `workspace.dsl` + auxiliary embedded Mermaid for offline reading. For every ```` ```mermaid ```` block, add immediately after the closing fence a blockquote with the preview link: `> Ver diagrama renderizado: <https://mermaid.ink/img/BASE64>` (URL-safe base64 of the plain code). Not applicable to `workspace.dsl`.
|
|
102
102
|
|
|
103
|
-
###
|
|
103
|
+
### Step 6 — Write or report
|
|
104
104
|
|
|
105
|
-
|
|
105
|
+
With `--dry-run`: print the report; write nothing. Otherwise: `aw next-number docs/diagrams` + write the dossier. **NEVER commit**. Summary to the user: engine, present/omitted sections (e.g. Data omitted without MCP) and the path.
|
|
106
106
|
|
|
107
107
|
## Output location
|
|
108
108
|
|
|
109
109
|
```
|
|
110
110
|
docs/diagrams/NNN-export-diagrams-YYYY-MM-DD/
|
|
111
|
-
├── README.md #
|
|
112
|
-
├── diagrams.md #
|
|
113
|
-
└── workspace.dsl #
|
|
111
|
+
├── README.md # index + how to read + counts
|
|
112
|
+
├── diagrams.md # main document with embedded Mermaid (+ mermaid.ink links)
|
|
113
|
+
└── workspace.dsl # only with --engine c4 (Structurizr)
|
|
114
114
|
```
|
|
115
115
|
|
|
116
116
|
## Re-run
|
|
117
117
|
|
|
118
|
-
|
|
118
|
+
Functionally idempotent: each invocation takes the next `NNN`; it never overwrites previous dossiers. To regenerate: delete the directory and re-invoke.
|
|
119
119
|
|
|
120
120
|
## Resources
|
|
121
121
|
|
|
122
|
-
- Design: `docs/referencias/workflow-exports/export-diagrams.md` ·
|
|
123
|
-
-
|
|
124
|
-
-
|
|
122
|
+
- Design: `docs/referencias/workflow-exports/export-diagrams.md` · family: [`../README.md`](../README.md).
|
|
123
|
+
- Composed capability: `diagrams` (built-in default; see `docs/referencias/workflow-roles/`).
|
|
124
|
+
- Input: plan-doc `AS-IS`/`TO-BE`/`Impacted` (see `docs/plans`).
|
|
125
125
|
- Siblings: [`../export-scripts/SKILL.md`](../export-scripts/SKILL.md) · [`../export-manuals/SKILL.md`](../export-manuals/SKILL.md) · [`../export-reports/SKILL.md`](../export-reports/SKILL.md).
|
|
@@ -1,127 +1,127 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: export-manuals
|
|
3
|
-
description: "
|
|
3
|
+
description: "Operations / onboarding manuals (operator/support audience). Synthesizes the workspace's technical manuals into `docs/manuals/` consolidating N sessions (`exec`/`quick`) + `docs/`. Reads each session's `DECISION` and the plan-doc (`Solution`, `Final behavior`, `Validations`) + the touched code in the sources (how what was built operates/works). Two modes: `complement` (default, overwrites `INDEX.md` pointing at the detected manuals) and `regenerate` (produces a `NNN-export-manuals-YYYY-MM-DD/` dossier with 1 manual per topic). Audience: operators / support / onboarding. Read-only/report: it never commits nor mutates sessions. The prose follows the ambient writing conventions (the host auto-applies an installed writing skill when present). Use for 'operations manual', 'how what we shipped works', 'technical onboarding pack', 'manuals index'. User-invoked via `/w:export-manuals`."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# export-manuals —
|
|
6
|
+
# export-manuals — technical manuals from sessions + `docs/`
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Generates or refreshes **operations / how-it-works / onboarding** manuals in `docs/manuals/`, consolidating what N sessions delivered + the `docs/` corpus. **Read-only / report** — it never commits, never mutates sessions or code.
|
|
9
9
|
|
|
10
|
-
>
|
|
10
|
+
> `export-*` family (the only artifact→`docs/` path). Design: `docs/referencias/workflow-exports/export-manuals.md`.
|
|
11
11
|
|
|
12
12
|
## Category
|
|
13
13
|
|
|
14
|
-
`docs/manuals` —
|
|
14
|
+
`docs/manuals` — the **only** `docs/` folder this export writes.
|
|
15
15
|
|
|
16
|
-
## Writing (
|
|
16
|
+
## Writing (ambient convention, not a role)
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
The manual's prose follows the **ambient** writing conventions: the host auto-applies an installed writing skill (when present) by its `description` — short sentences, lists over prose, no filler, technical lexicon for the operator/support audience. This export does **not** compose or bind a `writing` role; it is **indifferent** to which writing skill exists. A useful family lives in the `dev-conventions` marketplace plugin, but the export does **not depend** on it. Manuals are user-facing deliverables → write them in the user's language.
|
|
19
19
|
|
|
20
20
|
## When to use
|
|
21
21
|
|
|
22
|
-
- "
|
|
23
|
-
- "
|
|
24
|
-
-
|
|
25
|
-
-
|
|
22
|
+
- "Operations manual", "how what we delivered works", "step-by-step guide".
|
|
23
|
+
- "Manuals index" / refresh the `INDEX.md` after new sessions.
|
|
24
|
+
- **Technical onboarding** pack for new team members.
|
|
25
|
+
- Documentation-coverage audit.
|
|
26
26
|
|
|
27
27
|
## What it does
|
|
28
28
|
|
|
29
|
-
1.
|
|
30
|
-
2.
|
|
31
|
-
3.
|
|
32
|
-
4.
|
|
33
|
-
5.
|
|
34
|
-
6.
|
|
29
|
+
1. Reads the session corpus (`exec`/`quick`): per session, `DECISION` + the plan-doc (`Solution`, `Final behavior`, `Validations`).
|
|
30
|
+
2. Inspects the touched code in the sources (how what was built operates/works) — read-only.
|
|
31
|
+
3. Detects topics (declared in `SESSION` — its `## Objective` —, or inferred by operational keywords).
|
|
32
|
+
4. Resolves the mode (`complement` or `regenerate`).
|
|
33
|
+
5. Synthesizes the content applying the ambient writing conventions (host).
|
|
34
|
+
6. Writes: `complement` → overwrites `docs/manuals/INDEX.md`; `regenerate` → a `docs/manuals/NNN-export-manuals-YYYY-MM-DD/` dossier with 1 manual per topic.
|
|
35
35
|
|
|
36
36
|
## What it does NOT do
|
|
37
37
|
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
43
|
-
-
|
|
38
|
+
- Run commits, merges, push, SQL or send emails.
|
|
39
|
+
- Mutate sessions, the plan-doc, or the sources' code (read-only).
|
|
40
|
+
- Write any `docs/` folder other than `docs/manuals/` (invariant: one category).
|
|
41
|
+
- Overwrite a previous `regenerate` dossier (always next-number).
|
|
42
|
+
- Invent manuals: with no detectable topic → in `regenerate` it aborts with a clear message; in `complement` it produces an empty `INDEX.md` with an inline note.
|
|
43
|
+
- Visually render diagrams (visual architecture belongs to `export-diagrams`; embedded Mermaid only when it adds value).
|
|
44
44
|
|
|
45
45
|
## Read-only sandbox
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
In plan mode it **describes**, never writes: the resolved mode, the detected topics (with origin sessions), the manuals already present in `docs/manuals/`, and — per mode — the `INDEX.md` structure it would overwrite or the count of manuals the dossier would generate. It does **not** run `Write` or effectful `aw next-number`.
|
|
48
48
|
|
|
49
49
|
## Inputs
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
**`agent-workflow` CLI (alias `aw`)** — never read hardcoded paths:
|
|
52
52
|
|
|
53
|
-
- `aw sessions` / `aw release-data [--since sessionNNN] [--source <alias>]` —
|
|
54
|
-
- `aw session-artifacts --code <NNN> --dump objetivo,decisiones` —
|
|
55
|
-
- `aw next-number docs/manuals` —
|
|
53
|
+
- `aw sessions` / `aw release-data [--since sessionNNN] [--source <alias>]` — enumerates the corpus.
|
|
54
|
+
- `aw session-artifacts --code <NNN> --dump objetivo,decisiones` — returns `{path, content, size}` per artifact (`SESSION` with its `## Objective`, `DECISION`); the plan-doc is read by its path.
|
|
55
|
+
- `aw next-number docs/manuals` — deterministic numbering (`regenerate` mode only).
|
|
56
56
|
|
|
57
57
|
**Filesystem**:
|
|
58
58
|
|
|
59
|
-
- `docs/manuals/*.md` —
|
|
60
|
-
- `docs/manuals/INDEX.md` — re-generable (
|
|
61
|
-
-
|
|
59
|
+
- `docs/manuals/*.md` — manuals already present (to complement).
|
|
60
|
+
- `docs/manuals/INDEX.md` — re-generable (overwritable) in `complement` mode.
|
|
61
|
+
- The declared sources' code — read to describe behavior.
|
|
62
62
|
|
|
63
|
-
**Args** (
|
|
63
|
+
**Args** (no lifecycle *structured-choice*; harness capability — see [`../../harness/SKILL.md`](../../harness/SKILL.md)):
|
|
64
64
|
|
|
65
65
|
```
|
|
66
66
|
/w:export-manuals [--sessions NNN[,NNN]] [--since sessionNNN] [--source <alias>]
|
|
67
67
|
[--mode complement|regenerate] [--topics slug1,slug2] [--dry-run]
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
| Flag |
|
|
70
|
+
| Flag | Behavior |
|
|
71
71
|
|---|---|
|
|
72
|
-
| `--sessions NNN[,NNN]` |
|
|
73
|
-
| `--since sessionNNN` |
|
|
74
|
-
| `--source <alias>` |
|
|
72
|
+
| `--sessions NNN[,NNN]` | Discrete filter by code (takes precedence over `--since`) |
|
|
73
|
+
| `--since sessionNNN` | Only sessions after NNN (exclusive: NNN itself is out; use `--sessions` to include it) |
|
|
74
|
+
| `--source <alias>` | Limits to one source (multi-source workspace) |
|
|
75
75
|
| `--mode complement\|regenerate` | Default `complement` |
|
|
76
|
-
| `--topics slug1,slug2` |
|
|
77
|
-
| `--dry-run` |
|
|
76
|
+
| `--topics slug1,slug2` | Limits to the declared topics |
|
|
77
|
+
| `--dry-run` | Propositional report, no files written |
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
No args: `--mode complement` over the whole corpus.
|
|
80
80
|
|
|
81
|
-
###
|
|
81
|
+
### `--mode` resolution
|
|
82
82
|
|
|
83
|
-
|
|
|
83
|
+
| Mode | Output | When to use |
|
|
84
84
|
|---|---|---|
|
|
85
|
-
| `complement` (default) | `docs/manuals/INDEX.md` (
|
|
86
|
-
| `regenerate` | `docs/manuals/NNN-export-manuals-YYYY-MM-DD/` (next-number) |
|
|
85
|
+
| `complement` (default) | `docs/manuals/INDEX.md` (overwrites) | Refresh the index after new sessions/manuals |
|
|
86
|
+
| `regenerate` | `docs/manuals/NNN-export-manuals-YYYY-MM-DD/` (next-number) | Consolidated manual pack (e.g. onboarding) |
|
|
87
87
|
|
|
88
88
|
## Flow
|
|
89
89
|
|
|
90
|
-
###
|
|
90
|
+
### Step 1 — Resolve context and corpus
|
|
91
91
|
|
|
92
|
-
`aw sessions` / `release-data`
|
|
92
|
+
`aw sessions` / `release-data` applying `--sessions`/`--since`/`--source`. The CLI handles destination-folder resolution.
|
|
93
93
|
|
|
94
|
-
###
|
|
94
|
+
### Step 2 — Inspect the present manuals
|
|
95
95
|
|
|
96
|
-
|
|
96
|
+
List `docs/manuals/*.md` (excluding `INDEX.md` and `NNN-export-manuals-*/` subdirectories). Per manual: slug (from the filename), title (first `#`), brief summary (first paragraph), path.
|
|
97
97
|
|
|
98
|
-
###
|
|
98
|
+
### Step 3 — Detect topics
|
|
99
99
|
|
|
100
|
-
|
|
100
|
+
For every filtered corpus session (`aw session-artifacts --code <NNN> --dump objetivo,decisiones`): take the dump's `DECISION` + the plan-doc (`Solution`/`Final behavior`/`Validations`) + the touched code. **Primary** topic: the topic in `SESSION` (its `## Objective`). **Secondary**: inference by operational keywords ("configure", "install", "step by step", "how to …" — in the user's language). Filter by `--topics` when present. List (slug, confidence, origin sessions).
|
|
101
101
|
|
|
102
|
-
###
|
|
102
|
+
### Step 4 — Synthesize (prose: ambient conventions)
|
|
103
103
|
|
|
104
|
-
**
|
|
104
|
+
**`complement` mode** — one `INDEX.md`: header + manual count + table (Topic · Slug · Manual present/`[pending]` · Origin sessions) + "Next steps" when there are pending topics.
|
|
105
105
|
|
|
106
|
-
**
|
|
106
|
+
**`regenerate` mode** — 1 `.md` per topic in the dossier, each with: Purpose · Prerequisites · Numbered steps (how to operate) · Final behavior (from the plan-doc) · Post-use validation · Relevant decisions (`DECISION`) · Troubleshooting · References. Every manual must let the operator complete the task **without** calling the development team. Plus a dossier `README.md` with the index. The prose follows the ambient writing conventions (host).
|
|
107
107
|
|
|
108
|
-
###
|
|
108
|
+
### Step 5 — Write or report
|
|
109
109
|
|
|
110
|
-
|
|
110
|
+
With `--dry-run`: print the report; write nothing. Otherwise: `complement` → `Write` over `docs/manuals/INDEX.md`; `regenerate` → `aw next-number docs/manuals` + create the dossier. **NEVER commit**. Summary to the user: mode + written paths + counts; if there are detectable topics without a manual, suggest covering them.
|
|
111
111
|
|
|
112
112
|
## Output location
|
|
113
113
|
|
|
114
|
-
- `complement`: `docs/manuals/INDEX.md` (
|
|
115
|
-
- `regenerate`: `docs/manuals/NNN-export-manuals-YYYY-MM-DD/`
|
|
114
|
+
- `complement`: `docs/manuals/INDEX.md` (overwrites).
|
|
115
|
+
- `regenerate`: `docs/manuals/NNN-export-manuals-YYYY-MM-DD/` with `README.md` + 1 `.md` per topic.
|
|
116
116
|
|
|
117
117
|
## Re-run
|
|
118
118
|
|
|
119
|
-
- `complement`:
|
|
120
|
-
- `regenerate`:
|
|
119
|
+
- `complement`: idempotent — two invocations over the same corpus produce the same `INDEX.md`.
|
|
120
|
+
- `regenerate`: each invocation takes the next `NNN`; it never overwrites previous dossiers.
|
|
121
121
|
|
|
122
122
|
## Resources
|
|
123
123
|
|
|
124
|
-
- Design: `docs/referencias/workflow-exports/export-manuals.md` ·
|
|
125
|
-
-
|
|
126
|
-
-
|
|
124
|
+
- Design: `docs/referencias/workflow-exports/export-manuals.md` · family: [`../README.md`](../README.md).
|
|
125
|
+
- Writing: **ambient** convention (not a role) — the host auto-applies an installed writing skill when present.
|
|
126
|
+
- Source artifacts: `DECISION` + plan-doc (see `docs/referencias/workflow-artifacts/artifacts-exec/` and `docs/specs`/`docs/plans`).
|
|
127
127
|
- Siblings: [`../export-scripts/SKILL.md`](../export-scripts/SKILL.md) · [`../export-diagrams/SKILL.md`](../export-diagrams/SKILL.md) · [`../export-reports/SKILL.md`](../export-reports/SKILL.md).
|