lybtzyzs-doc-sync

What problem does it solve?

This Skill ensures that project documentation is always up-to-date with code changes, preventing outdated information that can lead to confusion, errors, and costly rework. It automates the detection of code-doc discrepancies and generates actionable update checklists.

Core Features & Use Cases

• Mandatory Pre-Checks: Enforces reading of core documentation (e.g., docs/index.md, docs/business-rules.md) before starting new requirements analysis or architecture changes, preventing work on outdated information.
• API Endpoint Change Detection: Automatically identifies new, modified, or deleted API endpoints by analyzing Git history and code, generating a checklist for updating API documentation.
• Architecture & Data Model Change Tracking: Detects changes in module structure, services, repositories, entities, DTOs, and configuration files, prompting updates to architecture and data model documentation.
• Use Case: After a Pull Request that modifies several API endpoints and a data model, this Skill automatically generates a detailed Markdown checklist of all documentation that needs updating, including specific files and suggested content changes, ensuring no documentation is missed.

Quick Start

Check if documentation needs updating after the latest code changes.