consistency-check

Detect cross-document inconsistencies between GDDs and the entity registry.

Updated Dec 22, 2024
One-click install
npx skills add https://github.com/imgamer/AILearn --skill consistency-check-imgamer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: consistency-check
Source: https://github.com/imgamer/AILearn/tree/main/game-studios/Claude-Code-Game-Studios-e375f/.claude/skills/consistency-check
Command: npx skills add https://github.com/imgamer/AILearn --skill consistency-check-imgamer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Prevents design drift by detecting when the same entity, item, formula, or constant is defined with conflicting values across multiple GDDs and the central entity registry.

Core Features & Use Cases

  • Registry-first conflict scanning: Loads design/registry/entities.yaml once, then uses targeted grep to scan only relevant GDD sections for matches.
  • Conflict classification and deep investigation: Performs wider reads only for detected conflicts to determine whether the fix is in a GDD or the registry.
  • Actionable outputs: Produces a structured report (PASS/CONFLICTS FOUND) and supports interactive registry corrections and conflict logging.

Quick Start

Run the consistency scan for the whole project by asking the assistant to execute /consistency-check full.

Frequently Asked Questions about consistency-check

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

FAQPage Schema
How do I check for cross-document inconsistencies in game design documents?

Cross-document inconsistencies in game design documents are detected by comparing registered entity definitions in `design/registry/entities.yaml` against values in `design/gdd/*.md` files. The scan uses a grep-first approach to find conflicting values for items, formulas, or constants.

Can I scan a specific entity for design drift during GDD authoring?

Targeted checks for a specific entity or item are supported during GDD authoring. The scan loads the registry once and uses targeted grep to scan only relevant GDD sections, allowing you to catch design drift before downstream architecture work.

What is the best way to resolve GDD conflicts with an entity registry?

The best way to resolve GDD conflicts involves a resolution workflow that updates `design/registry/entities.yaml` interactively. The scan classifies conflicts and performs deep reads only on detected mismatches to determine whether the fix belongs in the GDD or the registry.

How do I log design consistency failures in my project?

Design consistency failures are logged to `docs/consistency-failures.md`. The scan produces a structured PASS or CONFLICTS FOUND report, supports interactive registry corrections, and automatically records detected cross-document value mismatches in the failure log.

Do I need an entity registry to run a full consistency scan?

An entity registry like `design/registry/entities.yaml` is required. The scan applies a registry-first greedy approach, loading registered entity, item, formula, and constant definitions once to compare them against GDD markdown files.

When should I run a since-last-review consistency scan instead of a full scan?

A since-last-review scan is used to check only recent changes, whereas a full scan validates the entire project. Both modes compare the entity registry against GDD markdown files to prevent design drift and catch conflicting values before they spread.