documentation-sync

name	documentation-sync
description	Keep documentation in sync with code changes. Use when implementing features, modifying APIs, changing architecture, adding configuration, updating security, or making any changes that affect user-facing or developer-facing documentation.

Documentation Synchronization Skill

Overview

This skill ensures documentation in the docs/ directory remains synchronized with codebase changes, maintaining accuracy and completeness for both users and developers.

Core Principle

Documentation is part of the definition of done. No code change is complete until the relevant documentation is updated.

When to Use This Skill

Activate this skill when:

• API Changes: Adding/modifying REST or GraphQL endpoints
• Database Changes: Adding entities, modifying schema
• Architecture Changes: Changing design patterns, component structure
• Configuration Changes: Adding environment variables, config options
• Security Changes: Modifying authentication, authorization
• Testing Changes: Adding test strategies, new test types
• Performance Changes: Optimizations, benchmarking
• Feature Implementation: New user-facing features

Core Documentation Files

API and Integration

File	Purpose	Update When
docs/api-endpoints.md	REST/GraphQL endpoints, schemas	API changes
docs/user-guide.md	User-facing features