feat(doc-funcs): 先判斷語言並新增指令檔草稿、實作前詢問與實作後優化原始碼 #19

Merged
admin merged 1 commits from develop into master 2026-06-26 02:04:41 +00:00
Member

變更摘要

優化 doc-funcs skill,將流程重整為明確階段,並新增多項能力:

  • 先判斷語言:在產生任何草稿前,先判斷 repo 主要語言與生態,據此決定 function 註解格式(C# XML doc / JSDoc / docstring / Javadoc 等)。
  • 新增指令檔草稿:掃描範圍納入腳本(.sh/.ps1/.bat/.cmd/Makefile)與 CI/部署設定檔(CI workflow yaml、Dockerfile、docker-compose)。機制為「複製原檔 → 開頭補用途與更新日期 → 每行換行並逐行加註解 → 存成草稿 → 實作時覆蓋原檔」。
  • 草稿全部由 Sub Agent 產生:function 與指令檔各派一個 subagent,只寫草稿、不動原始碼。
  • 實作前詢問使用者方式:草稿完成後以 AskUserQuestion 提供「全部一起 / 逐個草稿 / 其他(使用者輸入)」三種實作方式。
  • 實作後優化原始碼:對本次被文件化的原始碼做保守的效能與排版優化,限定不改變對外行為並需驗證。

影響範圍

  • 僅影響 skills/doc-funcs/SKILL.md(skill 流程定義與 frontmatter description)。
  • 不影響其他 skill 或執行期程式碼。

重點檔案

  • skills/doc-funcs/SKILL.md:+138 / -48,重整為第 0~11 步的階段式流程並更新 description。

風險與注意事項

  • 新增的「實作後優化原始碼效能與排版」會改動使用者原始碼,已在 skill 內加上保守限制:只限本次被文件化檔案、需保持對外行為等價、每次優化後執行格式化/建置/測試驗證。
  • 指令檔草稿覆蓋原檔僅新增註解與用途/日期區塊,不變更指令邏輯。
## 變更摘要 優化 `doc-funcs` skill,將流程重整為明確階段,並新增多項能力: - **先判斷語言**:在產生任何草稿前,先判斷 repo 主要語言與生態,據此決定 function 註解格式(C# XML doc / JSDoc / docstring / Javadoc 等)。 - **新增指令檔草稿**:掃描範圍納入腳本(`.sh`/`.ps1`/`.bat`/`.cmd`/Makefile)與 CI/部署設定檔(CI workflow yaml、Dockerfile、docker-compose)。機制為「複製原檔 → 開頭補用途與更新日期 → 每行換行並逐行加註解 → 存成草稿 → 實作時覆蓋原檔」。 - **草稿全部由 Sub Agent 產生**:function 與指令檔各派一個 subagent,只寫草稿、不動原始碼。 - **實作前詢問使用者方式**:草稿完成後以 AskUserQuestion 提供「全部一起 / 逐個草稿 / 其他(使用者輸入)」三種實作方式。 - **實作後優化原始碼**:對本次被文件化的原始碼做保守的效能與排版優化,限定不改變對外行為並需驗證。 ## 影響範圍 - 僅影響 `skills/doc-funcs/SKILL.md`(skill 流程定義與 frontmatter description)。 - 不影響其他 skill 或執行期程式碼。 ## 重點檔案 - `skills/doc-funcs/SKILL.md`:+138 / -48,重整為第 0~11 步的階段式流程並更新 description。 ## 風險與注意事項 - 新增的「實作後優化原始碼效能與排版」會改動使用者原始碼,已在 skill 內加上保守限制:只限本次被文件化檔案、需保持對外行為等價、每次優化後執行格式化/建置/測試驗證。 - 指令檔草稿覆蓋原檔僅新增註解與用途/日期區塊,不變更指令邏輯。
jiantw83 added 1 commit 2026-06-26 01:59:29 +00:00
admin approved these changes 2026-06-26 02:04:38 +00:00
admin merged commit c8477d5cdf into master 2026-06-26 02:04:41 +00:00
Sign in to join this conversation.
No Reviewers
No labels
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: plugins/doc#19