Skip to content

Commit 0dc389b

Browse files
committed
docs(workflow): invocation & arguments reference for every user-invocable skill
Closes #43
1 parent bf95ab7 commit 0dc389b

6 files changed

Lines changed: 38 additions & 1 deletion

File tree

CHANGELOG.es.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,7 @@ Cómo funciona el pinning realmente, **verificado** contra el CLI `skills`:
282282
#### `audit-docs`
283283
| Versión | Fecha | Tipo | Qué cambió |
284284
|---|---|---|---|
285+
| 2.0.1 | 2026-07-11 | parche | Añadido el `argument-hint: "[--fix]"` que faltaba en el frontmatter (el modo `--fix` existía en el cuerpo pero era invisible en los menús de los agentes) — parte de #43, la referencia de invocación y argumentos en `docs/workflow/SKILLS.md`. |
285286
| 2.0.0 | 2026-07-10 | mayor | **Cambio incompatible:** se elimina la sección `## Machine envelope` y su cláusula de emisión en el contrato de turno — el contrato del envelope se traslada a la capa de orquestación; `workflow-status` sigue siendo el único emisor en línea. Ver `docs/workflow/MIGRATION.md`. |
286287
| 1.7.0 | 2026-07-05 | menor | Nuevo check 13 — procedencia de docs generadas (solo cuando hay bloque `Docs site` declarado): las páginas con `generated-by: agentic-workflow/generate-docs` cuya `source-unit` ya no existe son huérfanas (MEDIA); las páginas cuya unidad mergeó después de su fecha `updated` con commits en sus rutas son obsoletas (BAJA). Bloque de disciplina del workflow renumerado a 10–14. |
287288
| 1.6.0 | 2026-07-05 | menor | Envelope máquina: cada invocación termina ahora con un bloque JSON fijo (state, unit, phase, pr, findings, blockers, dependencies, next + pista de tier de modelo) para orquestación programática — esquema en la skill interna `orchestration-envelope`, protocolo en `docs/workflow/ORCHESTRATION.md`. |

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,7 @@ How pinning actually works, verified against the `skills` CLI:
280280
#### `audit-docs`
281281
| Version | Date | Type | What changed |
282282
|---|---|---|---|
283+
| 2.0.1 | 2026-07-11 | patch | Added the missing `argument-hint: "[--fix]"` frontmatter (the `--fix` mode existed in the body but was invisible in agents' slash menus) — part of #43, the invocation & arguments reference in `docs/workflow/SKILLS.md`. |
283284
| 2.0.0 | 2026-07-10 | major | **Breaking:** dropped the `## Machine envelope` section and its turn-contract emission clause — the envelope contract moved to the orchestration layer; `workflow-status` remains the sole inline emitter. See `docs/workflow/MIGRATION.md`. |
284285
| 1.7.0 | 2026-07-05 | minor | New check 13 — generated-docs provenance (only when a `Docs site` block is declared): pages carrying `generated-by: agentic-workflow/generate-docs` whose `source-unit` no longer exists are orphans (MEDIUM); pages whose unit merged after their `updated` date with commits on their subject paths are stale (LOW). Workflow-discipline block renumbered to 10–14. |
285286
| 1.6.0 | 2026-07-05 | minor | Machine envelope: every invocation now ends with a fixed JSON block (state, unit, phase, pr, findings, blockers, dependencies, next + model-tier hint) for programmatic orchestration — schema in the internal `orchestration-envelope` skill, protocol in `docs/workflow/ORCHESTRATION.md`. |

README.es.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@ así que **nunca se requiere una skill de revisión externa**, en ningún agente
8080
con ningún modelo. Un único camino disciplinado:
8181
**design → plan → execute → review → audit → merge.**
8282

83+
> Las formas de invocación y flags de cada skill (`--fix`, `--force`,
84+
> `--adversarial N`, `--next`, `--fullauto`, …) están catalogadas en la
85+
> [referencia de invocación y argumentos](docs/workflow/SKILLS.md#invocation--arguments-reference)
86+
> (en inglés; su traducción llega con [#37](https://github.com/gtrabanco/agentic-workflow/issues/37)).
87+
8388
### Configuración inicial
8489

8590
| Skill | Qué hace |

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@ engine, the `orchestration-envelope` contract, and the workflow's **own 9-skill
7878
review skill is ever required**, on any agent, with any model. One disciplined
7979
path: **design → plan → execute → review → audit → merge.**
8080

81+
> Every skill's invocation forms and flags (`--fix`, `--force`,
82+
> `--adversarial N`, `--next`, `--fullauto`, …) are catalogued in the
83+
> [Invocation & arguments reference](docs/workflow/SKILLS.md#invocation--arguments-reference).
84+
8185
### Setup
8286

8387
| Skill | What it does |

docs/workflow/SKILLS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,31 @@ sensor, and the repo-only `bump-skill` maintenance helper.
9999
|---|---|
100100
| `bump-skill` | After editing a SKILL.md: bump `version:`, add CHANGELOG.md + CHANGELOG.es.md rows, update the README skill/model tables. Repo-only — its description keeps it from triggering in other projects |
101101

102+
## Invocation & arguments reference
103+
104+
Every user-invocable skill's invocation forms and what each argument/flag does
105+
— the human-readable mirror of each skill's `argument-hint` frontmatter.
106+
Brackets `[…]` = optional; `|` separates alternative forms. A skill invoked
107+
with no arguments uses the default stated here.
108+
109+
| Skill | Invocation | Arguments & flags |
110+
|---|---|---|
111+
| `audit-docs` | `/audit-docs [--fix]` | No args: report-only, findings ranked by severity. `--fix`: additionally applies the **low-risk** fixes — docs are never rewritten without it (or an explicit user go-ahead). |
112+
| `audit-pr` | `/audit-pr [pr-number]` | Defaults to the current branch's PR. A number targets another PR. |
113+
| `bump-skill` | `/bump-skill` | No arguments — detects the edited `SKILL.md` files itself. Repo-maintenance only. |
114+
| `design-feature` | `/design-feature <idea \| NN-slug> [instruction]` | A raw idea → interview from zero. A bare existing `NN-slug`**review mode**: prints a summary of what the feature will do and asks what to add/remove/change. `NN-slug + instruction` → applies the change directly, no questions, scoped to the instruction. Upsert always — the only from-zero reset is an explicit "delete and redesign" in the instruction. |
115+
| `execute-phase` | `/execute-phase <NN> [P<k>] \| --fix <n> [P<k>] \| [--force]` | `NN` alone → single-pass (XS/S SPEC-only features). `NN P<k>` → exactly one phase of an M/L feature. `--fix <n>` → implement the fix unit `docs/fix/<n>-*`. `--force` → override the dependency/status gate (user-only escape hatch; the override is recorded in `decisions.md`; the autopilot never passes it). |
116+
| `generate-docs` | `/generate-docs [NN-slug \| fix-n \| path/glob] [--review]` | Scope defaults to the current branch's diff vs the default branch; a slug/fix/path narrows or redirects it. `--review` → additionally export the most recent `review-change` report as a docs page (opt-in, never automatic). |
117+
| `init-workspace` | `/init-workspace [target-dir]` | Defaults to the current directory. On a repo that already has the scaffold it auto-switches to **upgrade mode** (proposes only the new/missing template blocks; additive-only). |
118+
| `log-session` | `/log-session [note]` | The optional note is prepended to the entry's Summary. |
119+
| `plan-feature` | `/plan-feature <NN-slug \| #N> \| --from-issue N \| --scaffold <slug> \| --next` | A slug or issue reference is auto-detected; flags force a path: `--from-issue N` (issue → scoped product half), `--scaffold <slug>` (straight to engineering-half scaffolding), `--next` (next roadmap entry). An undesigned feature (roadmap row below `defined`) → stops and redirects to `/design-feature` — no bypass flag. |
120+
| `plan-fix` | `/plan-fix <issue-number>` | Required. Drafts `docs/fix/<n>-<topic>/SPEC.md` on a fix branch and stops for review. |
121+
| `product-audit` | `/product-audit [path-or-area]` | Defaults to the whole product; a path/area narrows the sweep. Proposes only — never fixes. |
122+
| `review-change` | `/review-change [path-or-glob] [--adversarial N]` | Defaults to the current change (branch diff vs the default branch); a path widens/narrows. `--adversarial N` → N independent, context-clean, diff-only adversarial reviewers in parallel, findings merged and deduped (opt-in; auto-recommended for `L`/sensitive changes). |
123+
| `ship-roadmap` | `/ship-roadmap [--fullauto]` · `/ship-roadmap --continue [--fullauto]` | Default: opens PRs, the human merges. `--fullauto` → merges MERGE-READY PRs under the non-negotiable safety floors. `--continue` → resume an existing run by one stage (the external-driver loop re-invokes this). |
124+
| `triage-issue` | `/triage-issue <n> [n…]` | One or many issue numbers — batch runs produce independent verdicts plus one summary table. |
125+
| `workflow-status` | `/workflow-status [--json-only] [--last-envelope <json\|path>]` | Default: human summary + the machine envelope. `--json-only` → envelope only (driver mode). `--last-envelope` → the driver's persisted envelope as a crash-recovery **hint** (diffed against recomputed state; never authoritative). No argument passing on your agent? Paste the JSON in the message — the last fenced json block of the *request* is read as the hint. |
126+
102127
## Built-in companions (Claude Code)
103128

104129
`/code-review` (correctness + simplification), `/security-review` (security pass),

skills/audit-docs/SKILL.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
name: audit-docs
33
user-invocable: true
4-
version: 2.0.0
4+
version: 2.0.1
5+
argument-hint: "[--fix]"
56
author: "Gabriel Trabanco <gtrabanco@users.noreply.github.com>"
67
license: MIT
78
description: >

0 commit comments

Comments
 (0)