從來源直接安裝技能的最快方式。
npx clawhub@latest install documentation
將技能資料夾複製到以下位置之一
~/.openclaw/skills/ <project>/skills/ 優先級:工作區 > 本地 > 內建
將此提示詞複製到 OpenClaw 即可自動安裝。
請幫我使用 Clawhub 安裝 documentation。如果尚未安裝 Clawhub,請先安裝(npm i -g clawhub)。
取得包含原生技能檔案的ZIP壓縮檔。
Openclaw Skills 的文檔技能為技術寫作提供了一套嚴謹的模式和標準。它專注於建立從 README 到詳盡 API 參考的功能層級,確保用戶能在幾分鐘內獲得成功。通過實施這些標準,團隊可以避免常見的文檔失敗,如過時的代碼示例、上下文假設以及導致用戶流失的長篇大論。該技能確保您的技術內容與您的代碼一樣專業可靠。
此外,該技能強調「文檔即代碼」的方法,以對待軟件開發的細緻程度來對待文檔。這包括版本控制、同行評審以及示例的自動化測試,以確保通過 Openclaw Skills 提供給社區的信息在整個軟件生命週期中保持準確且可操作。
要使用 Openclaw Skills 實施這些模式,請在您的代碼庫中集成 markdown linter 和鏈接檢查器。使用以下命令開始:
npm install markdown-link-check --save-dev
# 對主文檔文件運行檢查
npx markdown-link-check README.md
確保您的文件結構遵循將文檔與代碼保存在同一存儲庫中的模式,以防止文檔漂移。
文檔結構被組織成清晰的分類體系,以最大限度地提高 Openclaw Skills 列表中的可用性和搜索引擎發現率:
| 組件 | 描述 | 格式 |
|---|---|---|
| README.md | 入口點、安裝、快速入門和問題描述 | Markdown |
| /docs/v{n}/ | 針對重大軟件版本的版本化文檔目錄 | 目錄 |
| API 參考 | 方法、路徑和參數的詳盡技術規範 | Markdown 表格 |
| 疑難解答 | 逐字記錄的錯誤消息配以可操作的解決方案 | Markdown 列表 |
| 代碼示例 | 經過測試的可運行腳本,包括導入和版本鎖定的包 | 代碼塊 |
加載中







































