skills.rest
antoinecellerier
antoinecellerierCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

docs-update

Validate and synchronize project documentation with code changes across multiple files.

2|Updated Feb 4, 2026
Search Tags:#code review#documentation#consistency#pre-commit#sync#copilot
One-click install
npx skills add https://github.com/antoinecellerier/les-aiguilles-blanches --skill docs-update-antoinecellerier
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-update
Source: https://github.com/antoinecellerier/les-aiguilles-blanches/tree/main/.github/skills/docs-update
Command: npx skills add https://github.com/antoinecellerier/les-aiguilles-blanches --skill docs-update-antoinecellerier

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that all project documentation, including architecture, roadmap, gameplay, art style, testing procedures, in-game changelogs, Copilot instructions, and the main README, remains consistent with code changes.

Core Features & Use Cases

  • Automated Documentation Audit: Verifies that documentation aligns with code modifications across various categories.
  • Commit Verification: Acts as a pre-commit hook to prompt developers to update relevant documentation before committing.
  • Use Case: Before committing a change that introduces a new game mechanic, this Skill will remind you to update GAMEPLAY.md and potentially src/config/localization.ts for the in-game changelog.

Quick Start

Run the docs-update skill to ensure all documentation is synchronized with the latest code changes.

Frequently Asked Questions about docs-update

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

FAQPage Schema
How do I keep documentation in sync with code changes before committing?▼

Documentation consistency requires validating multiple file formats against code modifications; this Skill audits architecture, roadmap, gameplay, and README files to enforce synchronization across the project before manual review.

How do I enforce documentation updates for game mechanics and changelogs?▼

You can enforce documentation updates by running a verification step before commits; this prompts developers to update specific files like GAMEPLAY.md and in-game changelog configurations based on detected code modifications.

Does this documentation synchronization approach work for multiple file formats?▼

Yes, this approach works for multiple file formats by validating consistency across architecture, roadmap, gameplay, art style, testing, in-game changelogs, Copilot instructions, and README files based on code modifications.

What is the best way to automate a documentation audit for Copilot instructions?▼

Automating a documentation audit involves running a synchronization check that validates Copilot instruction files against recent code modifications, requiring manual review and updates to ensure alignment before committing.

Are there limitations to automated documentation synchronization?▼

The main limitation of automated documentation synchronization is that it cannot automatically update content; it requires manual review and targeted updates to specific documentation files based on detected code modifications.

Related Skills

Explore More Software Engineering Skills→
nettenette
41

commit-messages

Validate commit messages against a standardized format before commits.

Official
Basic
chujianyunchujianyun
715

qoder-wiki

Automate structured project documentation generation from code and existing docs.

Community
Intermediate
massgenmassgen
1.1k

pr-checks

Automate PR checks with pre-commit hooks, tests, and CodeRabbit feedback.

Official
Advanced
terrylicaterrylica
62

link-validation

Scan markdown files with lychee to detect broken links and path policy violations.

Community
Intermediate