文件規劃工具 是做什麼的?
識別文件網站中的內容缺口,並產出優先排序的工作清單。
輸入
- 範圍 (Scope):要評估的區域 — 所有文件、特定區塊或功能領域。預設值:全部。
- 訊號 (Signals)(選填):GitHub 問題、社群提問、支援串。
- 競爭背景 (Competitive context)(選填):競爭對手有文件而我們沒有的內容。
流程
步驟 1:盤點目前文件
讀取 site/src/config/navigation.yml 以取得完整的導覽樹 — 這是 Astro 網站的權威導覽來源,由 site/astro.config.mjs 透過 site/src/sidebar.ts 載入。使用 glob 模式 site/src/content/docs/**/*.{md,mdx} 取得所有內容檔案。根據內容類型(教學、操作指南、參考、說明、混合)和涵蓋區域(快速入門、工具、代理程式、多代理程式、部署等)進行分類。
步驟 2:識別缺口
將盤點結果與以下項目進行比較:
- SDK 功能面:所有主要功能是否都有文件?沒有文件頁面的功能即為缺口。
- Diataxis 完整性:針對每個功能區域,是否四種文件類型都存在?一個功能只有參考但沒有教學即為缺口。
- 社群訊號:如果 GitHub CLI 可用,從 strands-agents/harness-sdk 中提取標記為「documentation」的開放問題。將問題映射到現有文件(不清楚/難找)或缺失的文件(內容缺口)。
- 競爭比較(如有提供):LangChain、CrewAI、Anthropic 和 OpenAI 對等效功能有哪些文件是我們沒有的?
步驟 3:優先排序
根據開發者影響力和實作難度為每個缺口評分:
- P0(立即處理):高影響力,任何難度。快速入門、入門指南、核心概念。
- P1(盡快處理):中等影響力,低難度。常見任務缺少的操作指南。
- P2(規劃處理):中等影響力,高難度。新的教學、架構說明。
- P3(待辦事項):低影響力。小眾情境、邊緣案例文件。
步驟 4:產出待辦清單
以 Markdown 輸出:
## 文件待辦清單:[範圍]
**產出日期:**[日期]
**盤點頁數:**[數量]
**識別缺口數:**[數量]
### P0:立即處理
- [ ] [任務] — [內容類型] — [目標頁面] — [理由]
### P1:盡快處理
- [ ] [任務] — [內容類型] — [目標頁面] — [理由]
### P2:規劃處理
- [ ] [任務] — [內容類型] — [目標頁面] — [理由]
### P3:待辦事項
- [ ] [任務] — [內容類型] — [目標頁面] — [理由]
### 覆蓋率矩陣
| 功能區域 | 教學 | 操作指南 | 參考 | 說明 |
|---|---|---|---|---|
| 代理程式基礎 | Y | ~ | Y | N |
| 自訂工具 | Y | Y | Y | N |
| 多代理程式 | ~ | N | Y | ~ |
### 訊號驅動洞察
- [從社群訊號映射到特定文件缺口的議題]
此技能不負責的工作
- 不撰寫文件(請使用 docs-writer)
- 不需要外部訊號管道(僅需本地盤點即可運作)
- 不會在外部工具中自動建立任務