Compound Docs FAQs

Question 1

How does Compound Docs detect when a problem is solved?

Accepted Answer

The skill monitors for confirmation phrases like 'that worked', 'it's fixed', or 'problem solved', and can also be triggered manually using the /doc-fix or /compound commands.

Question 2

Where are the documentation files stored?

Accepted Answer

Files are stored within your repository in the .ai/docs/solutions/ directory, organized into subfolders based on the specific category of the problem.

Question 3

What happens if a similar problem has already been documented?

Accepted Answer

During the capture process, the skill searches your existing documentation. If a match is found, it prompts you to either create a cross-reference, update the existing doc, or link them as related issues.

Question 4

What kind of metadata does it capture?

Accepted Answer

It uses a validated YAML frontmatter to track module names, symptoms, root causes, investigation steps, environment details (like Rails version), and problem severity.

Question 5

Can I promote a specific fix to a 'Critical Pattern'?

Accepted Answer

Yes. After documentation, the skill provides a decision menu where you can choose to promote the solution to a critical pattern file that AI agents are required to read before generating code.

Compound Docs

Key Features

Use Cases

Compound Docs

Key Features

Use Cases