From b0522c2b1752b4040bd1d9b77b738b1cb18aab8a Mon Sep 17 00:00:00 2001 From: Jeffery Date: Sat, 20 Jun 2026 15:45:25 +0000 Subject: [PATCH 1/2] =?UTF-8?q?docs(doc-funcs):=20=E8=AA=BF=E6=95=B4=20REA?= =?UTF-8?q?DME=20=E6=96=B9=E6=B3=95=E7=9B=AE=E9=8C=84=E6=A0=BC=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- skills/doc-funcs/SKILL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skills/doc-funcs/SKILL.md b/skills/doc-funcs/SKILL.md index d990bfa..a62e933 100644 --- a/skills/doc-funcs/SKILL.md +++ b/skills/doc-funcs/SKILL.md @@ -20,7 +20,7 @@ description: 為目前專案的每個 function 建立 .docs/ 草稿並補齊 XML 4. 在實作到原始碼之前,主 agent 必須檢查所有草稿內容是否以繁體中文為主、英文為輔,且沒有任何亂碼、編碼錯誤、不可讀字元或明顯破損文字。若發現問題,先修正草稿並重新檢查,通過後才能進入下一步。 5. 所有草稿完成且通過檢查後,主 agent 要閱讀草稿並實作到原始碼。若是 C#,使用 XML documentation comments:``、``、``。註解盡量使用繁體中文;保留既有正確文件,僅補齊缺漏或明顯不足處;不要為了文件改變 runtime 行為。 6. 若遇到大量 function,仍要分批持續處理,不要只做示範。若 token 或時間不足,先完成已列入 index 的批次,並在 .docs/doc-funcs-index.md 標記 pending。 -7. 補齊後,產生或更新專案根目錄的 README.md 功能目錄。功能目錄只列出所有專案內的公開方法(public method、public constructor、public extension method、public operator),並依專案名稱分組;每個公開方法必須包含方法名稱、功能描述、使用範例,以及該方法內直接呼叫的 internal/private/protected/private protected 方法清單(包含方法名稱、所屬型別、可見性與用途推論;若無則寫「無」)。功能目錄必須包含更新時間;若 README.md 已有既有內容,保留既有內容並以最小變更更新或新增功能目錄區塊。 +7. 補齊後,產生或更新專案根目錄的 README.md 功能目錄。功能目錄只列出所有專案內的公開方法(public method、public constructor、public extension method、public operator),並依專案名稱分組;每個公開方法固定佔兩行,第一行寫功能描述,第二行寫功能名稱與使用範例;README 功能目錄不必列出內部呼叫方法。功能目錄必須包含更新時間;若 README.md 已有既有內容,保留既有內容並以最小變更更新或新增功能目錄區塊。 8. README 功能目錄完成後,刪除本次產生的所有草稿與索引:`.docs/doc-funcs/` 與 `.docs/doc-funcs-index.md`。若 `.docs/` 內已無其他內容,可一併移除空的 `.docs/` 目錄;不得刪除使用者既有的 `.docs/` 其他檔案。 9. 完成後執行合適的格式化/建置或至少語法驗證;若無法執行,說明原因。 From 6ed770dfde3e2cdc2a9a832450e97cc3a3ec1715 Mon Sep 17 00:00:00 2001 From: Jeffery Date: Sat, 20 Jun 2026 15:46:31 +0000 Subject: [PATCH 2/2] =?UTF-8?q?docs(doc-funcs):=20=E9=80=A3=E7=B5=90=20REA?= =?UTF-8?q?DME=20=E5=8A=9F=E8=83=BD=E5=90=8D=E7=A8=B1=E5=88=B0=E5=8E=9F?= =?UTF-8?q?=E5=A7=8B=E7=A2=BC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- skills/doc-funcs/SKILL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skills/doc-funcs/SKILL.md b/skills/doc-funcs/SKILL.md index a62e933..2cc585d 100644 --- a/skills/doc-funcs/SKILL.md +++ b/skills/doc-funcs/SKILL.md @@ -20,7 +20,7 @@ description: 為目前專案的每個 function 建立 .docs/ 草稿並補齊 XML 4. 在實作到原始碼之前,主 agent 必須檢查所有草稿內容是否以繁體中文為主、英文為輔,且沒有任何亂碼、編碼錯誤、不可讀字元或明顯破損文字。若發現問題,先修正草稿並重新檢查,通過後才能進入下一步。 5. 所有草稿完成且通過檢查後,主 agent 要閱讀草稿並實作到原始碼。若是 C#,使用 XML documentation comments:``、``、``。註解盡量使用繁體中文;保留既有正確文件,僅補齊缺漏或明顯不足處;不要為了文件改變 runtime 行為。 6. 若遇到大量 function,仍要分批持續處理,不要只做示範。若 token 或時間不足,先完成已列入 index 的批次,並在 .docs/doc-funcs-index.md 標記 pending。 -7. 補齊後,產生或更新專案根目錄的 README.md 功能目錄。功能目錄只列出所有專案內的公開方法(public method、public constructor、public extension method、public operator),並依專案名稱分組;每個公開方法固定佔兩行,第一行寫功能描述,第二行寫功能名稱與使用範例;README 功能目錄不必列出內部呼叫方法。功能目錄必須包含更新時間;若 README.md 已有既有內容,保留既有內容並以最小變更更新或新增功能目錄區塊。 +7. 補齊後,產生或更新專案根目錄的 README.md 功能目錄。功能目錄只列出所有專案內的公開方法(public method、public constructor、public extension method、public operator),並依專案名稱分組;每個公開方法固定佔兩行,第一行寫功能描述,第二行寫功能名稱與使用範例;第二行的功能名稱需做成 Markdown 連結,導向 Gitea 上對應檔案的 function 起始行(例如 `https://gitea.example.com/owner/repo/src/branch//#L123`),若無法可靠解析遠端 URL、分支或行號才退回純文字功能名稱;README 功能目錄不必列出內部呼叫方法。功能目錄必須包含更新時間;若 README.md 已有既有內容,保留既有內容並以最小變更更新或新增功能目錄區塊。 8. README 功能目錄完成後,刪除本次產生的所有草稿與索引:`.docs/doc-funcs/` 與 `.docs/doc-funcs-index.md`。若 `.docs/` 內已無其他內容,可一併移除空的 `.docs/` 目錄;不得刪除使用者既有的 `.docs/` 其他檔案。 9. 完成後執行合適的格式化/建置或至少語法驗證;若無法執行,說明原因。