workflow-docs

To automatically sync project documentation, this Skill parses PRD, MVP, ADR, and CLAUDE.md files to generate standardized README and AI-summary outputs. It uses marker-fenced regions to preserve manual edits while keeping documentation consistent with your project artifacts.

You can generate a README from existing PRD and ADR files by running the Skill from the root of your git-initialized repository. It dynamically includes or omits sections based on the presence of source data, ensuring the output is never filled with stale placeholders.

Documentation synchronization works with non-software projects managed via GitHub and Claude Code. The Skill applies to any project context as long as the repository is git-initialized and contains the relevant design artifacts like PRDs and MVPs.

Automated README generation will not overwrite your manual edits because the Skill uses marker-fenced regions. This mechanism protects specific sections while dynamically updating and refreshing the rest of the documentation based on your latest project artifacts.

The best way to prevent documentation drift is to automatically synchronize project-level README and AI-summary files with existing artifacts. By parsing source files like PRDs and ADRs, this approach ensures project metadata remains consistent without manual copy-pasting.

Documentation generation requires a git-initialized repository to correctly locate and parse your project's design artifacts. Without this environment setup, the Skill cannot accurately read the necessary PRD, MVP, and ADR files to generate the standardized outputs.