doc-enricher

What problem does it solve?

This Skill automates the process of identifying and recommending persistent, high-impact knowledge to be documented in directory READMEs, streamlining future code understanding and review.

Core Features & Use Cases

• Knowledge Identification: Automatically identifies and suggests knowledge that is highly relevant and durable for documentation.
• User Approval Workflow: Only updates READMEs after user approval, ensuring accuracy and minimizing errors.
• Documentation Placement: Ensures that documentation is placed at the appropriate abstract level, improving maintainability.
• Use Case: After completing code reviews or tasks, use this Skill to automatically generate documentation suggestions that can be reviewed and approved by the user.

Quick Start

Run the doc-enricher skill on a completed task to generate documentation suggestions for the directory README.