Reverse Engineering Assistant | 反向工程助手
System archeology framework: reverse engineer existing systems across three dimensions — Logic, Data, and Runtime.
系統考古框架：從三個維度反向工程既有系統——邏輯、資料、執行環境。
Three Dimensions | 三大維度
┌─────────────────────────────────────────────────────────┐
│ System Archeology Framework │
├──────────┬──────────────┬────────────────────────────────┤
│ Logic │ Data │ Runtime │
│ (spec) │ (data) │ (runtime) │
├──────────┼──────────────┼────────────────────────────────┤
│ APIs │ DB Schemas │ Logs & Error Patterns │
│ Modules │ ORMs/Models │ Config & Environment │
│ Flows │ Migrations │ Metrics & Performance │
│ Tests │ Seed Data │ Infra & Deployment │
└──────────┴──────────────┴────────────────────────────────┘
Subcommands | 子命令
| Subcommand |
Dimension |
Input |
Output |
說明 |
| (none) |
All |
Project root |
Full Archeology Report |
三維度全面分析 |
spec |
Logic |
Code files/dirs |
SPEC-XXX.md |
從程式碼提取規格 |
data |
Data |
DB schemas, ORMs, migrations |
Data Model Spec |
分析資料模型與結構 |
runtime |
Runtime |
Logs, configs, metrics |
Runtime Baseline |
分析執行環境基準 |
bdd |
— |
SPEC-XXX.md |
.feature |
將 AC 轉為 Gherkin |
tdd |
— |
.feature |
Coverage Report |
分析測試覆蓋率 |
Full Analysis Mode | 全面分析模式
When /reverse is invoked without a subcommand, execute all three dimensions sequentially:
- Data → Scan schemas, ORMs, migrations
- Runtime → Analyze logs, configs, deployment
- Logic (spec) → Extract APIs, flows, tests → Generate SPEC
Output: Integrated System Archeology Report combining all three dimensions.
Dimension Details | 維度詳情
spec: Logic Dimension (既有)
- Scan - Read source files and identify public APIs, data flows, and business logic
- Classify - Tag each finding as
[Confirmed], [Inferred], or [Unknown]
- Structure - Organize into SDD spec format with Acceptance Criteria
- Attribute - Cite every reversed item with
file:line source reference
data: Data Dimension (新增)
- Discover - Find database schemas, ORM models, migration files, seed data
- Map - Build entity-relationship model from code evidence
- Classify - Tag relationships as
[Confirmed] (FK constraints) or [Inferred] (code patterns)
- Report - Output data model spec with:
- Entity list with fields and types
- Relationship map (1:1, 1:N, M:N)
- Index and constraint inventory
- Migration history summary
- Data flow paths (write → read)
Evidence sources: schema.prisma, *.migration.*, models/, entities/, knexfile.*, sequelize, typeorm, SQL files, docker-compose.yml (DB services)
runtime: Runtime Dimension (新增)
- Scan configs - Environment variables, config files, feature flags
- Analyze logs - Log patterns, error frequency, log levels
- Check infra - Docker configs, CI/CD pipelines, deployment manifests
- Baseline - Output runtime baseline with:
- Environment variable inventory (names only, never values/secrets)
- Config file map and hierarchy
- External service dependencies (APIs, queues, caches)
- Deployment topology (containers, services)
- Health check and monitoring endpoints
Evidence sources: .env.example, docker-compose.yml, Dockerfile, *.config.*, CI/CD files, k8s/, log files (patterns only)
Security: NEVER output actual secret values. Only list variable names and describe their purpose.
Anti-Hallucination Rules | 防幻覺規則
| Rule |
Requirement |
要求 |
| Certainty Tags |
Use [Confirmed], [Inferred], [Unknown] for all findings |
所有發現須標注確定性 |
| Source Attribution |
Cite file:line for every reversed item |
每項反向結果須引用來源 |
| No Fabrication |
Never invent APIs or behaviors not found in code |
不得捏造程式碼中不存在的 API 或行為 |
| No Secrets |
Never output secret values from configs or env files |
不得輸出設定檔或環境變數的密鑰值 |
Usage | 使用方式
/reverse - Full 3-dimension analysis | 三維度全面分析
/reverse spec src/auth/ - Logic: extract spec | 邏輯：提取規格
/reverse data - Data: analyze schemas & models | 資料：分析結構
/reverse runtime - Runtime: analyze configs & infra | 執行環境：分析配置
/reverse bdd specs/SPEC-AUTH.md - Convert spec ACs to Gherkin
/reverse tdd features/auth.feature - Analyze test coverage
Next Steps Guidance | 下一步引導
After /reverse (full or spec) completes, the AI assistant should suggest:
系統考古完成。建議下一步 / System archeology complete. Suggested next steps:
- 執行
/sdd 審查並核准此規格 ⭐ Recommended / 推薦 — Review and approve the generated spec
- 執行
/derive 從規格推導測試 — Derive tests from spec (requires approval first)
- 審查規格中的
[Inferred] 和 [Unknown] 標記 — Review uncertainty tags manually
Reference | 參考
AI Agent Behavior | AI 代理行為
完整的 AI 行為定義請參閱對應的命令文件：/reverse
For complete AI agent behavior definition, see the corresponding command file: /reverse
1---2name: reverse3description: [UDS] System archeology — reverse engineer an existing system across the Logic, Data, and Runtime dimensions. Use when: documenting an undocumented system, recovering specifications from existing code, mapping an unknown data model or runtime topology. Not for: assessing health and risk before a feature — use /discover; deriving tests forward from an approved spec — use /spec-derive. Keywords: reverse engineering, system archeology, legacy code, spec extraction, data model, runtime, 反向工程, 系統考古, 規格提取.4---56# Reverse Engineering Assistant | 反向工程助手78System archeology framework: reverse engineer existing systems across three dimensions — **Logic**, **Data**, and **Runtime**.910系統考古框架：從三個維度反向工程既有系統——**邏輯**、**資料**、**執行環境**。1112## Three Dimensions | 三大維度1314```15┌─────────────────────────────────────────────────────────┐16│ System Archeology Framework │17├──────────┬──────────────┬────────────────────────────────┤18│ Logic │ Data │ Runtime │19│ (spec) │ (data) │ (runtime) │20├──────────┼──────────────┼────────────────────────────────┤21│ APIs │ DB Schemas │ Logs & Error Patterns │22│ Modules │ ORMs/Models │ Config & Environment │23│ Flows │ Migrations │ Metrics & Performance │24│ Tests │ Seed Data │ Infra & Deployment │25└──────────┴──────────────┴────────────────────────────────┘26```2728## Subcommands | 子命令2930| Subcommand | Dimension | Input | Output | 說明 |31|------------|-----------|-------|--------|------|32| *(none)* | All | Project root | Full Archeology Report | 三維度全面分析 |33| `spec` | Logic | Code files/dirs | `SPEC-XXX.md` | 從程式碼提取規格 |34| `data` | Data | DB schemas, ORMs, migrations | Data Model Spec | 分析資料模型與結構 |35| `runtime` | Runtime | Logs, configs, metrics | Runtime Baseline | 分析執行環境基準 |36| `bdd` | — | `SPEC-XXX.md` | `.feature` | 將 AC 轉為 Gherkin |37| `tdd` | — | `.feature` | Coverage Report | 分析測試覆蓋率 |3839## Full Analysis Mode | 全面分析模式4041When `/reverse` is invoked without a subcommand, execute all three dimensions sequentially:42431. **Data** → Scan schemas, ORMs, migrations442. **Runtime** → Analyze logs, configs, deployment453. **Logic (spec)** → Extract APIs, flows, tests → Generate SPEC4647Output: Integrated **System Archeology Report** combining all three dimensions.4849## Dimension Details | 維度詳情5051### spec: Logic Dimension (既有)52531. **Scan** - Read source files and identify public APIs, data flows, and business logic542. **Classify** - Tag each finding as `[Confirmed]`, `[Inferred]`, or `[Unknown]`553. **Structure** - Organize into SDD spec format with Acceptance Criteria564. **Attribute** - Cite every reversed item with `file:line` source reference5758### data: Data Dimension (新增)59601. **Discover** - Find database schemas, ORM models, migration files, seed data612. **Map** - Build entity-relationship model from code evidence623. **Classify** - Tag relationships as `[Confirmed]` (FK constraints) or `[Inferred]` (code patterns)634. **Report** - Output data model spec with:64 - Entity list with fields and types65 - Relationship map (1:1, 1:N, M:N)66 - Index and constraint inventory67 - Migration history summary68 - Data flow paths (write → read)6970**Evidence sources**: `schema.prisma`, `*.migration.*`, `models/`, `entities/`, `knexfile.*`, `sequelize`, `typeorm`, SQL files, `docker-compose.yml` (DB services)7172### runtime: Runtime Dimension (新增)73741. **Scan configs** - Environment variables, config files, feature flags752. **Analyze logs** - Log patterns, error frequency, log levels763. **Check infra** - Docker configs, CI/CD pipelines, deployment manifests774. **Baseline** - Output runtime baseline with:78 - Environment variable inventory (names only, **never values/secrets**)79 - Config file map and hierarchy80 - External service dependencies (APIs, queues, caches)81 - Deployment topology (containers, services)82 - Health check and monitoring endpoints8384**Evidence sources**: `.env.example`, `docker-compose.yml`, `Dockerfile`, `*.config.*`, CI/CD files, `k8s/`, log files (patterns only)8586**Security**: NEVER output actual secret values. Only list variable names and describe their purpose.8788## Anti-Hallucination Rules | 防幻覺規則8990| Rule | Requirement | 要求 |91|------|-------------|------|92| **Certainty Tags** | Use `[Confirmed]`, `[Inferred]`, `[Unknown]` for all findings | 所有發現須標注確定性 |93| **Source Attribution** | Cite `file:line` for every reversed item | 每項反向結果須引用來源 |94| **No Fabrication** | Never invent APIs or behaviors not found in code | 不得捏造程式碼中不存在的 API 或行為 |95| **No Secrets** | Never output secret values from configs or env files | 不得輸出設定檔或環境變數的密鑰值 |9697## Usage | 使用方式9899```100/reverse - Full 3-dimension analysis | 三維度全面分析101/reverse spec src/auth/ - Logic: extract spec | 邏輯：提取規格102/reverse data - Data: analyze schemas & models | 資料：分析結構103/reverse runtime - Runtime: analyze configs & infra | 執行環境：分析配置104/reverse bdd specs/SPEC-AUTH.md - Convert spec ACs to Gherkin105/reverse tdd features/auth.feature - Analyze test coverage106```107108## Next Steps Guidance | 下一步引導109110After `/reverse` (full or `spec`) completes, the AI assistant should suggest:111112> **系統考古完成。建議下一步 / System archeology complete. Suggested next steps:**113> - 執行 `/sdd` 審查並核准此規格 ⭐ **Recommended / 推薦** — Review and approve the generated spec114> - 執行 `/derive` 從規格推導測試 — Derive tests from spec (requires approval first)115> - 審查規格中的 `[Inferred]` 和 `[Unknown]` 標記 — Review uncertainty tags manually116117## Reference | 參考118119- [BDD Extraction Workflow Guide](./bdd-extraction.md) — Read it when extracting BDD scenarios out of an existing spec.120- [TDD Analysis Workflow Guide](./tdd-analysis.md) — Read it when analysing test coverage against scenarios and finding the gaps.121- Step-by-step workflow: [workflow.md](./workflow.md) — the reverse-engineering phases in order (code scanning, data models, configuration, test analysis, coverage). Read it when actually running the process rather than deciding whether to.122- Detailed guide: [guide.md](./guide.md)123- Core standard: [reverse-engineering-standards.md](../../core/reverse-engineering-standards.md)124125126## AI Agent Behavior | AI 代理行為127128> 完整的 AI 行為定義請參閱對應的命令文件：[`/reverse`](../commands/reverse.md#ai-agent-behavior--ai-代理行為)129>130> For complete AI agent behavior definition, see the corresponding command file: [`/reverse`](../commands/reverse.md#ai-agent-behavior--ai-代理行為)
AsiaOstrich