內容創作
ring:documentation-structure
專業文件架構的標準與模式,涵蓋內容層級、易讀頁面設計、導航策略及 AI 技術寫作品質檢查清單。
簡介
此技能提供了一套穩健的框架,用於建構技術文件,確保內容易於存取、掃描,並根據使用者任務而非內部系統架構進行邏輯組織。專為技術寫作人員、軟體工程師以及負責維護專案知識庫、API 參考文件和使用指南的 AI 代理所設計。透過強制執行特定模式,降低使用者的認知負擔並提升資訊檢索效率。
-
內容層級:實作標準化的樹狀結構,從歡迎頁面到 API 參考與更新日誌。
-
頁面結構模式:定義總覽、概念性文件與任務導向指南的特定模板。
-
導航策略:提供麵包屑、順序性「上一篇/下一篇」導航以及頁面內區段連結的規則。
-
資訊密度:設定易讀性標準,包括條列式項目、表格與關鍵術語加粗的準則。
-
漸進式揭露:鼓勵先放置核心資訊,後續再補充進階設定與邊緣情況。
-
品質保證:包含強制性的檢查清單,以防止出現孤兒頁面並確保內容相關性。
-
交互連結策略:優化內部連結配置,避免過度連結,同時確保概念文件與 API 端點間的順暢切換。
-
嚴格依照使用者心智模型與任務組織內容,而非依照系統組件。
-
強制使用區段分隔線 (---) 來區隔主要主題並提升可讀性。
-
總覽頁面必須包含子內容的連結清單,以防止導航死胡同。
-
在重組前,請先確認現有的資訊架構並確保內容盤點完成。
-
使用表格進行結構化比較,使用列表處理序列性的任務步驟。
-
務必在程式碼範例引用後立即提供說明。
倉庫統計
- Star 數
- 180
- Fork 數
- 20
- Open Issue 數
- 7
- 主要語言
- Python
- 預設分支
- main
- 同步狀態
- 閒置
- 最近同步時間
- 2026年4月29日 上午08:35