skill-reverse-engineering
SolidRegenerate architecture documentation from codebase analysis.
AI & Automation 4 stars
0 forks Updated today Apache-2.0
Install
Quality Score: 80/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
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
AI & Automation Featured
skill-extract
Reverse-engineer design systems, tokens, and components from live products or screenshots
3,887 Updated today
nyldn AI & Automation Featured
reverse-engineer
Reverse-engineer an authorized repo, binary, or product into a verifiable feature inventory and adoption map. Triggers: "reverse-engineer X", "tear down Y", "what should we steal from Z", "evaluate competitor/upstream", "should we fork/adopt/build-native".
414 Updated today
boshu2 AI & Automation Solid
project-researcher
Scans, analyzes, and documents the existing repository architecture, directories, and file purposes into docs/ARCHITECTURE.md.
41 Updated today
GulajavaMinistudio