Compound Docs FAQs

Question 1

Can I update existing documentation instead of creating new files?

Accepted Answer

Yes, during the capture process, the skill searches for similar existing documentation and provides options to update an existing entry or create a new doc with a cross-reference.

Question 2

Where are the documentation files stored within my project?

Accepted Answer

All documentation is stored in a structured directory format under docs/solutions/, organized by categories such as performance-issues, compilation-errors, or logic-bugs.

Question 3

What is the benefit of the YAML validation gate?

Accepted Answer

The validation gate ensures every piece of documentation follows a strict schema, making the knowledge base consistent, searchable, and machine-readable for future AI-driven development sessions.

Question 4

How does Compound Docs detect when to document a problem?

Accepted Answer

The skill automatically monitors for confirmation phrases like 'that worked' or 'it's fixed' during conversation, but can also be manually triggered via the /doc-fix command.

Question 5

What happens after the documentation is successfully created?

Accepted Answer

Users are presented with a decision menu to either continue their workflow, promote the fix to a 'Critical Pattern' in Required Reading, or link it to other related technical issues.

Compound Docs

Key Features

Use Cases

Compound Docs

Key Features

Use Cases