Community寫作與編輯github.com

pedro-oscar/shorts-ai

主動建立並精煉專案的領域模型。用於討論程式碼庫術語、撰寫或編輯 GLOSSARY.md,或記錄及編輯 ADR 時使用。

shorts-ai 是什麼?

此技能旨在協助開發者或 AI 代理在設計過程中主動建立並銳化專案的領域模型。它超越了單純閱讀詞彙表,專注於挑戰模糊術語、定義精確的領域語言,並及時記錄架構決策記錄 (ADR)。支援單一或多個領域情境的專案結構,透過 GLOSSARY-MAP.md 管理多個情境。平台無關,可應用於任何基於文本的協作環境。核心運作方式包括:即時比對術語與 GLOSSARY.md 的一致性、以具體情境壓力測試領域關係、交叉驗證程式碼與口頭描述的矛盾、以及依三項嚴格條件(難以逆轉、缺乏脈絡會令人困惑、涉及真實取捨)才建立 ADR。GLOSSARY.md 僅作為純詞彙表,不得包含實作細節。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/pedro-oscar/shorts-ai/tree/HEAD/.claude/skills/domain-modeling

Installed? Explore more 寫作與編輯 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

領域建模

在設計過程中主動建立並精煉專案的領域模型。這是主動的紀律:挑戰術語、發明邊界案例,並在術語或決策結晶化時立即撰寫詞彙表和記錄。(僅僅為了詞彙而閱讀 GLOSSARY.md 並非此技能:那是任何技能都能做到的單行習慣。此技能適用於你正在改變模型,而不只是消費它。)

檔案結構

大多數儲存庫只有單一情境:

/
├── GLOSSARY.md
├── docs/
│   └── adr/
│       ├── 0001-event-sourced-orders.md
│       └── 0002-postgres-for-write-model.md
└── src/

如果根目錄存在 GLOSSARY-MAP.md,則表示儲存庫有多個情境。該地圖指向每個情境的位置:

/
├── GLOSSARY-MAP.md
├── docs/
│   └── adr/                          ← 系統層級決策
├── src/
│   ├── ordering/
│   │   ├── GLOSSARY.md
│   │   └── docs/adr/                 ← 情境特定決策
│   └── billing/
│       ├── GLOSSARY.md
│       └── docs/adr/

懶惰地建立檔案:僅在你需要撰寫內容時才建立。如果不存在 GLOSSARY.md,則在首個術語確定時建立。如果不存在 docs/adr/,則在需要第一個 ADR 時建立。

工作階段期間

對照詞彙表提出挑戰

當使用者使用的術語與 GLOSSARY.md 中的既有語言衝突時,立即指出。「你的詞彙表將 'cancellation' 定義為 X,但你似乎指的是 Y。到底是哪一個?」

銳化模糊語言

當使用者使用模糊或負載過重的術語時,提出精確的規範術語。「你說 'account':你是指 Customer 還是 User?這是不同的東西。」

討論具體情境

當討論領域關係時,用特定情境進行壓力測試。發明能探究邊界情況的情境,迫使使用者對概念之間的界線精確描述。

與程式碼交叉參考

當使用者說明某件事如何運作時,檢查程式碼是否一致。如果發現矛盾,提出來:「你的程式碼會取消整個訂單,但你剛剛說可以部分取消。哪個是對的?」

即時更新 GLOSSARY.md

當一個術語確定後,立即更新 GLOSSARY.md。不要累積起來:在它們發生時就捕捉下來。使用 GLOSSARY-FORMAT.md 中的格式。

GLOSSARY.md 應完全不含實作細節。不要將 GLOSSARY.md 視為規格、草稿或實作決策的存放庫。它只是一個詞彙表,別無其他用途。

謹慎提供 ADR

唯有當以下三個條件皆成立時,才提議建立 ADR:

  1. 難以逆轉:日後改變主意的成本顯著
  2. 缺乏脈絡會令人困惑:未來的讀者會納悶「為什麼他們要這樣做?」
  3. 是真實取捨的結果:存在真正的替代方案,且你因特定原因選擇了其中一個

若缺少任何一項,則跳過 ADR。使用 ADR-FORMAT.md 中的格式。

Individual skills in this repo

This repo contains 3 individual skills — each has its own dedicated page.

相關技能