參與
從最小的一步開始
最常見的誤解是「要寫一篇完整的技能才叫貢獻」。不是的。 這裡有四個階梯,第一階完全不需要碰 Git,五分鐘就能做完。
階梯
挑一個你現在做得到的
用講的投稿
把你的實務經驗用自己的話寫下來 —— 一段也好。格式、分類、frontmatter 全部交給維護者整理。 這是最歡迎、也最缺的一種貢獻,因為經驗只有你有,格式誰都能補。
開一則知識投稿回報或修正一個錯誤
發現法規條號過期、數字有誤、連結壞掉、錯字 —— 直接在 GitHub 上點編輯改掉送出, 或開一則 issue 講一聲。指出錯誤和寫新內容一樣有價值, 尤其在一個會被拿去當判斷依據的庫裡。
回報問題補一個缺掉的欄位
知識庫裡有一批技能缺適用地區、適用對象、授權與相容性標示。 這些任務範圍明確、不需要從零寫起,很適合當第一次送 PR 的練習。 需要補什麼,狀況頁上一筆一筆列著。
看最需要補的清單寫一個技能模組
你最熟的那個題目 —— 送審流程、某條法規的實務陷阱、某個標章的計算眉角。
複製 知識樣板/ 當起點,寫 domain.md(人讀)加
SKILL.md(AI 讀)。建議用 AI 輔助整理格式。
現在最需要
如果你不知道從哪裡下手
這幾個缺口是掃描 raw/ 直接算出來的,不是人工維護的許願清單。
點進去就是具體的檔案。
回頭看一眼久沒更新的內容
法規會修。有一批技能已經好幾個月沒有人動過,內容可能已經跟現行規定脫節。 你不需要重寫 —— 對照現行法規讀一遍,不對就修,順手把缺掉的欄位補齊。 這是專業人士最能發揮、也最難被取代的貢獻。
看最久沒更新的清單 → B 類技能把國際規範適配到台灣
有一批技能標著 TODO: Taiwan adaptation needed ——
內容是國際通用做法,但還沒對應到台灣的法規與慣例。
知道台灣這邊實際怎麼做的人,補上去就行。
把只有骨架的說明寫厚
有一批 domain.md 只有幾行,讀的人看不出這個技能實際能幫上什麼。
補使用情境、補一個實務例子、補常踩的坑 ——
這種貢獻不需要新知識,只需要你講一次自己平常怎麼做。
專案管理 · 經營管理
這兩個分類在 README 裡列著,但目前一個技能都沒有。 時程、預算、契約、事務所營運、專業倫理 —— 如果這是你的領域,這裡是一整片空地。
看各分類進度 →送 PR 前,先過這幾關
完整規則在 CONTRIBUTING.md, 這裡是最常踩到的幾條。
命名:上層中文,最底層英文
分類與知識入口用繁體中文,AI 技能資料夾一律小寫英文加連字號,而且必須是英文翻譯,不能用拼音。
✅ 建築法規/消防安全/排煙窗法規檢討/smoke-exhaust-review/SKILL.md
❌ .../pai-yan-chuang/SKILL.md ← 拼音不收
frontmatter:name 必須等於資料夾名稱
SKILL.md 的 name 要跟它所在的英文資料夾完全一致,
description 要寫出具體的觸發情境,AI 才知道什麼時候該叫用它。
建立新知識時,直接複製 知識樣板/ 當起點最不容易出錯。
保密邊界(這條最重要)
不要上傳任何未經授權的業主資料、案件圖說、契約、報價或個資。 這個庫收的是產業的公共判準,不是你的案子。 如果一段內容只有你的客戶適用,那它不屬於這裡; 把它抽象成通則之後再寫進來。
正確性優先於數量
引用法規請附條號與來源,不確定的地方請明白標示不確定 —— 這個庫寧可少收一篇,也不要收一篇看起來很篤定卻沒有依據的內容。 詳見品質與免責。
你的貢獻會怎麼被處理
- 開 issue 或送 PR —— 兩種都可以,用講的也行
- 維護者審閱 —— 檢查格式、命名、保密邊界與內容合理性
- 自動驗證 ——
scripts/validate_okf.py檢查 OKF 格式是否完整 - 合併並署名 —— 你的 GitHub 帳號會出現在貢獻者名單與更新紀錄裡
貢獻即表示你同意內容以 CC BY-SA 4.0(文字)與 Apache 2.0(程式碼)授權釋出, 並確認你有權釋出這些內容。