@chenmk/superflow 0.1.0

package/assets/skills/api-doc-changelog/SKILL.md

@@ -0,0 +1,193 @@
+---
+name: api-doc-changelog
+description: >
+  规范 API 联调文档（api.md）的变更标注格式。当编写或更新前后端联调接口文档时，
+  自动在接口和字段级别标注变更类型，让前端 agent 一眼看出两个版本之间改了什么。
+  适用于：写 api.md、更新 api.md、推送飞书前检查文档、SuperBridge Flow 流程生成接口设计。
+  触发词：api文档变更、接口变更标记、changelog、联调文档更新、接口变更标注、
+  变更追踪、接口diff、版本变更、提测文档。
+---
+
+# API 文档变更标注规范
+
+## 为什么需要这个规范
+
+每次提测新版本时，前端 agent 需要快速回答三个问题：
+1. 这次新增了哪些接口？
+2. 哪些接口的参数/返回值改了？改了哪个字段？
+3. 哪些接口被废弃或删除了？
+
+如果这些信息藏在 2000+ 行的文档底部一个概要表格里，前端 agent 基本找不到。
+本规范通过**文档顶部的变更概览 + 接口内联标注**，让变更信息对前端 agent 零门槛可见。
+
+---
+
+## 一、文档顶部变更概览
+
+在 `## 1. 通用约定` 之前，插入变更概览节。格式如下：
+
+```markdown
+## 0. 变更概览（本次提测变更）
+
+> 基线版本：v1.0 | 当前版本：v1.1 | 变更日期：2026-05-22
+
+### 新增接口
+
+| 接口 | 说明 |
+|------|------|
+| `POST /api/xxx` | 新增 xxx 功能 |
+
+### 修改接口
+
+| 接口 | 变更摘要 |
+|------|----------|
+| `GET /api/yyy` | 新增 query 参数 `keyword`；响应增加 `tag` 字段 |
+| `PUT /api/zzz/{id}` | 入参 `status` 枚举值新增 `3=待审核` |
+
+### 废弃接口
+
+| 接口 | 替代方案 | 移除计划 |
+|------|----------|----------|
+| `GET /api/old` | 使用 `GET /api/new` | v2.0 移除 |
+```
+
+### 规则
+
+1. **每次提测必须更新**：推送飞书前，必须刷新变更概览节的内容和日期。
+2. **只写本次变更**：变更概览只记录"上一版基线 → 当前版本"的差量，不是完整历史。
+3. **完整历史在第 8 节**：文档末尾的"接口变更记录"表保留完整历史，格式不变。
+4. **无变更也要写**：如果没有变更，写"本次提测无接口变更，仅修复已知问题"。
+
+---
+
+## 二、接口级别内联标注
+
+每个接口的标题行后紧跟变更标签，用方括号标注变更类型：
+
+```markdown
+#### `GET /api/charging-package/templates` `[新增]`
+
+#### `PUT /api/parking-guns/{id}` `[修改]`
+
+#### `DELETE /api/old-endpoint` `[废弃]`
+```
+
+### 标签类型
+
+| 标签 | 含义 | 使用场景 |
+|------|------|----------|
+| `[新增]` | 本次新增的接口 | 全新开发的接口 |
+| `[修改]` | 本次有改动的接口 | 参数、响应、行为有任何变化 |
+| `[废弃]` | 已废弃但暂未移除 | 已有替代方案，但保留兼容 |
+| 无标签 | 本次无变更 | 上个版本就存在且未修改的接口 |
+
+### 规则
+
+1. **只有本次变更的接口才加标签**，稳定接口不加。
+2. 下次提测时，上一轮的标签要**清除**（上一轮的变更已不再是"新"变更）。
+3. 接口标题和标签之间用空格分隔。
+
+---
+
+## 三、字段级别内联标注
+
+在参数表和响应字段表中，变更的字段在"说明"列末尾追加标注：
+
+### 参数/响应表的标注方式
+
+```markdown
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| name | String | 是 | 套餐名称 |
+| keyword | String | 否 | 搜索关键词 `【本次新增】` |
+| status | Integer | 否 | 状态：1 上架，2 下架，3 待审核 `【枚举值变更：新增 3】` |
+| oldField | String | 否 | ~~已废弃，使用 newField~~ `【本次废弃】` |
+```
+
+### 字段标注类型
+
+| 标注 | 含义 | 在说明列中的写法 |
+|------|------|-----------------|
+| 新增字段 | 本次新增的入参或返回字段 | 追加 `【本次新增】` |
+| 字段修改 | 类型、校验规则、枚举值等有变化 | 追加 `【本次变更：具体改了什么】` |
+| 字段废弃 | 仍在返回但已不推荐使用 | 用删除线 + 追加 `【本次废弃】` |
+| 字段移除 | 不再返回或不再接受 | 从表中移除，在变更概览中说明 |
+
+### 规则
+
+1. 标注追加在说明文字末尾，用 `【】` 包裹，与正常说明文字区分。
+2. 变更描述要**具体**：写"枚举值新增 3=待审核"，不要只写"有变更"。
+3. 下次提测时清除上一轮标注。
+4. JSON 响应示例中不需要标注，以字段表为准。
+
+---
+
+## 四、操作流程
+
+### 4.1 首次编写 api.md（新模块）
+
+首次编写时不需要任何变更标注，因为没有"上一版"做对比。
+文档正常编写即可，变更概览节写：
+
+```markdown
+## 0. 变更概览（本次提测变更）
+
+> 首个版本，全部接口为新增。详见接口列表。
+```
+
+### 4.2 更新已有 api.md（迭代开发）
+
+1. **读取当前 api.md**，识别所有接口和字段。
+2. **对比代码变更**（git diff、接口实现变化、DTO 字段变化）确定变更范围。
+3. **更新变更概览**：在 `## 0. 变更概览` 节中列出新增/修改/废弃的接口。
+4. **添加接口级标签**：在变更接口的标题行后追加 `[新增]`/`[修改]`/`[废弃]`。
+5. **添加字段级标注**：在变更字段的说明列末尾追加 `【本次新增】`/`【本次变更：...】`。
+6. **清除上一轮标注**：删除上一轮提测的变更标签和字段标注。
+7. **更新第 8 节历史表**：在文档末尾的变更记录表中追加一行。
+
+### 4.3 推送飞书前检查
+
+推送前确认：
+- [ ] 变更概览节的版本号和日期已更新
+- [ ] 所有变更接口有标签
+- [ ] 所有变更字段有标注
+- [ ] 上一轮的标注已清除
+- [ ] 第 8 节历史表已追加
+
+---
+
+## 五、变更判定标准
+
+以下情况算"变更"，必须标注：
+
+| 变更类型 | 示例 |
+|----------|------|
+| 新增接口 | 新增 POST /api/xxx |
+| 删除接口 | 移除 GET /api/old |
+| 新增参数/字段 | 入参增加 keyword 字段 |
+| 删除参数/字段 | 不再返回 oldField |
+| 修改字段类型 | String → Long |
+| 修改枚举值 | status 新增值 3 |
+| 修改校验规则 | 长度限制从 64 改为 128 |
+| 修改必填状态 | 可选 → 必填 |
+| 修改行为逻辑 | 排序规则改变、权限逻辑变更 |
+| 修改错误码 | 新增错误码或修改错误码含义 |
+
+以下情况**不算变更**，不需要标注：
+- 修正错别字
+- 调整文档格式
+- 补充边界说明（不改变接口行为）
+- curl 示例调整（不改变接口契约）
+
+---
+
+## 六、与 SuperBridge Flow 流程的集成
+
+本规范是 SuperBridge Flow 流程的一部分。在 `superflow-docs` 阶段生成 `api.md` 时：
+
+1. **首次生成**：按本规范第四条第 4.1 款处理，写首个版本标记。
+2. **迭代更新**：按第四条第 4.2 款处理，对比已有 api.md 标注变更。
+3. **推送飞书前**：按第四条第 4.3 款检查清单验证。
+
+SDD 的 `api-design-template.md` 中"第 8 节 接口变更记录"继续保留作为完整历史记录。
+本规范新增的"第 0 节 变更概览"是提测时的增量视图，两者互补。

package/assets/skills/openspec-apply-change/SKILL.md

@@ -0,0 +1,156 @@
+---
+name: openspec-apply-change
+description: Implement tasks from an OpenSpec change. Use when the user wants to start implementing, continue implementation, or work through tasks.
+license: MIT
+compatibility: Requires openspec CLI.
+metadata:
+  author: openspec
+  version: "1.0"
+  generatedBy: "1.3.1"
+---
+
+Implement tasks from an OpenSpec change.
+
+**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
+
+**Steps**
+
+1. **Select the change**
+
+   If a name is provided, use it. Otherwise:
+   - Infer from conversation context if the user mentioned a change
+   - Auto-select if only one active change exists
+   - If ambiguous, run `openspec list --json` to get available changes and use the **AskUserQuestion tool** to let the user select
+
+   Always announce: "Using change: <name>" and how to override (e.g., `/opsx:apply <other>`).
+
+2. **Check status to understand the schema**
+   ```bash
+   openspec status --change "<name>" --json
+   ```
+   Parse the JSON to understand:
+   - `schemaName`: The workflow being used (e.g., "spec-driven")
+   - Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others)
+
+3. **Get apply instructions**
+
+   ```bash
+   openspec instructions apply --change "<name>" --json
+   ```
+
+   This returns:
+   - `contextFiles`: artifact ID -> array of concrete file paths (varies by schema - could be proposal/specs/design/tasks or spec/tests/implementation/docs)
+   - Progress (total, complete, remaining)
+   - Task list with status
+   - Dynamic instruction based on current state
+
+   **Handle states:**
+   - If `state: "blocked"` (missing artifacts): show message, suggest using openspec-continue-change
+   - If `state: "all_done"`: congratulate, suggest archive
+   - Otherwise: proceed to implementation
+
+4. **Read context files**
+
+   Read every file path listed under `contextFiles` from the apply instructions output.
+   The files depend on the schema being used:
+   - **spec-driven**: proposal, specs, design, tasks
+   - Other schemas: follow the contextFiles from CLI output
+
+5. **Show current progress**
+
+   Display:
+   - Schema being used
+   - Progress: "N/M tasks complete"
+   - Remaining tasks overview
+   - Dynamic instruction from CLI
+
+6. **Implement tasks (loop until done or blocked)**
+
+   For each pending task:
+   - Show which task is being worked on
+   - Make the code changes required
+   - Keep changes minimal and focused
+   - Mark task complete in the tasks file: `- [ ]` → `- [x]`
+   - Continue to next task
+
+   **Pause if:**
+   - Task is unclear → ask for clarification
+   - Implementation reveals a design issue → suggest updating artifacts
+   - Error or blocker encountered → report and wait for guidance
+   - User interrupts
+
+7. **On completion or pause, show status**
+
+   Display:
+   - Tasks completed this session
+   - Overall progress: "N/M tasks complete"
+   - If all done: suggest archive
+   - If paused: explain why and wait for guidance
+
+**Output During Implementation**
+
+```
+## Implementing: <change-name> (schema: <schema-name>)
+
+Working on task 3/7: <task description>
+[...implementation happening...]
+✓ Task complete
+
+Working on task 4/7: <task description>
+[...implementation happening...]
+✓ Task complete
+```
+
+**Output On Completion**
+
+```
+## Implementation Complete
+
+**Change:** <change-name>
+**Schema:** <schema-name>
+**Progress:** 7/7 tasks complete ✓
+
+### Completed This Session
+- [x] Task 1
+- [x] Task 2
+...
+
+All tasks complete! Ready to archive this change.
+```
+
+**Output On Pause (Issue Encountered)**
+
+```
+## Implementation Paused
+
+**Change:** <change-name>
+**Schema:** <schema-name>
+**Progress:** 4/7 tasks complete
+
+### Issue Encountered
+<description of the issue>
+
+**Options:**
+1. <option 1>
+2. <option 2>
+3. Other approach
+
+What would you like to do?
+```
+
+**Guardrails**
+- Keep going through tasks until done or blocked
+- Always read context files before starting (from the apply instructions output)
+- If task is ambiguous, pause and ask before implementing
+- If implementation reveals issues, pause and suggest artifact updates
+- Keep code changes minimal and scoped to each task
+- Update task checkbox immediately after completing each task
+- Pause on errors, blockers, or unclear requirements - don't guess
+- Use contextFiles from CLI output, don't assume specific file names
+
+**Fluid Workflow Integration**
+
+This skill supports the "actions on a change" model:
+
+- **Can be invoked anytime**: Before all artifacts are done (if tasks exist), after partial implementation, interleaved with other actions
+- **Allows artifact updates**: If implementation reveals design issues, suggest updating artifacts - not phase-locked, work fluidly

package/assets/skills/openspec-archive-change/SKILL.md

@@ -0,0 +1,114 @@
+---
+name: openspec-archive-change
+description: Archive a completed change in the experimental workflow. Use when the user wants to finalize and archive a change after implementation is complete.
+license: MIT
+compatibility: Requires openspec CLI.
+metadata:
+  author: openspec
+  version: "1.0"
+  generatedBy: "1.3.1"
+---
+
+Archive a completed change in the experimental workflow.
+
+**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
+
+**Steps**
+
+1. **If no change name provided, prompt for selection**
+
+   Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select.
+
+   Show only active changes (not already archived).
+   Include the schema used for each change if available.
+
+   **IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
+
+2. **Check artifact completion status**
+
+   Run `openspec status --change "<name>" --json` to check artifact completion.
+
+   Parse the JSON to understand:
+   - `schemaName`: The workflow being used
+   - `artifacts`: List of artifacts with their status (`done` or other)
+
+   **If any artifacts are not `done`:**
+   - Display warning listing incomplete artifacts
+   - Use **AskUserQuestion tool** to confirm user wants to proceed
+   - Proceed if user confirms
+
+3. **Check task completion status**
+
+   Read the tasks file (typically `tasks.md`) to check for incomplete tasks.
+
+   Count tasks marked with `- [ ]` (incomplete) vs `- [x]` (complete).
+
+   **If incomplete tasks found:**
+   - Display warning showing count of incomplete tasks
+   - Use **AskUserQuestion tool** to confirm user wants to proceed
+   - Proceed if user confirms
+
+   **If no tasks file exists:** Proceed without task-related warning.
+
+4. **Assess delta spec sync state**
+
+   Check for delta specs at `openspec/changes/<name>/specs/`. If none exist, proceed without sync prompt.
+
+   **If delta specs exist:**
+   - Compare each delta spec with its corresponding main spec at `openspec/specs/<capability>/spec.md`
+   - Determine what changes would be applied (adds, modifications, removals, renames)
+   - Show a combined summary before prompting
+
+   **Prompt options:**
+   - If changes needed: "Sync now (recommended)", "Archive without syncing"
+   - If already synced: "Archive now", "Sync anyway", "Cancel"
+
+   If user chooses sync, use Task tool (subagent_type: "general-purpose", prompt: "Use Skill tool to invoke openspec-sync-specs for change '<name>'. Delta spec analysis: <include the analyzed delta spec summary>"). Proceed to archive regardless of choice.
+
+5. **Perform the archive**
+
+   Create the archive directory if it doesn't exist:
+   ```bash
+   mkdir -p openspec/changes/archive
+   ```
+
+   Generate target name using current date: `YYYY-MM-DD-<change-name>`
+
+   **Check if target already exists:**
+   - If yes: Fail with error, suggest renaming existing archive or using different date
+   - If no: Move the change directory to archive
+
+   ```bash
+   mv openspec/changes/<name> openspec/changes/archive/YYYY-MM-DD-<name>
+   ```
+
+6. **Display summary**
+
+   Show archive completion summary including:
+   - Change name
+   - Schema that was used
+   - Archive location
+   - Whether specs were synced (if applicable)
+   - Note about any warnings (incomplete artifacts/tasks)
+
+**Output On Success**
+
+```
+## Archive Complete
+
+**Change:** <change-name>
+**Schema:** <schema-name>
+**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
+**Specs:** ✓ Synced to main specs (or "No delta specs" or "Sync skipped")
+
+All artifacts complete. All tasks complete.
+```
+
+**Guardrails**
+- Always prompt for change selection if not provided
+- Use artifact graph (openspec status --json) for completion checking
+- Don't block archive on warnings - just inform and confirm
+- Preserve .openspec.yaml when moving to archive (it moves with the directory)
+- Show clear summary of what happened
+- If sync is requested, use openspec-sync-specs approach (agent-driven)
+- If delta specs exist, always run the sync assessment and show the combined summary before prompting