vm-reverse-engineering-reporter

Skill detail with category, linked agents, and source metadata.

vm-reverse-engineering-reporter

Generates navigable HTML documentation from reverse engineering analysis results. Produces a multi-page HTML site with VM theme (white, green, gold), sidebar navigation, inline Mermaid/PlantUML diagrams, searchable file/class indexes, and per-phase content pages. Contains all HTML/CSS/JS templates internally.

Category: code-generation Used by 1 agents

Source: .github/skills/code-generation/vm-reverse-engineering-reporter/SKILL.md

Used By Agents

3 - Analysis - Reverse Engineering Agent

Preview

View source preview (first 3000 chars)


# vm-reverse-engineering-reporter

## When to Use This Skill

- Generating the final HTML output from codebase reverse engineering analysis
- Stitching per-phase JSON results into navigable HTML pages
- Producing searchable file and class indexes with inline diagrams
- Creating a self-contained documentation site for a reverse-engineered codebase

## Unitary Function

**ONE responsibility:** Take structured JSON output from all reverse engineering phases and generate a complete, navigable HTML documentation site with VM branding.

## NOT RESPONSIBLE FOR

- Performing any code analysis (receives pre-analyzed data)
- Generating diagrams from code (receives Mermaid/PlantUML strings from upstream phases)
- Deciding analysis depth or file classification
- Hosting or deploying the HTML output

## Input

```json
{
  "repo_name": "my-application",
  "output_dir": "docs/codebase-analysis/",
  "discovery_results": {},
  "file_analysis_results": [],
  "data_model_results": {},
  "flow_mapping_results": {},
  "architecture_results": {},
  "business_logic_results": {},
  "test_analysis_results": {},
  "checklist": {}
}
```

| Parameter | Required | Description |
|-----------|----------|-------------|
| `repo_name` | Yes | Repository name for page titles |
| `output_dir` | Yes | Relative path for HTML output |
| `discovery_results` | Yes | Phase 1 output JSON |
| `file_analysis_results` | Yes | Phase 2 per-file analysis array |
| `data_model_results` | Yes | Phase 3 data model JSON |
| `flow_mapping_results` | Yes | Phase 4 flow mapping JSON |
| `architecture_results` | Yes | Phase 5 architecture JSON |
| `business_logic_results` | Yes | Phase 6 business logic JSON |
| `test_analysis_results` | Yes | Phase 7 test analysis JSON |
| `checklist` | Yes | Master Checklist JSON (for status tracking display) |

## Output Structure

```
{output_dir}/
├── index.html                        # Overview dashboard
├── assets/
│   ├── style.css                     # VM theme styles
│   └── app.js                        # Search, navigation, Mermaid init
├── 1-discovery/
│   └── index.html                    # Discovery results
├── 2-file-analysis/
│   ├── index.html                    # Searchable file list
│   └── files/
│       └── {sanitized-filename}.html # Per-file detail pages
├── 3-data-model/
│   └── index.html                    # ER diagram + entities
├── 4-user-flows/
│   └── index.html                    # Sequence diagrams
├── 5-architecture/
│   └── index.html                    # Architecture diagrams
├── 6-business-logic/
│   └── index.html                    # Capabilities + Q&A
├── 7-tests/
│   ├── index.html                    # Test inventory + gaps
│   └── test-gap-inventory.json       # Machine-readable test gap inventory
├── 8-symbol-index/
│   └── index.html                    # Searchable symbol browser (classes, methods, routes)
├── 9-brownfield-context/
│   └── index.html                    # Naming conventions, structural patterns, extension poi