tasks-documentation

tasks-documentation 技能為開發人員和技術撰稿人提供了一個結構化的框架，用於維護高品質的項目文檔。它旨在通過為代碼級文檔和項目級概述提供標準化模式，來彌合實現與溝通之間的差距。通過專注於一致性，它確保您的儲存庫保持可讀性、可維護性並可供其他團隊成員存取。該技能特別適用於在 C# 和 TypeScript 環境中工作的工程團隊，儘管其模式也適用於各種現代軟體堆疊。

• 生成全面的 C# XML 文檔，包括諸如 summary、remarks 和 example 部分等複雜標籤，以改善 IntelliSense 和 API 清晰度。

• 創建專業的 TypeScript JSDoc 註釋，支持高級文檔需求，包括示例用法、參數描述和類型文檔。

• 為 REST 控制器生成標準化的 API 文檔，詳細說明請求/響應架構、錯誤代碼定義和端點描述。

• 提供結構化的 README 模板，包括架構圖、安裝指南和使用示例，以簡化項目導入流程。

• 通過一致的 TODO 和 FIXME 註釋模式促進技術債的文檔化，允許團隊有效跟蹤和解決問題。

• 通過提供數據流描述和組件圖大綱的框架來支持架構文檔化。

• 此技能專門用於編寫和生成文檔。它不應用於高層次的文檔規劃或策略藍圖設計；對於此類任務，請使用指定的文檔規劃技能。

• 輸入通常涉及原始代碼片段、函數定義或架構概念；輸出是格式化、隨時可用的文檔文本，遵守行業最佳實踐。

• 確保生成的所有文檔都遵循項目既定的樣式指南；雖然此技能提供了強大的模板，但建議進行人工審查以驗證複雜邏輯場景下的準確性。

• 使用此技能保持 README 文件與代碼更改同步，確保技術債得到跟蹤，並確保對外 API 接口始終正確註釋專業級的文檔。