diagram-audience-fit
Health Uyari
- License — License: NOASSERTION
- Description — Repository has a description
- Active repo — Last push 0 days ago
- Low visibility — Only 7 GitHub stars
Code Basarisiz
- exec() — Shell command execution in reference-impl/tools/archdiag/anchors.mjs
- fs.rmSync — Destructive file system operation in reference-impl/tools/archdiag/anchors.mjs
- exec() — Shell command execution in reference-impl/tools/archdiag/asserts.mjs
Permissions Gecti
- Permissions — No dangerous permissions requested
Bu listing icin henuz AI raporu yok.
Two Claude Code skills that make an AI agent draw architecture diagrams where every line traces to a source, then redraw the findings for people who did not build the system.
diagram-audience-fit
讓 AI agent 畫出「每條線都追得到來源」的架構圖,再把同一份發現重畫給不是作者的人看。
兩個 Claude Code skill + 一個免安裝的 Node 繪圖程式庫 + 一個 Python 檢查工具 + 實際範例與驗收腳本。
繁體中文 · English
看範例 · 快速開始 · 運作流程 · 開發者文件 · 給 agent 的入口 · 版本紀錄
上圖由本 repo 自己產生:探針實讀檔案間的引用 → 工程版(每條線的出處在固定版本 v1.0.0 上逐一核對;圖的內容是 v1.0.0 的檔案結構)→ 讀者版(讀者版檢查 0 FAIL,紀錄在 afgate_run.txt)。兩頁與建置腳本在 docs/self-portrait/。
它解決什麼
請 AI 畫系統架構圖,常見的結果是:圖很漂亮,但線是猜的;或者圖很精確,只有作者自己看得懂。
這個 repo 把兩件事接成一條線:
| 你得到的 | 怎麼守住 | |
|---|---|---|
| ① 畫圖(diagram-authoring) | 架構圖、狀態機、流程圖、稽核視圖組 | 每個節點與連線追得到來源,追不到的標 [assumed];先寫文字模型再出圖;頁面自帶幾何自檢;一定附缺口報告(資料答不了什麼) |
| ② 對讀者調校(audience-fit) | 給擁有者、主管、非工程讀者的版本 | 只換讀者、不換發現:數字、因果強度、範圍、限制一律不准改輕;改寫版與原版成對交付 |
一眼看懂
|
同一份稽核的五張視圖
|
流程圖記號
|
|
跳線(line hop)
|
給擁有者看的重畫版 |
範例是作者環境裡一個媒體下載工具的實際稽核頁,所以圖內文字是中文;看的是做法,不是內容。原始頁面在 reference-impl/outputs/diagram-authoring/,下載後用瀏覽器直接打開。
快速開始:交給你的 agent
- 到 Releases 下載 zip,或
git clone後切到版本標籤(建議固定版本,不要直接用main)。 - 把整個資料夾交給你的 agent(Claude Code、Codex、Cursor 等能讀檔、跑指令的都可以),貼這段:
請先讀 AGENTS.md,照它的閱讀順序讀完 docs/BUILD-SPEC.md 和 docs/EVIDENCE.md;reference-impl/ 是實際在用的原檔,當範例看,不要整份照貼。
在 repo 根目錄執行 python -X utf8 verify/run_controls.py reference-impl <一個還不存在的新資料夾>(它會複製一份來改、跑完刪掉,所以絕不能指向現有資料夾),把輸出和 verify/controls_run.txt 對照後貼給我;sha256 和各項數值要一樣、每項結尾要是 ok(route stats 的毫秒數每次不同,不用比)。
接著讀規格第 8 節,列出在我的環境裡哪些路徑、工具要換成什麼,給我確認後再動手。
之後照規格第 2 節幫我畫第一張稽核圖:先列來源(第 0 步)、先寫文字模型、先開缺口報告,最後才產圖;缺口表要另找一個沒參與畫圖的 subagent 審過。
- 需要 Node 24、Python 3.12、
git(只在這些版本實跑過;程式庫不必npm install,檢查工具只用 Python 標準庫)。
運作流程
- 來源 → 文字模型:先把程式、設定、設計文件寫成節點表、邊表、狀態表。
- 文字模型 → 結構檢查:用 schema 與斷言檢查模型;不通過就退回文字模型。
- 結構檢查 → 渲染:通過後才出圖,排線、跳線,頁面自帶幾何自檢。
- 渲染 → 工程稽核頁:產出稽核頁與缺口報告;缺口表另交給另一個乾淨脈絡審。
- 工程稽核頁 → audience-fit:同一份發現重畫給讀者。
- audience-fit → afgate 檢查:檢查數字、範圍、用語;不通過就退回重畫。
- afgate 檢查 → 擁有者視圖:通過後與原版成對交付。
圖由 docs/assets/pipeline.build.mjs 產生,模型檢查與頁內文字檢查各附正反兩面對照。
flowchart LR
S["來源<br/>程式・設定・設計文件"] --> M["文字模型<br/>節點表・邊表・狀態表"]
M --> G{"結構檢查<br/>schema・斷言"}
G -- 不通過 --> M
G -- 通過 --> R["渲染<br/>路由・跳線・頁內自檢"]
R --> P["工程稽核頁<br/>+缺口報告"]
P --> V["另一個乾淨脈絡<br/>審缺口表"]
P --> A["audience-fit<br/>重畫給讀者"]
A --> K{"afgate 檢查<br/>數字・範圍・用語"}
K -- 不通過 --> A
K -- 通過 --> O["擁有者視圖<br/>與原版成對交付"]
四條原則貫穿全部內容:沒有模型的圖只是截圖(建置腳本隨圖交付)· 結構與幾何機器驗、外觀人驗 · 檢查只對能判定的事下判決 · 讀者版只換讀者,不換發現。
各元件、程式庫模組、目錄結構與設計取捨,見 開發者文件。
這一版
v1.3.0(2026-11-07):線要待在它的關係旁邊。兩端都在同一個框裡的線卻跑出框外(讀者會以為它連到外面),或在所有框外繞離目標,新增警告 L16;畫出來的長度超過兩端直角距離 3 倍,新增警告 L17(都只警告,往回走的回圈線不算)。路由器預設改成第 4 版,把這兩種情況和繞遠路的長度算進成本,不再用一大圈繞路換掉一個交叉(交叉有跳線,讀得懂)。原環境 50 張圖的新舊對照:警告 72 → 67,交叉 57 → 58,線總長少 4712 px。另附改版對照工具 rev-ab.mjs(原環境維護用:自測可在這裡跑,整批對照需要原環境)。範例頁位元組不變,13 項機器驗收全過。完整紀錄見 CHANGELOG。
v1.2.0(2026-11-07):連線間距 (line clearance) 檢查集中成一個共用模組:線穿過別的群組框、壓到標題、貼著節點、和別的線擠在一起或繞回自己的端點,都會發出警告(只警告,不擋建置),也能單獨對頁面執行。路由器預設改成第 3 版,排線時就避開這些情況。稽核頁會記下它照哪一版標準圖組檢查;標準換版後,舊頁會提醒重新聲明。稽核建置改讀固定 commit 的原始碼,不再讀會變動的工作目錄。範例頁位元組不變,機器驗收新增 A17,共 13 項全過。
v1.1.0(2026-11-05):讀者版圖新增預設視覺規則 R14:只有一條主路徑上色並編號、圖下附步驟句;連線最多四種,顏色和線型同時區分;名稱與角色分兩種字級;節點之間至少留一個節點寬。不帶意義的裝飾一律不加,圖示與 logo 也不放(R7)。本頁的「運作流程」就是照 R14 重畫的第一張,附出圖腳本與正反兩面檢查。範例頁位元組不變,機器驗收 12 項全過。
v1.0.2(2026-11-01):修正兩個檢查工具的計算錯誤(例如緊貼中文的數字沒被讀到、一般長數字被誤當雜湊值、格式錯誤的模型直接崩潰),每項修正都附上自測案例;docs/EVIDENCE.md 新增「哪些規則由程式強制、哪些只靠流程」對照表,AGENTS.md 先寫事實、llms.txt 新增只讀路線。範例頁位元組不變。
v1.0.1(2026-11-01):新增「自畫像」(用本 repo 的方法畫本 repo,工程版+讀者版)並作為主圖;改寫本頁、新增英文版、開發者文件、llms.txt。能力本體(skill、程式庫、檢查工具、原範例)不變。
v1.0.0(2026-11-01):流程圖記號、預設跳線、稽核標準圖多一張流程圖、展示圖規則 R13(交叉不能像相接);機器驗收 12 項全過。完整內容見 CHANGELOG.md。
文件導覽
| 你想… | 讀這份 | 語言 |
|---|---|---|
| 快速知道它做什麼 | 本頁 | 中文 / English |
| 了解結構、流程、設計取捨、限制、人工驗收 | docs/DEVELOPER.md |
中文 |
| 讓 agent 開始建置 | AGENTS.md → docs/BUILD-SPEC.md |
英文 |
| 看哪些是實測、哪些沒宣稱 | docs/EVIDENCE.md |
英文 |
| 機器讀的索引(llms.txt 格式) | llms.txt |
英文 |
限制(摘要)
只在 Windows 11 + Node 24.22 + Python 3.12 實跑過;這一版沒有在瀏覽器裡重跑頁內幾何自檢,外觀也沒重新人工確認。完整清單見 開發者文件 · 範圍與限制。
上面列的方法規則不全由程式擋。程式擋的是「有填來源」「幾何」與讀者版的「發明數字」(只篩 3 位以上有效數字),「位元組可重現」由驗收控制 A1 檢查;「來源真的佐證這條線」「候選不唯一就不畫線」「缺口表由別人重審」「讀者版沒有改輕」「成對交付」都要靠流程與人審。每條規則由哪個檔哪一行執行,見 EVIDENCE · 規則執行表 (Enforcement map)。
作者
巴哲 BaChe(NathanBaChe)— 把自己日常用的 AI 工作系統整理成可分享的包。
授權
- 程式碼(
.mjs、.py,以及產出頁裡嵌入的程式):MIT,見LICENSE。 - 文件與其他內容(skill、規則、規格、紀錄、頁面文字與圖):CC BY 4.0,見
LICENSE-DOCS;轉用時請標示出處。 - 借用的外部材料(archify、sepia、diagram-design、anatomy 為 MIT;graphify 只借兩個概念):見
THIRD_PARTY_NOTICES.md。
Yorumlar (0)
Yorum birakmak icin giris yap.
Yorum birakSonuc bulunamadi
