← Files Compound EngineeringARCHIVED FILE
skills/ce-compound/references/report.md
6.56 KB · Oct 5, 2026 · 18:34 UTC
# Completion reports ## Success Output **User-runnable refresh rendering.** The reports below print a `ce-compound-refresh` invocation for the user to copy. Default to `/ce-compound-refresh <scope>`; use `$ce-compound-refresh <scope>` only when the active host is Codex or explicitly documents dollar-prefixed skill invocation. Render only the invocation as inline code and output one form only. ### Non-interactive mode Emit a structured terminal report and end the turn. No "What's next?" question, no blocking prompt. End with `Documentation complete` as the terminal signal so callers can detect completion. For `depth:lightweight`, use this lower-overhead report after the Lightweight Mode workflow: ``` ✓ Documentation complete (non-interactive lightweight mode) File: <root>/solutions/<category>/<filename>.md (created | updated) Track: <bug | knowledge> Category: <category> Grounding: <mechanical check clean | N flags adjudicated> Discoverability: <no gap | gap noted — instruction-file tip emitted | not applicable — no active project instructions> CONCEPTS.md: <not present | scanned, no qualifying terms | updated — N added, N refined, N folded, N scrubbed> CONCEPTS.md discoverability: <not checked — CONCEPTS.md unchanged | no gap | gap noted — instruction-file tip emitted | not applicable — no active project instructions> Refresh recommendation: <none | scope hint for /ce-compound-refresh> Documentation complete ``` For `depth:full` or backward-compatible non-interactive calls with no depth token, use the Full report: ``` ✓ Documentation complete (non-interactive mode) File: <root>/solutions/<category>/<filename>.md (created | updated) Track: <bug | knowledge> Category: <category> Overlap: <none | low | moderate — see <path> | high — existing doc updated> Grounding: <clean | N flags adjudicated (X fixed, Y annotated, Z confirmed) | N claims softened or corrected | degraded — merge-state claims unverified offline> Instruction-file edit: <none needed | gap noted, not applied> CONCEPTS.md: <scanned, no qualifying terms | created with N entries (M seeded from the learning's area) | updated — N added, N refined, N folded, N scrubbed> Refresh recommendation: <none | scope hint for /ce-compound-refresh> Documentation complete ``` When no doc was written (e.g., non-interactive invoked on a session where the problem is not yet solved), emit a structured failure instead and end with `Documentation skipped` so callers can distinguish success from no-op: ``` ✗ Documentation skipped (non-interactive mode) Reason: <one-sentence explanation — e.g., "no solved problem detected in conversation history" or "solution not yet verified"> Documentation skipped ``` ### Interactive mode ``` ✓ Documentation complete Ran Full mode. Auto memory: 2 relevant entries used as supplementary evidence Subagent Results: ✓ Context Analyzer: Identified performance_issue in background_job (component from corpus), category: performance-issues/ ✓ Solution Extractor: 3 code fixes, prevention strategies ✓ Related Docs Finder: 2 related issues ✓ Session History: 3 prior sessions on same branch, 2 failed approaches surfaced Grounding Validation: ✓ Mechanical check: 14 paths, 2 SHAs, 3 links checked — 1 flag annotated as historical ✓ Semantic validator: 9 claims verified, 1 merge-state claim softened to pending Specialized Agent Reviews (Auto-Triggered): ✓ performance-oracle: Validated query optimization approach ✓ Code simplification review: Code examples are appropriately minimal Files written: - <root>/solutions/performance-issues/n-plus-one-brief-generation.md (created) - CONCEPTS.md (created with 3 entries: BriefSystem, EmailQueue, Brief Status) This documentation will be searchable for future reference when similar issues occur in the Email Processing or Brief System modules. Refresh recommendation: none ``` `Files written:` lists the destination the assembly step settled on — a pack rule's path (`<pack dir>/<file>.md`) when the user routed the capture into a writable pack, the `<root>/solutions/` path otherwise. **End the turn after the summary — `ce-compound` does not present a "What's next?" menu.** The doc is written and any cross-references the workflow found are already in it. Cross-doc maintenance (fixing references in *other* docs, consolidation) is deferred to `ce-compound-refresh` via the `Refresh recommendation` line above — the skill designed for it — not auto-applied here, which would edit tracked docs beyond the one deliverable. If the user wants to view the file or take a follow-up action, they will ask. (Interactive mode only.) **Alternate interactive output (when updating an existing doc due to high overlap):** in non-interactive mode, this case is communicated via the `Overlap: high — existing doc updated` line of the non-interactive terminal report above, not as a separate output block. ``` ✓ Documentation updated (existing doc refreshed with current context) Overlap detected: <root>/solutions/performance-issues/n-plus-one-queries.md Matched dimensions: problem statement, root cause, solution, referenced files Action: Updated existing doc with fresher code examples and prevention tips File updated: - <root>/solutions/performance-issues/n-plus-one-queries.md (added last_updated: 2026-03-24) ``` ## Common Mistakes to Avoid | ❌ Wrong | ✅ Correct | |----------|-----------| | Subagents write product files into `docs/` or edit tracked paths | Subagents write only scratch artifacts under `<run-dir>/` and return the path; orchestrator writes the one final doc | | Subagent returns a long prose body only as its inline response | Subagent writes full output to its run artifact; orchestrator Reads it back (inline return is fallback only) | | Research and assembly run in parallel | Research completes → then assembly runs | | Non-interactive Discoverability Check edits AGENTS.md/CLAUDE.md | non-interactive Full reports `Instruction-file edit: gap noted, not applied`; non-interactive Lightweight emits a discoverability tip; only interactive Full applies the edit after consent | | Creating a new doc when an existing doc covers the same problem | Check overlap assessment; update the existing doc when overlap is high | | Asserting code behavior or merge-state from conversation memory | Read the defining source line before asserting; cite PR numbers over SHAs; soften unverifiable claims (Phase 1 extractor rules, re-checked in Phase 2.45) | | Batching several learnings through one run and stitching cross-references between drafts | One learning per run; run the skill sequentially for each additional learning |
SHA-256: 549effaa6e62fbbb47dde5862eb5c932752b480aea09d9b68e05c4c87987ea18