reverse-document

Analyze existing code and prototypes to generate design documents or Architecture Decision Records.

Updated Feb 8, 2024
One-click install
npx skills add https://github.com/kay6198835/Game-RPG --skill reverse-document-kay6198835
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reverse-document
Source: https://github.com/kay6198835/Game-RPG/tree/main/.claude/skills/reverse-document
Command: npx skills add https://github.com/kay6198835/Game-RPG --skill reverse-document-kay6198835

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate design or architecture documents by reverse-engineering existing implementation, ensuring code and prototypes are properly documented.

Core Features & Use Cases

  • Analyzes codebases and prototypes to produce a GDD (design) or ADR (architecture) from current work.
  • Creates concept documents from prototypes when planning is missing or needs formalization.
  • Supports a collaborative, intention-clarifying workflow to align documentation with implementation.

Quick Start

Run the command /reverse-document <type> <path> to generate a design or architecture document from your existing implementation.

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 docs from existing code in an inherited codebase?

To generate design docs from existing code, you analyze the current implementation to extract mechanics, patterns, and decisions, producing structured documents that capture the original intent and rationale for inherited codebases lacking formal planning.

What is the best way to create architecture decision records for unfinished features?

Creating architecture decision records for unfinished features involves reverse-engineering the existing implementation and prototypes to extract dependencies and patterns, ensuring the generated ADR accurately documents the architectural rationale and current state.

Can I reverse-engineer a prototype into a formal game design document?

Yes, you can reverse-engineer a prototype into a formal game design document by analyzing the existing codebase to formalize missing planning, extracting core mechanics and dependencies to align the documentation with the actual implementation.

How does code analysis extract architecture patterns for documentation?

Code analysis extracts architecture patterns by evaluating the existing implementation and prototypes to identify structural decisions and dependencies, translating these technical findings into structured documents that clarify the original design intent.

When do I need to reverse-document a codebase?

You need to reverse-document a codebase when you inherit undocumented code, work on unfinished features, or need to formalize prototypes into structured design documents and architecture decision records to align planning with implementation.

Does reverse-documenting code require specific dependencies or components?

Reverse-documenting code requires no specific dependencies or components, allowing you to directly analyze existing codebases and prototypes to generate structured design documents and architecture decision records without additional environment setup.