From 4c2625e61532c8d3db0e42fa25225ac709707ba9 Mon Sep 17 00:00:00 2001 From: Jeffery Date: Thu, 18 Jun 2026 08:24:02 +0000 Subject: [PATCH] =?UTF-8?q?docs(doc-funcs):=20=E8=A3=9C=E5=BC=B7=E8=8D=89?= =?UTF-8?q?=E7=A8=BF=E6=AA=A2=E6=9F=A5=E8=88=87=E6=B8=85=E7=90=86=E6=B5=81?= =?UTF-8?q?=E7=A8=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- skills/doc-funcs/SKILL.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/skills/doc-funcs/SKILL.md b/skills/doc-funcs/SKILL.md index d586beb..835dcc3 100644 --- a/skills/doc-funcs/SKILL.md +++ b/skills/doc-funcs/SKILL.md @@ -16,10 +16,12 @@ description: 為目前專案的每個 function 建立 .docs/ 草稿並補齊 XML - 建議 ``：根據功能產生，不要只改寫方法名稱 - 建議 ``：每個參數的用途、限制、null/empty 行為（能從 code 推論才寫；不能確定就標註需人工確認） - 建議 ``：至少一個使用情境，描述何時呼叫、前置條件、結果或注意事項 -4. 所有草稿完成後，主 agent 要閱讀草稿並實作到原始碼。若是 C#，使用 XML documentation comments：``、``、``。註解盡量使用繁體中文；保留既有正確文件，僅補齊缺漏或明顯不足處；不要為了文件改變 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：``、``、``。註解盡量使用繁體中文；保留既有正確文件，僅補齊缺漏或明顯不足處；不要為了文件改變 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. 完成後執行合適的格式化/建置或至少語法驗證；若無法執行，說明原因。 ## 重要限制