One-click install
npx skills add https://github.com/takemo101/compose-workflow --skill reverse-engineer-takemo101
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reverse-engineer
Source: https://github.com/takemo101/compose-workflow/tree/main/.pi/skills/reverse-engineer
Command: npx skills add https://github.com/takemo101/compose-workflow --skill reverse-engineer-takemo101

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of detailed design documents by analyzing existing source code, which is invaluable for projects lacking documentation or for understanding legacy code.

Core Features & Use Cases

  • Code Analysis: Extracts symbols, dependencies, tests, and comments from source code.
  • Design Document Generation: Creates detailed design documents based on extracted information using predefined templates.
  • Use Case: You inherit a complex Rust codebase with no design documents. Use this Skill to generate a comprehensive design document that outlines the structure, data types, and core logic, enabling faster onboarding and development.

Quick Start

Use the reverse-engineer skill to analyze the code in the 'src/utils/' directory and generate a design document.

Frequently Asked Questions about reverse-engineer

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

FAQPage Schema
How do I generate design documents from existing source code?

To generate design documents from source code, this Skill automates extraction of structure, dependencies, data types, and comments to produce comprehensive documentation. It analyzes your codebase and outputs detailed design documents based on predefined templates.

Can I use this to reverse engineer legacy code in Rust and Python?

Yes, you can reverse engineer legacy code in Rust and Python, as well as TypeScript and Go. The Skill performs dependency analysis and symbol extraction across these multiple programming languages to help you understand undocumented codebases.

What is the best way to document a codebase with no existing documentation?

The best way to document an undocumented codebase is using automated design document generation. This Skill analyzes code structure, extracts symbols, and validates quality to create detailed design documents, enabling faster onboarding for inherited projects.

Does design document generation work with TypeScript and Go source files?

Yes, design document generation works with TypeScript and Go source files, alongside Rust and Python. The Skill extracts comments and analyzes code structure across these specific languages to produce comprehensive documentation in Japanese.

How do I extract dependencies and symbols for code analysis?

To extract dependencies and symbols for code analysis, the Skill automates scope confirmation and symbol extraction from your source code. It analyzes data types, tests, and comments to generate comprehensive design documents based on the extracted information.

What are the limitations of automated code analysis for design document generation?

A limitation of automated code analysis for design document generation is that output is currently produced in Japanese. Additionally, the Skill supports a specific scope of languages (Rust, TypeScript, Python, Go) and relies on quality validation of extracted comments and structure.