reverse-document

Generate design or architecture documentation from existing code or prototypes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you recover missing planning and design documentation by generating it from the existing implementation, so you can understand what’s really happening and codify the intended architecture or gameplay design.

Core Features & Use Cases

  • Reverse-engineered design documentation: Produces a game design document (GDD) by extracting mechanics, rules, values, state behavior, edge-case handling, and system dependencies from code or prototypes.
  • Architecture decision records (ADRs): Generates architecture docs by identifying patterns, technical decisions, coupling/dependencies, performance characteristics, and trade-offs from core system code.
  • Prototype-to-concept writeups: Converts prototype behavior into concept documentation by extracting the core mechanic, emergent gameplay patterns, what worked/failed, and feasibility insights.
  • Intent-first collaboration: Asks clarifying questions about “why” before writing the rationale portion of the document to avoid guessing design intent.

Quick Start

Use the reverse-document skill to generate a design doc for your existing gameplay system at src/gameplay/magic-system so you can formalize mechanics and document the intended pacing and scaling.

Frequently Asked Questions about reverse-document

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

FAQPage Schema
How do I generate design documentation from existing code?

You can generate design documentation from existing code by analyzing mechanics, patterns, and formulas across specified file paths, then using an approval-gated workflow to write the final design doc.

What is reverse engineering in game development documentation?

In game development, reverse engineering documentation works backward from implementation to produce a game design document (GDD) by extracting mechanics, rules, state behavior, and system dependencies from existing prototypes.

How do I write an architecture decision record from an existing codebase?

Writing an architecture decision record from an existing codebase involves identifying patterns, coupling, and performance trade-offs from core system code, then asking intent clarification questions before generating the rationale.

Can I convert a prototype into a concept document?

You can convert a prototype into a concept document by extracting the core mechanic, emergent gameplay patterns, and feasibility insights to formalize what worked and what failed during prototype behavior.

Does generating design docs require answering clarifying questions?

Generating design docs requires answering intent clarification questions before writing the rationale portion of the document, ensuring the process codifies intended architecture rather than guessing design intent.

What format is needed to analyze code for reverse engineering documentation?

Analyzing code for reverse engineering documentation requires YAML frontmatter metadata plus argument parsing to process specified file or directory paths and extract implementation mechanics, patterns, and formulas.