using-unwind

Using Unwind

Overview

Unwind provides structured skills for reverse engineering codebases. Produces complete, machine-readable documentation with source links.

Principles

See analysis-principles.md:

• Completeness: Document ALL items (30 tables = 30 documented)
• Machine-readable: Use actual code, SQL, mermaid - not markdown recreation
• Link to source: GitHub links with line numbers where possible
• No commentary: Facts only, no speculation or recommendations

Workflow

start     → architecture.md (+ repo info for linking)
        │
unwinding-codebase          → dispatches layer specialists
        │
        ├── analyzing-database-layer     → database/
        ├── analyzing-domain-model       → domain-model/
        ├── analyzing-service-layer      → service-layer/
        ├── analyzing-api-layer          → api/
        ├── analyzing-messaging-layer    → messaging/ (if present)
        ├── analyzing-frontend-layer     → frontend/ (if present)
        ├── analyzing-unit-tests         → unit-tests/
        ├── analyzing-integration-tests  → integration-tests/
        └── analyzing-e2e-tests          → e2e-tests/
        │
verifying-layer-documentation → gap detection (parallel per layer)
        │
        └── Outputs gaps.md per layer (missing items only)
        │
completing-layer-documentation → gap completion (parallel per layer)
        │
        ├── Reads gaps.md work list
        ├── Adds missing documentation
        └── Deletes gaps.md when done
        │
synthesizing-findings       → REBUILD-PLAN.md (strategic rebuild approach)

Skills

Core Flow

Skill	Output
start	architecture.md
unwinding-codebase	Orchestrates layer analysis
verifying-layer-documentation	gaps.md per layer (work list)
completing-layer-documentation	Fills gaps, deletes gaps.md
synthesizing-findings	REBUILD-PLAN.md

Layer Specialists

Skill	Output
analyzing-database-layer	database.md
analyzing-domain-model	domain-model.md
analyzing-service-layer	service-layer.md
analyzing-api-layer	api.md
analyzing-messaging-layer	messaging.md
analyzing-frontend-layer	frontend.md

Testing Specialists

Skill	Output
analyzing-unit-tests	unit-tests.md
analyzing-integration-tests	integration-tests.md
analyzing-e2e-tests	e2e-tests.md

Output Structure

docs/unwind/
├── architecture.md
├── layers/
│   ├── database/
│   │   ├── index.md
│   │   ├── schema.md
│   │   ├── repositories.md
│   │   └── verification.md
│   ├── domain-model/
│   │   ├── index.md
│   │   ├── entities.md
│   │   └── verification.md
│   ├── service-layer/
│   │   ├── index.md
│   │   ├── services.md
│   │   ├── formulas.md
│   │   └── verification.md
│   ├── api/
│   │   ├── index.md
│   │   ├── endpoints.md
│   │   └── verification.md
│   └── [other layers...]
└── REBUILD-PLAN.md

Each layer is a folder with index.md + section files for incremental writes.

Quick Start

1. Use unwind:start
2. Review docs/unwind/architecture.md
3. Use unwind:unwinding-codebase
4. Use unwind:verifying-layer-documentation (runs parallel verification)
5. Use unwind:synthesizing-findings

Note: Step 4 (verification) is integrated into unwinding-codebase but can also be run independently to re-verify existing documentation.

Refresh Mode

Re-run any skill to update documentation. Changes highlighted in ## Changes Since Last Review section.