sync-docs

Synchronizes project documentation files with the current codebase state after code changes.

Updated Mar 26, 2026
One-click install
npx skills add https://github.com/levori119/skyboard --skill sync-docs-levori119
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/levori119/skyboard/tree/main/.claude/skills/sync-docs
Command: npx skills add https://github.com/levori119/skyboard --skill sync-docs-levori119

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Project documentation drifts out of sync with the actual code as modules, API routes, database schemas, and domain terms change. This Skill audits the SKY-KING codebase and updates all documentation files (SERVICES, ARCHITECTURE, REFACTOR_LOG, data-model, DEV_GUIDE, README, CLAUDE) so they accurately reflect the current implementation. ## Core Features & Use Cases - Codebase State Collection: Runs shell commands to enumerate frontend modules, count backend routes per file, and total API endpoints for accurate figures. - Per-Document Checklists: Walks through seven documentation files with targeted checks, including regenerating the full endpoint catalog appendix in SERVICES.md from route definitions. - Change Logging: Appends dated entries to REFACTOR_LOG.md and updates the memory file when the structure changes significantly. - Use Case: After adding a new Express route and a React component, run this Skill to regenerate the endpoint appendix, update module catalogs, and log the change with exact route counts pulled from the code. ## Quick Start Ask the assistant to run the sync-docs skill to audit the codebase and update all project documentation to match the current code.

Frequently Asked Questions about sync-docs

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

FAQPage Schema
How do I keep project documentation in sync with code changes?

Run this documentation sync workflow after each batch of code changes. It collects the current module list and route counts via shell commands, then updates each documentation file only where content actually changed, preserving existing formatting.

How to generate an API endpoint catalog from Express routes?

The skill greps server route files for router.get, post, put, delete, and patch definitions, then formats them into a sorted endpoint appendix. This output replaces the existing endpoint catalog section in SERVICES.md.

When should documentation synchronization be run?

Run it after adding, removing, or renaming files in src/ or server/, after API endpoint or database schema changes, after introducing new domain terms, or routinely every three to five significant code operations.

Does documentation sync rewrite entire documents?

No, it updates only sections that actually changed and forbids regenerating whole documents unnecessarily. All numbers such as line counts and route totals must be extracted from the code rather than estimated.

What are the limitations of automated documentation sync?

It depends on shell access to run find, grep, and wc commands against the repository, and it targets a fixed set of Markdown files. Projects with different documentation layouts would need the checklist steps adapted.