skill-reverse-engineering

Solid

Regenerate architecture documentation from codebase analysis.

AI & Automation 4 stars 0 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 80/100

Stars 20%
23
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Reverse Engineering Skill ## Purpose Recover the mental model of a project from its codebase when documentation is outdated or missing. ## When to Use - Documentation-code mismatch detected - New team member onboarding - Post-"quick fix" cleanup ## Strategy: Automated Scan + Iterative Analysis ### Phase 1: Automated Directory Scan **Tool:** `scripts/scan_structure.py` **Usage:** ```bash python3 .agent/skills/skill-reverse-engineering/scripts/scan_structure.py . --depth 2 ``` **Goal:** - Get high-level overview of project structure. - Identify dominant languages and components. - Avoid context overflow by NOT reading all files. ### Phase 2: Local Analysis (Per-Directory) For each key component identified in Phase 1: 1. List files. 2. Sample 2-3 representative files (read content). 3. Generate **Local Summary**: - Purpose - Key Classes - Dependencies ### Phase 3: Global Synthesis Combine local summaries to update `docs/ARCHITECTURE.md`: - Update **Directory Structure** - Update **Component Map** - Identify **Architecture Drift** (Code != Docs) ## Output Artifacts ### 1. ARCHITECTURE.md Update Generate diffs for: - Directory Structure - Component Map - Data Flow ### 2. KNOWN_ISSUES.md Updates Identify: - `TODO`/`HACK` comments indicating tech debt. - Discrepancies between implementation and docs. **Filing format (thin index).** `docs/KNOWN_ISSUES.md` is a hand-maintained **thin index**, not a flat checklist — do **NOT** append `- [ ]` lines to it. The auth...

Details

Author
MatrixFounder
Repository
MatrixFounder/Agentic-development
Created
7 months ago
Last Updated
today
Language
Python
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category