工程開發
documentation
撰寫、建構與維護技術文件,涵蓋 README、API 文件、操作手冊與架構規範,協助團隊保持一致性與資訊同步。
簡介
此技能作為專屬技術撰寫人員,使 Claude 能夠生成、組織並維護高品質的工程文件。它專為需要將複雜系統行為或操作需求轉換為可讀、可執行格式的軟體開發人員、系統架構師與技術主管而設計。透過遵循既定的文件標準,此技能確保技術知識能在團隊中有效共享,進而縮短入職時間並降低維護成本。
-
自動生成包含專案目的、配置步驟與貢獻指南的 README 檔案。
-
建構包含端點參照、驗證細節、速率限制以及請求/回應範例的完整 API 文件。
-
制定操作手冊,概述事件響應中的先決條件、逐步程序、回滾步驟與升級路徑。
-
建立架構決策記錄 (ADR),記錄高階設計、權衡分析、數據流與整合點。
-
製作包含環境設定、系統對應圖與常用工作流程導覽的入職指南,協助新團隊成員快速上手。
-
強制執行文件編寫原則,例如針對讀者進行調整、優先呈現關鍵資訊、使用清晰範例,並維持單一真實來源。
-
提供上下文或程式碼片段作為輸入以生成精準且相關的草稿;此技能擅長將原始開發數據轉化為精煉的文字。
-
始終秉持「演示勝過說明」的原則,適當時加入終端指令、SDK 用法與系統圖表。
-
定期根據實際的程式碼庫或基礎架構審核現有文件,確保其時效性。
-
採用交互參照與連結而非複製內容,以降低維護心力並維持高準確度。
-
適用於多種格式,包括 Markdown、OpenAPI 規格書或內部維基頁面。
-
限制:當提供具體的技術上下文或原始檔案時,此技能表現最佳;請確保在共享用於文件處理的內容之前,已移除 API 金鑰或內部憑證等敏感資料。
倉庫統計
- Star 數
- 11,687
- Fork 數
- 1,363
- Open Issue 數
- 91
- 主要語言
- Python
- 預設分支
- main
- 同步狀態
- 閒置
- 最近同步時間
- 2026年4月30日 上午08:38