reverse-document

Solid

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

Data & Documents 20,555 stars 2999 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
3 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

Code & Development Listed

architecture-docs

Generate or refresh `/docs/architecture/` — the current-state source of architectural truth for this codebase, grounded in code and git history (NOT in .designs/). Produces an anchor-dense corpus (`invariants.md`, `idioms.md`, `trust-boundaries.md`, `seams.md`, `subsystems/*.md`, `history.md`, `gaps.md`) plus a high-level overview layer (C4 L1/L2 diagrams, sequence flows, Nygard ADRs). Every claim is anchored to a file:line or commit SHA, or labelled literally `"unknown — needs review"`. A bundled `validate.sh` mechanically enforces citation density and phase-completion gates. Used to ground future design reviews so they cannot silently drift away from established idioms.

0 Updated yesterday
stempeck
AI & Automation Solid

design-review

Reviews a game design document for completeness, internal consistency, implementability, and adherence to project design standards. Run this before handing a design document to programmers.

20,555 Updated 1 weeks ago
Donchitos
Web & Frontend Solid

describe-design

Research a codebase and create architectural documentation describing how features or systems work. Use when the user asks to: (1) Document how a feature works, (2) Create an architecture overview, (3) Explain code structure for onboarding or knowledge transfer, (4) Research and describe a system's design. Produces markdown documents with Mermaid diagrams and stable code references suitable for humans and AI agents.

379 Updated 3 days ago
posit-dev
Code & Development Listed

design-doc

Use this skill before writing any non-trivial code, especially when starting a new feature, service, or codebase. It produces a structural design document that commits to module boundaries, contracts, and data shapes BEFORE implementation begins. Trigger this whenever the user describes building something new, asks to "build", "create", or "implement" a system or feature larger than a single function, or whenever the conversation is about to move from discussion into code. Also trigger if the user mentions architecture, system design, planning, or wanting to "think through" a build before coding. Especially important for AI-generated codebases where unconstrained generation tends to sprawl into accidental complexity.

5 Updated today
taniwhaai
Data & Documents Listed

documentation-generator

Generate comprehensive documentation for a codebase by reading the repository and producing READMEs, API docs, architecture docs, and technical references. Use when the user asks to "document this repo", "generate docs", "write a README", "create API documentation", "document this codebase", "write architecture docs", or "produce technical references" for an existing project. NOT for UX copy, button labels, or interface microcopy (use ux-writing). NOT for pedagogical code examples or tutorials (use example-design). NOT for inline code comments. NOT for navigation or sitemap design (use navigation-design).

9 Updated 2 days ago
viktorbezdek