feat(doc-funcs): 新增區塊階段命名與一行一則訊息輸出規則並 bump 至 0.0.9 #23

Merged
admin merged 2 commits from develop into master 2026-06-30 09:15:11 +00:00
4 changed files with 6 additions and 4 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "jsc",
"version": "0.0.8",
"version": "0.0.9",
"description": "JSC 文件化 skillsClaude Code / Codex / Antigravity / OpenCode):doc-docker 會整理 docker-compose.yaml 的行內註解與標題日期;doc-funcs 會為專案 functions 建立 .docs 草稿、補齊 XML 文件註解並重建 README 功能列表與使用範例。所有 skills 以 SKILL.md 為共通標準,於 Claude Code 以 /jsc: 前綴呼叫。",
"skills": "./skills",
"author": {
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "jsc",
"version": "0.0.8",
"version": "0.0.9",
"description": "JSC 文件化 skillsdoc-docker 會整理 docker-compose.yaml 的行內註解與標題日期;doc-funcs 會為專案 functions 建立 .docs 草稿、補齊 XML 文件註解並重建 README 功能列表與使用範例。所有 skills 以 SKILL.md 為共通標準。",
"skills": "./skills"
}
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "jsc",
"version": "0.0.8",
"version": "0.0.9",
"description": "JSC 文件化 skillsdoc-docker 會整理 docker-compose.yaml 的行內註解與標題日期;doc-funcs 會為專案 functions 建立 .docs 草稿、補齊 XML 文件註解並重建 README 功能列表與使用範例。所有 skills 以 SKILL.md 為共通標準;於 Antigravity 以 /jsc: 前綴呼叫。",
"skills": "./skills/"
}
+3 -1
View File
@@ -84,6 +84,8 @@ description: 先判斷專案語言,再為每個 function 與每個指令檔(
- 若選「逐個草稿實作」,每完成一個就回報並等待使用者確認。
- 若遇到大量目標,仍要分批持續處理,不要只做示範。若 token 或時間不足,先完成已列入 index 的批次,並在 `.docs/doc-funcs-index.md` 標記 pending。
- 輸出訊息格式:若該 function 有輸出訊息(例如 log、console 輸出、回傳給使用者的提示訊息),訊息格式必須統一為 `[{階段(英文名稱)?}][{等級:INF/WRN/ERR/TRC/DBG}][{時間}]: {訊息}`。其中 `階段` 為選填(英文名稱,無對應階段時可省略整個 `[{階段}]` 區塊);`等級` 必須是 `INF`/`WRN`/`ERR`/`TRC`/`DBG` 其中之一;`時間` 使用台灣時區(Asia/Taipei)。調整輸出訊息格式時僅限本次被文件化的原始碼,且不得改變訊息所反映的實際行為或判斷邏輯。
- 區塊內 log 的階段命名:若被調整格式的 log 被包在某個有名稱的區塊內(例如 `#region 名稱`/`#endregion`、或其他帶名稱的包裹結構),必須將該區塊名稱作為該 log 的 `階段` 名稱(轉為英文名稱),套用完成後移除該包裹區塊本身(僅移除區塊的標記與包裹,保留區塊內原有的指令與行為)。
- 一行一則訊息:每一則輸出訊息都必須是獨立的單行輸出指令,一則訊息對應一行;不得用任何區塊(例如多行字串、字串拼接累積成一坨、迴圈外層包住整段訊息的結構)把多則訊息包成一個輸出。原本被包成一坨輸出的多則訊息,必須拆成逐行、逐則的輸出,且每則仍套用上述統一訊息格式。
## 第 7 步:實作註解後,優化被文件化原始碼的效能與排版
@@ -144,6 +146,6 @@ README 錨點檢查通過後,刪除本次產生的所有草稿與索引:`.do
- 草稿是實作依據,不能跳過;所有草稿一律由 subagent 產生。
- function 註解步驟不得為了文件改變 runtime 行為;效能優化僅限第 7 步、僅限本次被文件化原始碼,且必須保持對外行為等價並驗證。
- 指令檔草稿只新增註解與開頭用途/日期區塊,不得變更指令邏輯;指令檔開頭的用途與更新日期必須包在同一個註解區塊內。
- function 若有輸出訊息,訊息格式必須統一為 `[{階段(英文名稱)?}][{等級:INF/WRN/ERR/TRC/DBG}][{時間}]: {訊息}``階段` 選填、`等級``INF`/`WRN`/`ERR`/`TRC`/`DBG``時間` 用 Asia/Taipei 時區),且不得藉此改變訊息反映的實際行為。
- function 若有輸出訊息,訊息格式必須統一為 `[{階段(英文名稱)?}][{等級:INF/WRN/ERR/TRC/DBG}][{時間}]: {訊息}``階段` 選填、`等級``INF`/`WRN`/`ERR`/`TRC`/`DBG``時間` 用 Asia/Taipei 時區),且不得藉此改變訊息反映的實際行為。若該 log 被包在有名稱的區塊內,須將區塊名稱當作 `階段` 名稱後移除該包裹區塊,且僅移除包裹、保留區塊內原有指令與行為。每則訊息必須一行一則、各自為獨立的單行輸出指令,不得用區塊或字串拼接把多則訊息包成一坨輸出。
- 若 function 或指令行為無法可靠推論,文件中要保守描述並標註不確定點,不要編造。
- 原始碼註解與 README 盡量使用繁體中文;專有名詞、API 名稱、型別名稱與程式碼範例可保留英文。