Merge pull request 'docs(doc-funcs): 補強草稿檢查與清理流程' (#7) from develop into master

Reviewed-on: #7
Reviewed-by: 系統管理員 <1+admin@noreply.localhost>
This commit was merged in pull request #7.
This commit is contained in:
2026-06-18 08:28:50 +00:00
+6 -4
View File
@@ -16,10 +16,12 @@ description: 為目前專案的每個 function 建立 .docs/ 草稿並補齊 XML
- 建議 `<summary>`:根據功能產生,不要只改寫方法名稱
- 建議 `<param>`:每個參數的用途、限制、null/empty 行為(能從 code 推論才寫;不能確定就標註需人工確認)
- 建議 `<remarks>`:至少一個使用情境,描述何時呼叫、前置條件、結果或注意事項
4. 所有草稿完成後,主 agent 要閱讀草稿並實作到原始碼。若是 C#,使用 XML documentation comments`<summary>``<param>``<remarks>`。註解盡量使用繁體中文;保留既有正確文件,僅補齊缺漏或明顯不足處;不要為了文件改變 runtime 行為
5. 若遇到大量 function,仍要分批持續處理,不要只做示範。若 token 或時間不足,先完成已列入 index 的批次,並在 .docs/doc-funcs-index.md 標記 pending
6. 補齊後,產生或更新專案根目錄的 README.md 功能目錄。功能目錄必須包含更新時間、功能名稱、使用範例;若 README.md 已有既有內容,保留既有內容並以最小變更更新或新增功能目錄區塊
7. 完成後執行合適的格式化/建置或至少語法驗證;若無法執行,說明原因
4. 在實作到原始碼之前,主 agent 必須檢查所有草稿內容是否以繁體中文為主、英文為輔,且沒有任何亂碼、編碼錯誤、不可讀字元或明顯破損文字。若發現問題,先修正草稿並重新檢查,通過後才能進入下一步
5. 所有草稿完成且通過檢查後,主 agent 要閱讀草稿並實作到原始碼。若是 C#,使用 XML documentation comments`<summary>``<param>``<remarks>`。註解盡量使用繁體中文;保留既有正確文件,僅補齊缺漏或明顯不足處;不要為了文件改變 runtime 行為
6. 若遇到大量 function,仍要分批持續處理,不要只做示範。若 token 或時間不足,先完成已列入 index 的批次,並在 .docs/doc-funcs-index.md 標記 pending
7. 補齊後,產生或更新專案根目錄的 README.md 功能目錄。功能目錄必須包含更新時間、功能名稱、使用範例;若 README.md 已有既有內容,保留既有內容並以最小變更更新或新增功能目錄區塊
8. README 功能目錄完成後,刪除本次產生的所有草稿與索引:`.docs/doc-funcs/``.docs/doc-funcs-index.md`。若 `.docs/` 內已無其他內容,可一併移除空的 `.docs/` 目錄;不得刪除使用者既有的 `.docs/` 其他檔案。
9. 完成後執行合適的格式化/建置或至少語法驗證;若無法執行,說明原因。
## 重要限制