reverse-document

Generates design and architecture documents by analyzing existing code and prototypes.

13|Updated Jul 30, 2026
One-click install
npx skills add https://github.com/frabcd/codex-ai-game-studio --skill reverse-document-frabcd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reverse-document
Source: https://github.com/frabcd/codex-ai-game-studio/tree/main/plugins/ai-game-studio/skills/reverse-document
Command: npx skills add https://github.com/frabcd/codex-ai-game-studio --skill reverse-document-frabcd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams often ship features, inherit codebases, or prototype mechanics without ever writing design or architecture documentation, leaving the intent behind existing implementation undocumented and hard to maintain. ## Core Features & Use Cases - Reverse-engineered documentation: Analyzes source code or prototypes to extract mechanics, formulas, patterns, and dependencies, then drafts a GDD section, Architecture Decision Record, or concept document. - Intent clarification workflow: Asks targeted questions about why design decisions were made before drafting, separating intentional design from accidental behavior. - Approval-gated writing: Presents findings and drafts for review, writes the document only after approval, and flags follow-up work such as balance checks or missing edge cases. - Use Case: You inherited a combat system with no documentation. Run the skill on src/gameplay/combat/ to discover its mechanics and formulas, clarify design intent, and produce a reviewed GDD section marked as reverse-documented. ## Quick Start Ask the agent to run $ai-game-studio:reverse-document with a type (design, architecture, or concept) and a path such as src/gameplay/combat to generate a reviewed document from that code.

Frequently Asked Questions about reverse-document

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

FAQPage Schema
How do I generate a design document from existing code?

Run the reverse-document skill with the design type and a path to your gameplay code, such as src/gameplay/combat. It analyzes mechanics and formulas, asks clarifying questions about intent, then drafts a GDD section for your approval before writing.

What document types can reverse-document generate?

It supports three types: design produces a game design document section, architecture produces an Architecture Decision Record, and concept produces a concept document from a prototype. The type is chosen based on whether you analyze gameplay code, core systems, or prototypes.

Can I document a codebase I inherited without any docs?

Yes, inherited undocumented codebases are a primary use case. The skill reads the implementation, identifies patterns and dependencies, and asks you to clarify intent where the code alone cannot explain why decisions were made.

Does reverse-document write files automatically without review?

No, it follows an approval-gated workflow. It presents findings, shows the draft with additions and incomplete sections, and only writes the file after you explicitly approve the target path.

What are the limitations of reverse-engineered documentation?

The document captures current behavior plus clarified intent, but sections may be incomplete where implementation is partial or intent was unclear. Files are marked as reverse-documented so readers know the provenance, and follow-up work is flagged separately.