20 lines
2.4 KiB
Markdown
20 lines
2.4 KiB
Markdown
---
|
||
name: spec-doc-funcs-handoff
|
||
description: JSC plugins 共用「串接 funcs 文件化流程」規範：code 類 skill（action 標準化、Dockerfile 整理）完成主要工作後，對整個目標專案完整執行 /jsc-doc:funcs（前置可用性檢查、完整流程步驟、由使用者裁示實作方式、完成後統一時間戳）。當其他 skill 內文引用 spec-doc-funcs-handoff 或 /jsc-shared:spec-doc-funcs-handoff、或某 skill 的最後階段要完整執行 funcs 補文件並重建 README 時載入此 skill。單獨被使用者呼叫時，直接說明本規範內容。
|
||
---
|
||
|
||
# spec-doc-funcs-handoff — 共用「串接 funcs」流程
|
||
|
||
code 類 skill 完成主要工作（action 標準化、容器化、Dockerfile 整理等）後，對**整個目標專案**完整執行 `/jsc-doc:funcs` 流程，替程式碼與指令檔補文件並重建 README。
|
||
|
||
## 流程
|
||
|
||
- **前置檢查**：先確認 funcs skill 可用（`/jsc-doc:funcs`）；不可用則回報並**略過本階段**，於總結標註「未文件化」。
|
||
- 以呼叫端 skill 的目標專案根目錄為目標，執行 `funcs` skill 的完整流程：判斷語言 → 掃描 function 與指令檔 → 建立 `.docs/` 草稿 → 草稿品質檢查 → 詢問使用者如何實作 → 依選擇寫回 → 保守優化 → 重建 README → 錨點檢查 → 清理草稿 → 建置／語法驗證。
|
||
- funcs 會把 `action.yml`／`Dockerfile`／`entrypoint.sh`／`docker-compose*` 等視為指令檔／CI／部署設定檔處理：補齊「用途＋更新日期同一註解區塊」與逐行註解；`steps` 引用的腳本（`*.sh`／`*.ps1` 等）逐行註解；專案內各 function 補文件註解。
|
||
- funcs 的「如何實作」詢問（全部一起／逐個／其他）由使用者於該流程內裁示，呼叫端 skill **不代為決定**。
|
||
- 完成後依 funcs 規範重建根目錄 `README.md`（含台灣時區更新時間、專案列表、功能列表、使用範例）。
|
||
- **統一時間戳**：funcs 全部完成後，以完成當下的 Asia/Taipei 時間（`yyyy/MM/dd HH:mm:ss`）回頭同步呼叫端 skill 產生的各處時間戳（橫幅 step／`entrypoint.sh`／標頭註解區塊／README），**確保各處一致**（格式見 `/jsc-shared:spec-time-log`）。
|
||
|
||
> 銜接方式：在呼叫端 skill 環境中以 `/jsc-doc:funcs`（或 Skill 工具）啟動 funcs 流程；若該流程需參數，沿用呼叫端 skill 的目標專案根目錄。
|