wiki-page-writer
使用 Mermaid 圖表產生技術文檔
建立全面的技術文檔需要大量時間和一致的格式。此技能可自動化 Wiki 頁面生成，包含基於證據的引用、深色模式 Mermaid 圖表，以及適用於 Claude、Codex 和 Claude Code 的 VitePress 相容結構。
下載技能 ZIP
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
開啟並開始使用
測試它
正在使用「wiki-page-writer」。 Document the authentication middleware in src/middleware/auth.ts
預期結果:
- 產生的文檔頁面包含：
- - 概述說明驗證流程和安全性模型
- - 顯示請求驗證生命週期的序列圖
- - 列出中介軟體函數及其說明的元件表格
- - 程式碼引用：(src/middleware/auth.ts:45)、(src/utils/jwt.ts:22)、(src/config/auth.ts:8)
正在使用「wiki-page-writer」。 Create documentation for the data pipeline in src/pipeline/
預期結果:
- 產生的文檔頁面包含：
- - 顯示資料流經管道階段的架構圖
- - 處理器階層和介面的類別圖
- - 含虛擬程式碼範例的實作詳細資訊
- - 來自 7 個來源檔案且具有具體行號的引用
安全審計
安全Static analyzer detected 34 patterns (external_commands, weak_crypto, reconnaissance) but all are FALSE POSITIVES. The skill contains only markdown documentation syntax with code blocks and YAML frontmatter examples. No executable code, network calls, or cryptographic operations exist. Safe for publication.
品質評分
你能建構什麼
記錄 CI/CD 管道架構
為 CI/CD 管道產生全面的文檔，包含顯示建置階段的序列圖、元件引用和部署流程視覺化。
建立開源功能文檔
為開源專案產生詳細的功能文檔，包含架構圖、API 參考表格，以及為社群貢獻者提供的程式碼路徑引用。
建構內部技術 Wiki
為工程團隊產生一致的內部文檔頁面，包含標準化的圖表、基於證據的引用和可搜尋的結構。
試試這些提示
為 [file path] 中的 [component name] 建立文檔頁面。包含概述、架構圖，並引用至少 3 個來源檔案及其行號。
為 [feature name] 功能撰寫全面的文檔。分析 [directory path] 中的所有檔案，建立 3 個以上的 Mermaid 圖表（序列圖、類別圖和流程圖），追蹤完整的資料流程，並使用 file:line 引用具體的程式碼路徑。
為 [module/service] 產生 API 參考文檔。包含帶參數和回傳類型的端點表格、程式碼區塊中的使用範例，以及顯示請求流程的序列圖。為每個端點引用實作檔案。
最佳實務
- 在記錄功能之前務必追蹤實際的程式碼路徑
- 在 Mermaid 圖表中使用一致的深色模式顏色以保持視覺一致性
- 為每個技術聲明引用具體的檔案路徑和行號
避免
- 在未閱讀實際實作程式碼的情況下對功能做出聲明
- 使用破壞深色模式渲染或 VitePress 相容性的 Mermaid 語法
- 產生沒有基於證據的來源引用的佔位符文檔