doc-enricher

Directory README enhancement automatically identifies and suggests high-leverage, durable knowledge for documentation after completing code reviews or tasks. It generates recommendations within a user approval workflow to ensure accuracy before updating files.

High-impact knowledge identification analyzes completed tasks to extract persistent, highly relevant information. It ensures documentation placement occurs at the appropriate abstract level, streamlining future code understanding and improving maintainability.

Python is required to generate README documentation suggestions. The skill relies on Python scripts to perform the underlying analysis and suggestion generation for identifying high-leverage knowledge within your code review workflows.

Yes, a predefined user approval workflow ensures you can review and approve all documentation suggestions. READMEs are only updated after your explicit approval, minimizing errors and maintaining documentation accuracy.

Directory documentation enhancement integrates directly into code review and task completion workflows. Run it on a completed task to automatically generate relevant documentation suggestions for the directory README.

Avoid automating directory README enhancement when immediate, unreviewed file updates are required. The predefined user approval workflow necessitates manual review, which may bottleneck processes needing instantaneous documentation changes.