選型總表
node archify/bin/archify.mjs guide "Show an API request with Redis cache miss"
node archify/bin/archify.mjs guide "Map Kafka topics, consumer groups, replay, and DLQ" --json
| 型別 | 最適合 | Prompt 要給什麼 |
|---|---|---|
| Architecture(架構) | 元件、服務、儲存、邊界 | 範圍、核心元件、主要路徑 |
| Workflow(工作流) | CI/CD、審批、工具呼叫、runbook | 參與者、順序、分支、例外 |
| Sequence(序列) | API 呼叫鏈、快取 fallback、認證、非同步追蹤 | 呼叫方、被呼叫方、回傳、時序 |
| Data Flow(資料流) | 管線、ETL/ELT、血緣、治理、消費者 | 來源、轉換、敏感邊界、消費者 |
| Lifecycle(生命週期) | 狀態/狀態轉換、重試、等待與終態 | 狀態、事件、重試與取消路徑 |
Type Router(代理內部路由)
代理依問題選擇型別,對應固定的 schema 與範例(範例教形狀、不教事實;一律用新 ID、措辭與版面):2
| 型別 | Schema | 範例 |
|---|---|---|
architecture |
schemas/architecture.schema.json |
examples/web-app.architecture.json(系統描述/服務/函式庫/CLI)、examples/production-deployment.architecture.json(部署) |
workflow |
schemas/workflow.schema.json |
examples/agent-tool-call.workflow.json |
sequence |
schemas/sequence.schema.json |
examples/cache-miss-request.sequence.json |
dataflow |
schemas/dataflow.schema.json |
examples/product-analytics.dataflow.json |
lifecycle |
schemas/lifecycle.schema.json |
examples/deployment-release.lifecycle.json |
模糊時跑 guide "<scenario>" --json;情境 proof 範例是結構參考,不可照抄事實。
各型別一瞥
- Architecture:元件、服務、雲/安全邊界、基礎設施。可選
deployment-ownershipprofile——缺少已撰寫 owner、region 放置、私有資料庫範圍或具名跨越時直接失敗(fail-closed),絕不隱含推斷,也不檢查即時基礎設施。1 - Workflow:讓 happy path 在泳道間保持清晰。
- Sequence:解釋單一互動隨時間的經過。
- Data Flow:讓移動與敏感邊界明確。
- Lifecycle:區分進展、等待、重試與終態。
進階:Architecture Delta 可比較已驗證的 Before / Delta / After 快照並附機器收據,只推斷已撰寫變更,不推斷影響、風險或合併安全:1
node archify/bin/archify.mjs compare architecture base.json head.json architecture-delta.html --json
Mermaid 輸入怎麼處理
先讀 Mermaid 的拓撲與語意,再寫全新的 Archify JSON;不做機械式樣式渲染:2
| Mermaid | Archify |
|---|---|
flowchart / graph |
workflow;若是元件地圖則為 architecture |
sequenceDiagram |
sequence(參與者變語意參與者,箭頭變訊息) |
stateDiagram |
lifecycle(保留狀態與轉換語意,不保留 Mermaid 樣式) |