doc-sync

Sync CLAUDE.md and .env files with live configuration and propose Git commit messages.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/mim1012/ykp_project --skill doc-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/mim1012/ykp_project/tree/main/.claude/skills/doc-sync
Command: npx skills add https://github.com/mim1012/ykp_project --skill doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that your project documentation (like CLAUDE.md and .env.example) remains consistent and up-to-date with the actual codebase and configuration. It prevents developer confusion and errors caused by outdated guides, saving time and improving onboarding.

Core Features & Use Cases

  • Documentation Validation: Checks key project documentation files against current best practices and the project's actual setup.
  • Skills Section Generation: Automatically creates or updates a list of available Claude Skills within your CLAUDE.md, including descriptions and use cases.
  • Git Commit Suggestion: Provides a pre-formatted Git commit message for documentation updates, streamlining version control and ensuring clear change logs.
  • Use Case: After adding a new Skill or making a significant change to your environment setup, this Skill can automatically update your CLAUDE.md with the new Skill's details and ensure your .env.example reflects the latest recommended local configuration, then suggest a commit message.

Quick Start

I've made some changes to the project's environment setup. Please use the doc-sync skill to update the CLAUDE.md and .env.example files.

Frequently Asked Questions about doc-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep project documentation synchronized with configuration changes?

Documentation sync automatically detects discrepancies between your CLAUDE.md, .env.example, and .env.production.example files against current codebase state. It applies updates across all three files after environment changes or skill additions, then proposes a Git commit message to track changes.

Can I automatically update CLAUDE.md with new skills and their descriptions?

Yes. The skill generates or updates a skills section in CLAUDE.md listing available Claude Skills with descriptions and use cases whenever you add new skills or request documentation updates.

What files does documentation sync target for updates?

Documentation sync focuses on three files: CLAUDE.md for project guides, .env.example for local configuration templates, and .env.production.example for production environment templates. It ensures all three stay consistent with your actual setup.

How does documentation sync prevent outdated guides and environment mismatches?

By validating documentation against current project setup and automatically detecting drift between files and codebase state, it eliminates developer confusion from outdated onboarding guides and environment configuration inconsistencies.

Does documentation sync provide version control integration?

Yes. After applying documentation updates, it generates pre-formatted Git commit messages that streamline version control, ensure clear changelogs, and provide traceability for all documentation modifications.

When should I run documentation sync in my development workflow?

Run documentation sync after adding new skills, making significant environment setup changes, or receiving requests to update docs. This ensures CLAUDE.md and environment templates reflect your current project state before committing changes.