建立與編輯文件
AB Projects 中的文件是具有完整版本歷程的 Markdown 頁面。建立與編輯都在附帶即時預覽的側邊面板中進行,而且每一項變更都會被記錄下來,因此團隊始終知道變更了什麼以及為什麼變更。
建立頁面
- 在專案的 文件 區域中,開始一個新頁面。為它指定一個標題、一個選擇性的上層路徑(預設為
/— 設定類似onboarding之類的值即可將它巢狀化),以及選擇性的標籤。 - 以 Markdown 撰寫內文。編輯器會在原始碼旁顯示即時預覽,讓您能在輸入時看到轉譯後的結果。
- 儲存以將頁面發佈至樹狀結構中。它會成為版本 1。
編輯頁面
- 開啟一個頁面並選擇 編輯(從頁面的動作功能表)。同一個面板會開啟並顯示目前的 Markdown。
- 編輯時必須填寫編輯註記。在儲存變更之前,您必須輸入一則簡短的註記,說明變更了什麼 — 若您留白,AB Projects 會要求您新增一則「讓您的團隊知道變更了什麼」。(新頁面不需要註記;編輯則需要。)
- 儲存會建立一個新版本,而非覆寫 — 先前的版本會被保留。
版本歷程與還原
- 每個頁面都會追蹤一個版本編號,以及最近的編輯者與時間。
- 從頁面的動作功能表開啟 歷程,即可查看過去的版本,每個版本都附有其編輯註記 — 因此每一項變更的「原因」都有記錄可循。
- 您可以從歷程清單還原較早的版本。還原會將該內容帶回成為目前的頁面(且其本身也會被記錄為一個新版本)。
刪除頁面
- 刪除可從頁面的動作功能表取得,刻意與「編輯/歷程」分開放置,以免被意外按到。
- 刪除會將頁面從樹狀結構中移除。請將它視為需謹慎處理的動作 — 當您只是需要變更內容時,請優先選擇編輯或還原,而非刪除。
提示
- 使用上層路徑建立清楚的結構(例如
engineering/runbooks),而非一份扁平的頁面清單。 - 撰寫有意義的編輯註記 — 它們是「歷程」所顯示的內容,也是團隊成員賴以理解變更而無需比對差異的依據。
- 儲存前,使用即時預覽檢查格式(標題、程式碼區塊、連結)。
- 若某次編輯出錯,請從「歷程」還原先前的版本,而非憑記憶重寫。
有了 Markdown、即時預覽、必填的編輯註記,以及具備還原功能的完整歷程,文件得以保持易於撰寫且變更安全。