Skip to content

v0.17.0 — /architect:generate-docs: README/docs for generated and implemented code

Choose a tag to compare

@wfukatsu wfukatsu released this 25 Jul 12:05
· 267 commits to main since this release

Code was being emitted by the codegen skills and by implement-backlog with nothing producing the README/docs/ that describe it. /architect:generate-docs fills that step and has a fixed place in both paths. The architect plugin is now 50 skills.

Added — /architect:generate-docs

/architect:generate-docs [target] [--scope=changed|service|repo] [--source-root=<path>]
                         [--readme-only] [--issue=<id>] [--dry-run] [--auto] [--lang=en|ja]

Two modes

Mode Trigger Code location Commits?
Scaffold after generate-scalardb-code / generate-infra-code / /product:generate-frontend generated/ No — the tree is regenerable
Delivery Step 5b of implement-backlog, or --issue=<id> the resolved source_root, on the working branch Yes — docs reach the same PR/MR as the code

Delivery mode reuses the git check-ignore / in-worktree checks: documentation that git ignores cannot reach a PR.

Updates in place — ownership markers (<!-- nexus:begin:<section> --><!-- nexus:end:<section> -->) scope regeneration to this skill's own regions. Human-authored prose is preserved, and an unmarked hand-written README is never rewritten in place without confirmation. Section keys (overview, build-and-run, configuration, layout, api, operations, traceability) are stable, so a later run updates the same region.

Documents what exists — content is derived from the actual code, build files and configuration; the design reports supply only the why. A verification step checks every documented build/run/test command against a real build target, resolves every link and path, rejects config keys and routes absent from the code inventory, and reports design-vs-code drift as a finding (appended to the Issue in delivery mode) instead of smoothing it over in prose.

Cost-tiered execution — a thin sonnet orchestrator holding digests rather than sources:

Step Work Model
1 code inventory (entry points, build targets, config keys, routes, env vars) haiku
2 design-intent extraction from the reports haiku
4 write/update one README or docs page sonnet, one per page, in parallel
5 verify commands, links, and design-vs-code drift haiku

opus is used only for judgment-heavy design prose (2PC boundaries, consistency model, failure/recovery semantics).

Changed — workflow integration

  • implement-backlog gains Step 5b, between implement and review: it runs generate-docs --scope=changed --source-root=<resolved> --issue=<iid> and commits the doc changes to the same working branch, so code and documentation are reviewed and merged together in one PR/MR. Skipping is allowed only when the item changes no documented surface, and must be justified in the progress comment.
  • deliver-backlog — stage (a) notes that the implement step carries the README/docs/ updates into the same PR/MR.
  • generate-scalardb-code, generate-infra-code and /product:generate-frontend point downstream to it; the CLAUDE.md manual extension tier records the fixed generate code → generate-docs ordering. AGENTS.md, README.md and docs/skill-reference{,_ja}.md are synced.

Full changelog: CHANGELOG.md · CHANGELOG_ja.md