reverse-document

Featured

Generate design or architecture documents from existing implementation. Works backwards from code/prototypes to create missing planning docs.

Data & Documents 40,030 stars 5224 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 97/100

Stars 20%
100
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Reverse Documentation This skill analyzes existing implementation (code, prototypes, systems) and generates appropriate design or architecture documentation. Use this when: - You built a feature without writing a design doc first - You inherited a codebase without documentation - You prototyped a mechanic and need to formalize it - You need to document "why" behind existing code --- ## Workflow ## Phase 1: Parse Arguments **Format**: `/reverse-document <type> <path>` **Type options**: - `design` → Generate a game design document (GDD section) - `architecture` → Generate an Architecture Decision Record (ADR) - `concept` → Generate a concept document from prototype **Path**: Directory or file to analyze - `src/gameplay/combat/` → All combat-related code - `src/core/event-system.cpp` → Specific file - `prototypes/stealth-mech/` → Prototype directory **Examples**: ```bash /reverse-document design src/gameplay/magic-system /reverse-document architecture src/core/entity-component /reverse-document concept prototypes/vehicle-combat ``` ## Phase 2: Analyze Implementation **Read and understand the code/prototype**: **For design docs (GDD):** - Identify mechanics, rules, formulas - Extract gameplay values (damage, cooldowns, ranges) - Find state machines, ability systems, progression - Detect edge cases handled in code - Map dependencies (what systems interact?) **For architecture docs (ADR):** - Identify patterns (ECS, singleton, observer, etc.) - Understand technical de...

Details

Author
Donchitos
Repository
Donchitos/Claude-Code-Game-Studios
Created
9 months ago
Last Updated
1 weeks ago
Language
Shell
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category