From 6a273c4febad7016dd908dd7f09bb7d198ddd4cc Mon Sep 17 00:00:00 2001 From: Jeffery Date: Wed, 15 Jul 2026 18:27:43 +0800 Subject: [PATCH] =?UTF-8?q?docs(README):=20=E8=A3=9C=E4=B8=8A=20doc-funcs?= =?UTF-8?q?=20=E6=8C=87=E4=BB=A4=E6=AA=94=E6=A8=99=E9=A0=AD=E7=AF=84?= =?UTF-8?q?=E6=9C=AC=E8=AA=AA=E6=98=8E=E8=88=87=E7=9B=AE=E9=8C=84=E6=A8=B9?= =?UTF-8?q?=20templates=20=E5=B1=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f66dcd3..b667fcb 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,9 @@ doc/ │ ├── doc-docker/ # 對齊 docker-compose 註解（含 scripts/） │ │ ├── SKILL.md │ │ └── scripts/ -│ ├── doc-funcs/SKILL.md # 為 function 補齊 XML 文件 +│ ├── doc-funcs/ # 為 function 補齊 XML 文件、指令檔逐行註解（含 templates/） +│ │ ├── SKILL.md +│ │ └── templates/ # 指令檔開頭「用途／更新時間」標頭範本（command-header.md） │ ├── doc-issues-analyze-to-file/SKILL.md # 讀 issue → 需求文件 → 拆階段 issue → 實作草稿 → 交付留言 │ ├── doc-issues-analyze/SKILL.md # 讀來源 → 保存議題 → 小功能議題 → 排程實作 → PR │ └── doc-issues-sync/SKILL.md # 讀專案／議題 → 依工作目錄勾稽 TODO → 補 TODO／更新標籤 → 進度留言 @@ -178,7 +180,7 @@ rm -rf ~/.config/opencode/skills/doc-docker ~/.config/opencode/skills/doc-funcs ### `doc-funcs` -掃描目前專案所有可文件化的 function/method，建立 `.docs/doc-funcs-index.md` 與逐 function 草稿，再依草稿補齊 XML documentation comments；同時整理 `.gitea/workflows/readme.md` 的 workflow 說明、觸發條件與相關參數草稿，最後重建 README 專案列表、功能列表與使用範例。README 更新時間固定使用台灣時區（Asia/Taipei）與 `yyyy/MM/dd HH:mm:ss` 格式，專案列表會拆成「專案名稱／專案描述」、「專案名稱／參考專案列表」、「專案名稱／NuGet 套件列表」三張表，且專案名稱會連到 Gitea/GitHub 遠端上的專案資料夾；遇到跨專案或跨命名空間的同名型別時會在功能名稱補上模組/專案前綴，並會跳脫 Markdown 表格、link text、heading 中的 C# 泛型角括號，檢查功能列表連結與使用範例 anchor 一致後執行合適驗證。當使用者要補齊 function 文件、產生 XML doc、為每個 method 加 summary/param/remarks、整理 workflow README、建立 .docs 草稿，或提到 doc-funcs、function 文件化、workflow 文件化、XML documentation comments 時使用此 skill。 +掃描目前專案所有可文件化的 function/method，建立 `.docs/doc-funcs-index.md` 與逐 function 草稿，再依草稿補齊 XML documentation comments；指令檔（腳本／CI／部署設定檔）草稿開頭的「用途／更新時間」標頭固定依 `skills/doc-funcs/templates/command-header.md` 範本產生（依檔案類型選 `#` 或 `::`/`REM` 變體）；同時整理 `.gitea/workflows/readme.md` 的 workflow 說明、觸發條件與相關參數草稿，最後重建 README 專案列表、功能列表與使用範例。README 更新時間固定使用台灣時區（Asia/Taipei）與 `yyyy/MM/dd HH:mm:ss` 格式，專案列表會拆成「專案名稱／專案描述」、「專案名稱／參考專案列表」、「專案名稱／NuGet 套件列表」三張表，且專案名稱會連到 Gitea/GitHub 遠端上的專案資料夾；遇到跨專案或跨命名空間的同名型別時會在功能名稱補上模組/專案前綴，並會跳脫 Markdown 表格、link text、heading 中的 C# 泛型角括號，檢查功能列表連結與使用範例 anchor 一致後執行合適驗證。當使用者要補齊 function 文件、產生 XML doc、為每個 method 加 summary/param/remarks、整理 workflow README、建立 .docs 草稿，或提到 doc-funcs、function 文件化、workflow 文件化、XML documentation comments 時使用此 skill。 - **Claude Code / Antigravity**：`/jsc:doc-funcs` - **Codex**：`$doc-funcs`，或用 `/skills` 選單