sync-docs

Name: sync-docs
Availability: InStock
Author: daisuke-tanabe

Validate documentation consistency against data models and Server Actions.

Updated Dec 28, 2023

Search Tags:#documentation #specification #code sync #server actions #consistency check #data model

Ready to run

npx skills add https://github.com/daisuke-tanabe/daisuke-tanabe --skill sync-docs-daisuke-tanabe

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/daisuke-tanabe/daisuke-tanabe/tree/main/.claude/skills/sync-docs
Command: npx skills add https://github.com/daisuke-tanabe/daisuke-tanabe --skill sync-docs-daisuke-tanabe

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that your project documentation stays perfectly aligned with your codebase, catching discrepancies that arise from implementation, renaming, or schema changes.

Core Features & Use Cases

Detects Outdated Documentation: Identifies when specifications (data models, Server Actions) no longer match the actual code.
Verifies Consistency: Checks for mismatches in table names, column names, relationships, and Server Action signatures.
Use Case: After implementing a new feature, run this skill before committing to ensure all related documentation in docs/project/ accurately reflects the code changes.

Quick Start

Use the sync-docs skill to check for inconsistencies between the documentation and the code.

Frequently Asked Questions about sync-docs

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

FAQPage Schema

How do I check if my documentation matches the codebase after schema modifications?▼

To check if documentation matches the codebase after schema modifications, validate the consistency between specification documents and actual code. This detects omissions by matching table names, column names, FK relations, and Server Action signatures.

What is the best way to detect outdated data model specifications in my project?▼

The best way to detect outdated data model specifications is to run a consistency check against your codebase. This identifies mismatches in table names, column names, UNIQUE constraints, and Server Action signatures to catch documentation update omissions.

When should I validate specification and code consistency for Server Actions?▼

You should validate specification and code consistency for Server Actions after implementation, renaming, or schema modifications. Running this check before committing ensures all related documentation in your project accurately reflects the code changes.

Can I verify foreign key relations and unique constraints against specification documents?▼

Yes, you can verify foreign key relations and unique constraints against specification documents. The consistency check requires precise matching of table and column names, FK relations, UNIQUE constraints, and Server Action signatures to detect discrepancies.

Does the documentation consistency check work without external dependencies?▼

Yes, the documentation consistency check works without external dependencies. It operates using internal scripts and references to validate that your project documentation stays perfectly aligned with the codebase.

Why does my project documentation show mismatches after renaming data models?▼

Project documentation shows mismatches after renaming data models because implementation, renaming, or schema changes create discrepancies between specifications and actual code. Running a consistency check detects these documentation update omissions.