Verified:GitHub

reverse-document

Generate design, architecture, or concept documentation from an existing codebase.

Updated May 13, 2026

Search Tags:#claude code #design docs #code understanding #documentation templates #prototype analysis #architecture decision records #reverse documentation

Ready to run

npx skills add https://github.com/FrancisVarga/the-dream-machine --skill reverse-document-francisvarga

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: reverse-document
Source: https://github.com/FrancisVarga/the-dream-machine/tree/main/.claude/skills/reverse-document
Command: npx skills add https://github.com/FrancisVarga/the-dream-machine --skill reverse-document-francisvarga

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill fixes the common problem of having working code or a prototype but lacking the design, architecture, or concept documentation that others need to maintain and extend it.

Core Features & Use Cases

Reverse-engineer design documentation: Converts implemented mechanics into a game design document (GDD) structure, including mechanics, rules, formulas, and uncertainties.
Create architecture decision records: Extracts technical patterns and constraints from existing systems and formats them as ADRs.
Generate concept docs from prototypes: Documents core mechanic intent, emergent gameplay patterns, and feasibility insights from prototypes.
Collaborative intent clarification: Prompts targeted questions to separate true design intent from accidental behavior before drafting.

Quick Start

Use this skill to reverse-document an implemented system by running: /reverse-document architecture src/core/event-system.cpp

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 an existing codebase?▼

Generate design documentation from an existing codebase by reading the specified path, identifying technical patterns and dependencies, asking clarifying intent questions, and drafting with an appropriate template. The Skill writes the final design docs only after user approval.

Can I create architecture decision records from existing source code?▼

Yes, you can create architecture decision records from existing source code. The Skill extracts technical patterns and constraints from implemented systems and formats them as ADRs to formalize undocumented architecture decisions.

What is the best way to document a prototype's behavior into reusable specs?▼

The best way to document prototype behavior into reusable specs is to analyze the prototype code to identify core mechanic intent and emergent patterns. The Skill generates concept docs that capture feasibility insights from the existing prototype.

Does the reverse documentation process ask questions before drafting?▼

Yes, the reverse documentation process asks targeted clarifying questions before drafting. This collaborative intent clarification separates true design intent from accidental behavior in the codebase, ensuring accurate documentation before any output is written.

How to reverse-document inherited undocumented systems?▼

Reverse-document inherited undocumented systems by pointing the Skill at the code path. It identifies mechanics, rules, and formulas within the system, then drafts the missing documentation using an appropriate template for your review and approval.

Can I use this for documenting shipped code that lacks mechanics documentation?▼

Yes, you can use this for documenting shipped code lacking mechanics documentation. The Skill reverse-engineers implemented mechanics into a structured game design document format, capturing rules, formulas, and existing uncertainties from the codebase.