pi-maestro-flow 0.2.0

package/skills/maestro-companion/SKILL.md

@@ -0,0 +1,536 @@
+---
+name: maestro-companion
+description: "Knowledge companion — load context, record companion doc, capture insights, route to skills Arguments: [before|note|after|route] [--task <description>] [--type <task_type>] [--category <cat>]"
+allowed-tools: Read Write Edit Bash Glob Grep Skill AskUserQuestion
+---
+
+<purpose>
+Side-car utility for any task: load knowledge context (before), record structured entries (note),
+promote insights to spec/knowhow (after), or route to next command (route).
+</purpose>
+
+<context>
+$ARGUMENTS — mode + optional flags.
+
+**Mode detection priority:**
+1. Explicit `before` / `note` / `after` / `route`
+2. Intent text that is not a mode keyword → `route`
+3. No arguments → auto-detect (`git status` has changes → `after`, else → `before`)
+
+**Flags:**
+- `--task <description>` — Current task description (for targeted knowledge loading and doc title)
+- `--type <task_type>` — Task type for field template selection (see task types below)
+- `--category <cat>` — Spec category filter: coding / arch / test / review / debug / learning / ui
+
+**Task types** (determines which recording sections are active):
+
+| Type | Description | Key sections |
+|------|-------------|--------------|
+| `implement` | Feature development, code writing | working_files, dependencies, decisions, tests_affected |
+| `debug` | Bug investigation, root cause analysis | symptoms, hypotheses, evidence, root_cause, fix_applied |
+| `analyze` | Code/architecture/performance analysis | scope, findings, risks, recommendations |
+| `design` | Architecture/UI/API design | constraints, alternatives, trade_offs, chosen_approach |
+| `plan` | Task decomposition, roadmap planning | goals, breakdown, estimates, dependencies |
+| `review` | Code review, PR review | files_reviewed, findings, severity_counts, verdict |
+| `test` | Test writing, UAT, coverage expansion | coverage_before, coverage_after, gaps, test_files |
+| `refactor` | Code restructuring, tech debt | affected_modules, before_after, breaking_changes |
+| `learn` | Codebase exploration, knowledge building | questions, answers, mental_model, references |
+| `general` | Default / unclassified | (all universal sections) |
+
+Auto-detection: if `--type` not provided, infer from `--task` description keywords.
+
+**Output boundary**: ALL file writes MUST target `.workflow/.scratchpad/` (companion docs + `.companion-active` pointer) only. Promotion writes (spec/knowhow) are delegated to `spec-add` / `manage-knowhow-capture` skills. NEVER modify source code, `.workflow/state.json`, or files outside `.workflow/.scratchpad/`.
+
+**Companion document:**
+- Path: `.workflow/.scratchpad/companion-{YYYYMMDD-HHmmss}.md`
+- Active doc tracking: `.workflow/.scratchpad/.companion-active` (stores path of current companion doc)
+- Format: YAML frontmatter (rich metadata) + typed sections + timestamped entries
+</context>
+
+<invariants>
+1. **No session creation** — companion NEVER creates workflow sessions, NEVER writes to state.json
+2. **Side-car only** — companion MUST NOT modify source code or execute implementation tasks; it is strictly a knowledge loading + recording utility
+3. **One active doc** — only one `.companion-active` pointer SHALL exist at a time; creating a new companion doc MUST clear any stale pointer
+4. **Append-only entries** — note mode MUST append entries; NEVER overwrite or reorder existing entries
+5. **Promotion via delegation** — spec/knowhow promotion MUST route through `spec-add` / `manage-knowhow-capture` skills; companion NEVER writes directly to `.workflow/specs/` or `.workflow/knowhow/`
+6. **Type-template integrity** — context template sections MUST match the resolved `task_type`; NEVER mix templates from different types
+</invariants>
+
+<state_machine>
+
+<states>
+S_PARSE    — Parse arguments, detect mode, resolve task type
+S_BEFORE   — Load knowledge context, create companion doc with typed template
+S_NOTE     — Append structured entry to active companion doc
+S_AFTER    — Review companion doc, populate outcome, promote entries, suggest next steps
+S_ROUTE    — Skill routing via maestro-next
+</states>
+
+<transitions>
+
+S_PARSE:
+  → S_BEFORE   WHEN: mode == "before" OR (no args AND no uncommitted changes)
+  → S_NOTE     WHEN: mode == "note"
+  → S_AFTER    WHEN: mode == "after" OR (no args AND has uncommitted changes)
+  → S_ROUTE    WHEN: mode == "route" OR intent text present
+
+</transitions>
+
+</state_machine>
+
+<execution>
+
+## S_BEFORE — Knowledge Loading + Companion Doc Creation
+
+Execute in order, skip unavailable steps:
+
+### 1. Load specs
+
+```bash
+# With --category: load by category
+maestro load --type spec --category <cat>
+
+# With --task: load by keyword extracted from task description
+maestro load --type spec --keyword <extracted_keyword>
+
+# No flags: load coding (most universal)
+maestro load --type spec --category coding
+```
+
+Display loaded rules summary (entry count + key rule names).
+
+### 2. Browse knowhow index
+
+```bash
+# List recent knowhow entries
+maestro knowhow list --store workflow
+
+# With --task: search relevant entries
+maestro search --type knowhow "<task_keyword>"
+```
+
+Display available knowhow entries (ID + title). Hint: `maestro load --type knowhow --id <id>` for details.
+
+### 3. Check codebase index
+
+```bash
+ls .workflow/codebase/doc-index.json
+```
+
+- Exists → display "Codebase docs ready, last updated: {timestamp}"
+- Missing → suggest `/manage-codebase-rebuild`
+- Stale (>7 days) → suggest `/quality-sync`
+
+### 4. Create companion document
+
+Create `.workflow/.scratchpad/` if needed. Resolve task type from `--type` flag or infer from `--task` keywords.
+
+Write companion doc with the full field template:
+
+```markdown
+---
+# === Identity ===
+task: "{task_description or 'Untitled task'}"
+task_type: "{resolved type: implement|debug|analyze|design|plan|review|test|refactor|learn|general}"
+created: "{ISO timestamp}"
+status: active
+
+# === Context Loaded ===
+specs_loaded: "{category or 'coding'}"
+specs_count: {N}
+knowhow_searched: "{keyword or 'none'}"
+knowhow_available: {M}
+codebase_index: "{ready|missing|stale}"
+branch: "{current git branch}"
+phase: "{current phase from state.json or 'none'}"
+milestone: "{current milestone from state.json or 'none'}"
+
+# === Scope ===
+working_files: []
+dependencies: []
+related_artifacts: []
+
+# === Outcome (populated by after mode) ===
+outcome: ""
+files_changed: []
+promoted_specs: 0
+promoted_knowhow: 0
+follow_up: []
+completed: ""
+---
+
+# Companion Doc — {task_description}
+
+> `/maestro-companion note "<content>"` — add entries
+> `/maestro-companion after` — review, promote, close
+
+## Context
+
+{Type-specific context section — see templates below}
+
+## Entries
+
+## Summary
+```
+
+**Type-specific context templates** (written into `## Context`):
+
+**implement:**
+```markdown
+### Working Files
+| File | Role | Status |
+|------|------|--------|
+
+### Dependencies
+- (modules, APIs, or services this task depends on)
+
+### Decisions
+| # | Decision | Rationale | Alternatives Considered |
+|---|----------|-----------|------------------------|
+
+### Tests Affected
+- (test files that need creation or update)
+```
+
+**debug:**
+```markdown
+### Symptoms
+- (observable behavior vs expected behavior)
+
+### Hypotheses
+| # | Hypothesis | Status | Evidence |
+|---|-----------|--------|----------|
+
+### Evidence Trail
+| Time | Source | Type | Finding |
+|------|--------|------|---------|
+
+### Root Cause
+- (populated when identified)
+
+### Fix Applied
+- (description of fix, files changed)
+```
+
+**analyze:**
+```markdown
+### Scope
+- (what is being analyzed and boundaries)
+
+### Findings
+| # | Finding | Severity | Location |
+|---|---------|----------|----------|
+
+### Risks
+- (identified risks or concerns)
+
+### Recommendations
+- (actionable recommendations)
+```
+
+**design:**
+```markdown
+### Constraints
+- (hard limits, requirements, compatibility needs)
+
+### Alternatives
+| # | Approach | Pros | Cons |
+|---|----------|------|------|
+
+### Trade-offs
+- (key trade-off decisions and rationale)
+
+### Chosen Approach
+- (selected design with justification)
+```
+
+**plan:**
+```markdown
+### Goals
+- (what success looks like)
+
+### Breakdown
+| # | Task | Estimate | Depends On | Status |
+|---|------|----------|------------|--------|
+
+### Dependencies
+- (external dependencies, blockers, prerequisites)
+```
+
+**review:**
+```markdown
+### Files Reviewed
+| File | Lines | Findings |
+|------|-------|----------|
+
+### Findings
+| # | Severity | Category | File:Line | Description |
+|---|----------|----------|-----------|-------------|
+
+### Verdict
+- (pass / pass-with-concerns / fail)
+```
+
+**test:**
+```markdown
+### Coverage
+- Before: {%}
+- After: {%}
+- Target: {%}
+
+### Test Files
+| File | Type | Tests Added | Status |
+|------|------|------------|--------|
+
+### Gaps
+- (uncovered paths or scenarios)
+```
+
+**refactor:**
+```markdown
+### Affected Modules
+- (modules being restructured)
+
+### Before / After
+| Aspect | Before | After |
+|--------|--------|-------|
+
+### Breaking Changes
+- (API or behavior changes that affect consumers)
+```
+
+**learn:**
+```markdown
+### Questions
+| # | Question | Answered | Source |
+|---|----------|----------|--------|
+
+### Mental Model
+- (evolving understanding of how it works)
+
+### References
+- (files, docs, wiki entries consulted)
+```
+
+**general:**
+```markdown
+### Notes
+- (general working notes)
+```
+
+Write the companion doc path to `.workflow/.scratchpad/.companion-active`.
+
+### 5. Output summary card
+
+```
+Knowledge context loaded
+  Spec:     {N} rules ({category})
+  Knowhow:  {M} entries available
+  Codebase: {status}
+  Doc:      {companion_doc_path} [{task_type}]
+
+Mid-task commands:
+  /maestro-companion note "finding or decision"
+  /maestro-companion note --file src/auth.ts "changed token validation"
+  /spec-load --keyword <keyword>
+  maestro search "<query>"
+```
+
+---
+
+## S_NOTE — Append Structured Entry to Companion Doc
+
+### 1. Locate active companion doc
+
+Read `.workflow/.scratchpad/.companion-active` to get the doc path.
+If missing or file not found → create a new companion doc (same as S_BEFORE step 4, minimal — no spec/knowhow loading).
+
+### 2. Parse entry content and flags
+
+Parse $ARGUMENTS after `note` keyword:
+- `--file <path>` — associate entry with a specific file (appended to frontmatter `working_files`)
+- `--severity <level>` — for findings: critical / high / medium / low
+- Remaining text = entry content
+
+### 3. Classify entry type
+
+Auto-classify from content signals:
+
+| Content signal | Type tag |
+|---------------|----------|
+| "decided/decision/chose/picked/went with" | `decision` |
+| "pattern/convention/rule/always/never/must" | `spec-candidate` |
+| "pitfall/gotcha/careful/warning/trap/beware" | `pitfall` |
+| "learned/realized/discovered/understood/turns out" | `insight` |
+| "hypothesis/suspect/might be/could be" | `hypothesis` |
+| "found bug/root cause/because of/caused by" | `evidence` |
+| "risk/concern/worry/might break" | `risk` |
+| "todo/need to/should also/follow up/remaining" | `todo` |
+| "question/why does/how does/unclear" | `question` |
+| "blocked/stuck/can't/impossible" | `blocker` |
+| Default | `note` |
+
+### 4. Append entry
+
+Append to the companion doc under `## Entries`:
+
+```markdown
+### [{type}] {HH:mm} — {first line of content}
+
+{full content}
+
+{if --file: **File:** `{path}`}
+{if --severity: **Severity:** {level}}
+```
+
+### 5. Update frontmatter fields
+
+- If `--file` provided and not already in `working_files` → append to `working_files`
+- If type is `decision` → also append row to `### Decisions` table (if implement/design type doc)
+- If type is `hypothesis` → also append row to `### Hypotheses` table (if debug type doc)
+- If type is `evidence` → also append row to `### Evidence Trail` table (if debug type doc)
+- If type is `risk` → also append to `### Risks` list (if analyze/design type doc)
+- If type is `question` → also append row to `### Questions` table (if learn type doc)
+
+### 6. Confirm
+
+```
+[{type}] entry added to companion doc
+  /maestro-companion note "..."  — add more
+  /maestro-companion after       — review & promote
+```
+
+---
+
+## S_AFTER — Review Companion Doc + Populate Outcome + Promote Entries + Route
+
+### 1. Load companion doc
+
+Read `.workflow/.scratchpad/.companion-active` → read the companion doc.
+If no active doc or doc is empty → skip to step 4 (accumulation reminder).
+
+### 2. Populate outcome fields
+
+Collect task outcome data:
+
+```bash
+# Detect files changed since companion doc creation
+# Use git log --since for time-based filtering, then git diff for the range
+git log --since="{companion_created_timestamp}" --format="%H" -1  # get oldest commit in range
+git diff --name-only {oldest_commit}..HEAD                         # diff from that commit to HEAD
+# Fallback if no commits since timestamp: git diff --name-only HEAD
+```
+
+Update frontmatter:
+- `files_changed` — from git diff
+- `completed` — current ISO timestamp
+- `status` — `completed`
+
+Display entry summary:
+```
+Companion doc review — {task_type}
+  Entries:    {total} ({by type breakdown})
+  Files:      {files_changed count} changed
+  Duration:   {elapsed since created}
+
+Promotable entries:
+  {list of decision/spec-candidate/pitfall/insight entries}
+```
+
+### 3. Promote entries
+
+If promotable entries exist, AskUserQuestion:
+
+- Option 1: "Promote to spec" — short coding/arch/test constraint
+- Option 2: "Promote to knowhow" — detailed recipe/template/decision/tip
+- Option 3: "Promote both" — spec index entry + knowhow document
+- Option 4: "Skip — nothing to promote"
+
+**Routing by selection:**
+
+| Selection | Action |
+|-----------|--------|
+| Spec | `Skill("spec-add", args)` — guide user through category + content |
+| Knowhow | `Skill("manage-knowhow-capture", args)` — guide through type + content |
+| Both | `Skill("spec-add")` first, then `Skill("manage-knowhow-capture")` |
+| Skip | Proceed to step 4 |
+
+Update frontmatter: `promoted_specs`, `promoted_knowhow` counts.
+
+Extract any `todo` entries → write to `follow_up` in frontmatter.
+
+Clear `.workflow/.scratchpad/.companion-active`.
+
+### 4. Output accumulation reminder + routing
+
+```
+Knowledge accumulation reminders:
+  Reusable pattern found?        /spec-add <category> "title" "content" --description "summary"
+  Solved a complex problem?      /manage-knowhow-capture recipe "description"
+  Made an architecture decision? /manage-knowhow-capture decision "description"
+  Discovered a useful trick?     /manage-knowhow-capture tip "content"
+
+Next steps:
+  /maestro-next          — recommend next command
+  /maestro "<intent>"    — route intent to full workflow
+  /manage-status         — view project dashboard
+```
+
+---
+
+## S_ROUTE — Skill Routing
+
+### 1. Parse intent
+
+Extract intent text from $ARGUMENTS after removing the `route` keyword.
+
+### 2. Delegate to maestro-next
+
+```
+Skill("maestro-next", "<intent_text>")
+```
+
+Delegates intent routing to maestro-next, which recommends the best single command.
+
+</execution>
+
+<error_codes>
+| Code | Severity | Condition | Recovery |
+|------|----------|-----------|----------|
+| W001 | warning | `.workflow/specs/` not initialized | Suggest `/spec-setup` |
+| W002 | warning | `.workflow/knowhow/` is empty | Normal, skip knowhow index |
+| W003 | warning | `.workflow/codebase/` does not exist | Suggest `/manage-codebase-rebuild` |
+| W004 | warning | No active companion doc found (note/after mode) | Create new doc or skip |
+</error_codes>
+
+<success_criteria>
+- [ ] Mode correctly detected (before/note/after/route)
+- [ ] Task type resolved from --type flag or inferred from --task keywords
+- [ ] before: spec + knowhow + codebase indexes loaded or hints given
+- [ ] before: companion doc created with full YAML frontmatter (identity + context + scope + outcome placeholders)
+- [ ] before: type-specific context template written (matching task_type)
+- [ ] before: active doc path written to `.companion-active`
+- [ ] before: summary card output with mid-task command hints
+- [ ] note: active companion doc located and entry appended with type tag
+- [ ] note: entry type auto-classified from content signals (11 type tags)
+- [ ] note: --file flag updates working_files in frontmatter
+- [ ] note: typed entries cross-posted to matching context tables (decisions→Decisions, hypothesis→Hypotheses, etc.)
+- [ ] after: companion doc entries reviewed and promotable items identified
+- [ ] after: outcome fields populated (files_changed, completed, status)
+- [ ] after: AskUserQuestion routes to spec-add or manage-knowhow-capture
+- [ ] after: todo entries extracted to follow_up field
+- [ ] after: companion doc marked completed, active pointer cleared
+- [ ] after: accumulation reminder + next-step routing displayed
+- [ ] route: intent correctly forwarded to maestro-next
+- [ ] No session created, no state.json modified
+</success_criteria>
+
+<completion>
+### Next-step routing
+| Condition | Suggestion |
+|-----------|-----------|
+| Reusable pattern found | `/spec-add <category> "title" "content"` |
+| Solved complex problem | `/manage-knowhow-capture recipe "description"` |
+| Architecture decision made | `/manage-knowhow-capture decision "description"` |
+| Want next command recommendation | `/maestro-next` |
+</completion>