Skip to content
所有文章 ‹ Part 04 of 08 · AI 時代,文件怎麼活下來:大道至簡
工程 · 3 min read

嚴格規則只給機器能檢查的

把團隊文件對照 Diátaxis 四種類型,現況和歷史分開放。只有工具檢查得了的,才當嚴格規則,其他都是大家的習慣與默契。

我們其實已經有文件類型,只是沒人這樣叫它。

Diátaxis 用兩個問題替文件分類:讀者是要動手做事,還是想搞懂原理?是第一次學,還是工作中查?拿我們自己的檔案走一遍:

Q1 讀者是要動手做事,還是想搞懂原理? 動手做 Q2 第一次學,還是工作中查? 搞懂原理 Q2 第一次學,還是工作中查? 第一次學TutorialREADME Quick Start 工作中查How-to guideRUNBOOK 第一次學ExplanationARCHITECTURE · PRD 工作中查ReferenceAPI 文件
把一份檔案丟進這兩個問題,就知道它是哪一類。

把我們的檔案對照這四種類型,一看就清楚。

我們的檔案Diátaxis 類型放在讀者
README Quick Starttutorial:做中學repo工程師、AI agent
RUNBOOKhow-to:完成一件事repo工程師、AI agent
ARCHITECTUREexplanation:為什麼這樣做repo工程師、AI agent
ADR決策紀錄repo工程師、AI agent
API 文件(從程式碼產生)reference:查事實repo所有人
PRD / 總覽explanation團隊 wikiPM 與業務角色、新進成員

現況和歷史,分開放

  • 現況文件:README、ARCHITECTURE。只留最新版,直接改。今天必須是對的。
  • 歷史文件:ADR、日誌。只新增。新的一筆取代舊的,舊的不改。

這對應記憶的兩種類型:「現在什麼是真的」和「什麼時候發生了什麼」。

規則分兩種:機器擋得住的,和只能靠人提醒的

第一種,機器檢查得了。每次 push 都跑 CI,文件不合格,build 就失敗,沒人能忘記。例如:必填欄位(owner、日期)存在、連結沒壞、檔案放在對的資料夾、Markdown 格式正確。

第二種,只有人看得出來。工具判斷不了寫得夠不夠細、是不是寫給對的讀者。這種只能大家同意,再由 reviewer 在 code review 時提醒。例如:要寫多細、寫給誰、用字白不白話、ADR 模板(Status、Date、Author,然後 Context → Decision → Consequences)。

習慣:大家同意→ reviewer 提醒寫多細 · 寫給誰白話用字 · ADR 模板 加一個工具例:commit message 檢查 嚴格:工具檢查→ 不合格就 build 失敗必填欄位 · 連結資料夾 · Markdown 格式
工具檢查得了,習慣才會變成規則。

沒人能檢查的規則,就沒人遵守。然後大家連其他規則都不信了。所以嚴格那一邊要短。

習慣也可以搬到嚴格那一邊,只要加一個工具。commit 格式 <type>: <title> (TICKET-123) 就是例子:加上 commit message 檢查,它就從習慣變成規則。這個檢查在哪裡跑,見讓文件活著:三個提醒,單向流動。

降低認知負擔

資深工程師都知道的習慣,不用寫進我們的文件。標準只連結一次,例如 Conventional Commits 和 ADR 模板。不要重寫。新進成員和 AI agent 會跟著連結走。

沒有 owner 和日期這類欄位,就沒人看得出文件已經過期。要選哪些欄位,交給團隊決定:owner、最後確認日期、狀態、讀者、工單編號(Jira、Linear)、tag、到期日。

機器能檢查的才叫規則,其他的叫默契。

參考來源


延伸閱讀: 看看名字怎麼承載意義,以及這些檢查在哪裡跑。或回到系列總覽:AI 時代,文件怎麼活下來

↑↓ 移動 ↵ 開啟 esc 關閉