ia-compound-docs

Documenting a debugging session for team reuse requires capturing the resolved problem, investigation context, and root cause. A validated knowledge-base entry is created by gathering the module, symptoms, and fix steps into a structured markdown artifact.

Writing post-mortem documentation that prevents repeating solved bugs involves a 7-step capture workflow. It records the exact errors, investigation attempts, and prevention steps, converting confirmed fixes into searchable team knowledge.

YAML frontmatter validation for engineering post-mortem docs works by applying a schema validator before creating a new artifact. It enforces strict metadata structure and blocks progress with prompts when critical context is missing.

You can cross-reference related issues when creating a knowledge-base entry for a resolved engineering problem. The process optionally links existing documentation during the creation of a single markdown file in the appropriate solutions category.

You need to confirm a fix before documenting it as a team knowledge-base entry. The capture workflow applies after you verify the solution worked, ensuring only validated resolutions and institutional knowledge are recorded for future reuse.

If critical context is missing when documenting a resolved bug, quality gates block progress. The workflow uses blocking prompts to require the necessary investigation details before allowing the creation of a new docs/solutions artifact.