Brummel
7f46e9c027
Third skill via the boss pattern. docwriter was the most language-coupled of the seven (Rust rustdoc, cargo doc, /// + //!, intra-doc links). Generalised the discipline while keeping Rust as the canonical concrete example, with a note that other languages substitute syntax (TSDoc, Python docstrings, Javadoc). Profile gains one slot: - `commands.doc_build` — doc-build command that prints warnings on stderr (e.g. "cargo doc --no-deps 2>&1"); used by the docwriter agent's verification triple and warning enumeration. Optional — projects without API docs omit it. Vocabulary substitutions: - AILang → "this project" - "crates" → "components / packages / crates / modules" (the project's idiom) - "milestone" → "cycle" - "Boss" → "orchestrator" - "ailang-docwriter" → "docwriter" AILang-specific bits replaced: - `cargo doc --no-deps 2>&1` → `commands.doc_build` slot - `cargo build --workspace` / `cargo test --workspace` → `commands.build` / `commands.test` slots - `crate / module / item` levels → "top-level / module-level / item-level" (the universal taxonomy; concrete syntax via language note) - `src/lib.rs` / `src/main.rs` hardcoded paths → "entry-point file" (Rust example kept inline) - `docs/` / `design/` hardcoded dirs → `paths.design_ledger`, `paths.design_contracts`, `paths.design_models`, `paths.spec_dir` slots Universal substance preserved verbatim: - Iron Law (4 lines) - Documentation rules (5 bullets) — substantive content; only the concrete-syntax examples got the Rust-as-example note - Hard limits (4 bullets) - Verification triple (build / test / doc_build) - Status protocol (DONE / DONE_WITH_CONCERNS / NEEDS_CONTEXT / BLOCKED) - All 7 Common Rationalisations rows (with vocabulary edits) - All 7 Red Flags bullets
63 lines
2.4 KiB
YAML
63 lines
2.4 KiB
YAML
# Project profile for the skills plugin.
|
|
#
|
|
# Drop a copy of this file at <project-root>/.claude/dev-cycle-profile.yml
|
|
# and edit. See ~/dev/skills/docs/profile-schema.md for the full schema
|
|
# and per-key documentation.
|
|
|
|
paths:
|
|
spec_dir: docs/specs
|
|
plan_dir: docs/plans
|
|
# design_ledger: design/INDEX.md # optional
|
|
# design_contracts: design/contracts # optional
|
|
# design_models: design/models # optional
|
|
code_roots: [src]
|
|
# bench_dir: bench # optional
|
|
|
|
naming:
|
|
counter_dirs: []
|
|
policy: flat # stable_per_directory_4digit | date_prefix | flat
|
|
slug_separator: "-"
|
|
|
|
commands:
|
|
build: "" # REQUIRED — e.g. "cargo build" or "npm run build"
|
|
test: "" # REQUIRED — e.g. "cargo test" or "npm test"
|
|
# lint: "" # optional
|
|
# doc_build: "" # e.g. "cargo doc --no-deps 2>&1" — used by docwriter
|
|
regression: [] # list of shell commands run by audit; non-zero exit = regress
|
|
|
|
vocabulary:
|
|
cycle: cycle # what a top-level work unit is called
|
|
subcycle: iteration # what a sub-unit is called
|
|
ledger_entry: contract # what one design-ledger entry is called
|
|
|
|
standing_reading:
|
|
always:
|
|
- CLAUDE.md
|
|
- "git log -10 --format=full"
|
|
by_role:
|
|
# architect: [design/contracts]
|
|
# debugger: ["git log -5 --format=full"]
|
|
|
|
git:
|
|
main_sacrosanct: true
|
|
only_orchestrator_commits: true
|
|
protected_branches: [main]
|
|
issue_tracker:
|
|
kind: none # gitea | github | linear | none
|
|
close_marker: "closes #N"
|
|
# url: "" # human-browsable issue list URL
|
|
# list_cmd: "" # e.g. "tea issues ls --repo X/Y --state open"
|
|
|
|
notifications:
|
|
# command: "" # e.g. "~/.claude/notify.sh"; boss falls back to chat if empty
|
|
|
|
pipeline:
|
|
brainstorm: { gates: [planner] }
|
|
planner: { gates: [implement] }
|
|
implement: {}
|
|
audit: { mandatory_at: cycle_close }
|
|
debug: { trigger: bug, red_first: true }
|
|
# boss: { user_invoked: true } # autonomous orchestrator mode, /boss
|
|
# fieldtest: { boss_only: true, when: surface_touch }
|
|
# docwriter: { boss_only: true, when: api_stable_across_n_cycles }
|