compound-docs

To document solved debugging problems, you can use a skill that captures problem context, root causes, and resolutions as categorized markdown files. This builds a searchable knowledge base by organizing technical issues into structured directories with YAML frontmatter for fast lookup.

The best way to capture root causes is automating documentation immediately after a fix is confirmed. This process gathers context, validates a YAML schema, and creates structured markdown files detailing the problem, the fix, and preventative measures for future reference.

No specific dependencies or external libraries are required for this documentation automation. The skill operates independently using internal scripts, references, and assets to validate YAML schemas and generate categorized markdown files for your knowledge base.

You organize technical writing into symptom-based directories by using a validated YAML schema to categorize markdown files. This structure automatically sorts resolutions and root causes by problem type and component, enabling fast lookup and persistent knowledge storage.

You should not use automated documentation when a problem fix is not yet confirmed or when context gathering is incomplete. Accurate technical writing requires validated root causes and resolutions to ensure the generated YAML frontmatter and markdown files remain reliable for future reference.