diff --git a/CHANGELOG.md b/CHANGELOG.md index defc68b..a94588e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ ## Unreleased +## 0.4.2 + +- Clarified `/openflow init` documentation as project introduction, rules, and implementation constraints capture instead of a config-file operation. +- Reworked the OpenFlow workflow diagram layout so state routing, init, capture, handoff, amend, build, and close nodes no longer overlap. +- Regenerated the workflow PNG from the updated SVG. + ## 0.4.1 - Added workflow-status module: programmatic status tracking, conflict detection, and dashboard rendering for active OpenSpec changes. diff --git a/README.md b/README.md index cab0a6d..32ada0b 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ available phases. OpenCode keeps its native command-tree form under | Command | Phase | Description | |---------|-------|-------------| -| `/openflow init` | init | Initialize or refine `openspec/config.yaml` project context | +| `/openflow init` | init | Capture project introduction, rules, and implementation constraints | | `/openflow proposal` | proposal | Lightweight capture — 3-5 questions to converge on requirements | | `/openflow brainstorming` | brainstorming | Deep design — multi-round tradeoff exploration | | `/openflow grill` | grill | Optional stress-test — challenge proposal assumptions before spec | @@ -90,7 +90,7 @@ available phases. OpenCode keeps its native command-tree form under | `/openflow build` | build | Call Superpowers to execute implementation | | `/openflow close` | close | Verify consistency + archive | -`/openflow init` is the project-context phase. It scans the repository, asks only for missing implementation constraints, and writes `openspec/config.yaml` so future proposal, spec, and build work has project-specific rules. +`/openflow init` is the project-context phase. It scans the repository, captures the project's purpose, coding rules, architectural boundaries, and implementation constraints, then writes them to `openspec/config.yaml` so future proposal, spec, and build work has project-specific guidance. `/openflow grill` is optional: skip it when the proposal is already clear, or use it to challenge hidden assumptions before committing to specs. The spec phase treats `plan-ready.md` as a detailed Superpowers handoff, not a task summary: it must preserve source coverage, file responsibilities, implementation slices, TDD expectations, validation commands, and blockers. diff --git a/README.zh-CN.md b/README.zh-CN.md index 1f86888..b4ea4cc 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -80,7 +80,7 @@ OpenCode 保持原生命令树形式,例如 `/openflow/spec`、`/openflow/buil | 命令 | 阶段 | 说明 | |------|------|------| -| `/openflow init` | init | 初始化或精炼 `openspec/config.yaml` 项目上下文 | +| `/openflow init` | init | 梳理项目介绍、规则限制和实现约束 | | `/openflow proposal` | proposal | 轻量提问,3-5 问快速收敛需求 | | `/openflow brainstorming` | brainstorming | 深度设计,多轮方案探索 | | `/openflow grill` | grill | 可选压力测试,在 spec 前挑战 proposal 假设 | @@ -89,7 +89,7 @@ OpenCode 保持原生命令树形式,例如 `/openflow/spec`、`/openflow/buil | `/openflow build` | build | 调用 Superpowers 执行实现 | | `/openflow close` | close | 验证一致性 + 归档 | -`/openflow init` 是项目上下文阶段。它扫描仓库,只追问缺失的实现约束,并写入 `openspec/config.yaml`,让后续 proposal、spec 和 build 都带着项目级规则执行。 +`/openflow init` 是项目上下文阶段。它扫描仓库,梳理项目用途、编码规则、架构边界和实现限制,并写入 `openspec/config.yaml`,让后续 proposal、spec 和 build 都带着项目级指导执行。 `/openflow grill` 是可选阶段:proposal 已经足够清晰时可以跳过;需要在进入 spec 前挑战隐藏假设和边界时再使用。spec 阶段把 `plan-ready.md` 视为交给 Superpowers 的详细 handoff,而不是任务摘要:必须保留来源覆盖、文件责任、实现切片、TDD 期望、验证命令和阻塞项。 diff --git a/openflow-workflow.png b/openflow-workflow.png index 274d665..eb5fba1 100644 Binary files a/openflow-workflow.png and b/openflow-workflow.png differ diff --git a/openflow-workflow.svg b/openflow-workflow.svg index 608ce42..50a85bb 100644 --- a/openflow-workflow.svg +++ b/openflow-workflow.svg @@ -1,12 +1,13 @@ - + @@ -14,21 +15,24 @@ - + - + + OpenFlow 项目流程图 - OpenSpec + Superpowers 工作流编排器 · project context + status-first routing + OpenSpec + Superpowers 工作流编排器 · 项目上下文 + status-first routing + 状态路由规则 - 1. 先读 workflow-status.md - 2. 缺失时按文件推断状态 - 3. 状态冲突 → 显示 Warning - 4. 无项目上下文 → Init - 5. 根据 gate 推荐下一阶段 + 1. 先读 workflow-status.md + 2. 缺失时按文件推断状态 + 3. 状态冲突 → 显示 Warning + 4. 缺项目上下文 → Init + 5. 根据 gate 推荐下一阶段 grill-me 可选:不作为自动门禁 Build/Close 发现需求变更 → Amend + CLI / Skill 入口 @@ -42,123 +46,144 @@ /openflow build / close OpenCode: /openflow/grill - - plan-ready.md handoff - • Source Coverage - • File Responsibility Map - • Implementation Slices - • TDD expectations - • Validation commands - • Blockers / Clarifications - 不是摘要,是可执行 planning brief - - 外部依赖 - - OpenSpec - 生成/校验/归档 - - Superpowers - writing-plans + TDD + + + plan-ready.md handoff + • Source Coverage + • File Responsibility Map + • Implementation Slices + • TDD expectations + • Validation commands + • Blockers / Clarifications + 不是摘要,是可执行 planning brief + + + 外部依赖 + + OpenSpec + 生成/校验/归档 + + Superpowers + writing-plans + TDD + + + + + + + + + + + + + + + + + + + + + + + U 用户 + /openflow - - 状态路由 - State Detection + + + 状态路由 + status + context gate + - - Init - openspec/config.yaml - 项目上下文和规则 + + Init + 项目介绍 / 规则限制 + 写入 openspec/config.yaml + - - Proposal - 轻量需求捕获 - 3–5 个关键问题 + + Proposal + 轻量需求捕获 + 3–5 个关键问题 + - - Brainstorming - 深度设计探索 - 多轮取舍讨论 + + Brainstorming + 深度设计探索 + 多轮取舍讨论 + - - grill-me (Optional) - 压力测试 proposal - 隐藏假设 / 边界 / 风险 + + grill-me (Optional) + 压力测试 proposal + 隐藏假设 / 边界 / 风险 + 可跳过 + - - Spec - OpenSpec 生成规格 - proposal / design / specs / tasks + + Spec + OpenSpec 生成规格 + proposal / design / specs / tasks + - - Translation Layer - 需求视角 → 工程视角 - 详细 plan-ready.md handoff + + Translation Layer + 需求视角 → 工程视角 + 详细 plan-ready.md handoff + - - Workflow Status - gates / tasks - conflicts / next + + Workflow Status + gates / tasks + conflicts / next + - - Build - Superpowers 执行 - TDD + checkpoint + + Build + Superpowers 执行 + TDD + checkpoint + - - Close - 验证一致性 + 归档 - 同步 tasks checkbox + + Amend + 需求变更修订 + 只改规格/计划 + 修订后回 Spec + 需求变更 + - - Amend - 需求变更修订 - 只改规格/计划 + + Close + 验证一致性 + 归档 + 同步 tasks checkbox - - - - - - - - - - - - - - 可跳过 - - - 修订后回 Spec - - 需求变更 - - - - + + 主流程 - - 可选/修订回路 - - 需求变更 - - 路由/说明 + + 上下文初始化 + + 可选/修订回路 + + 需求变更 + + 路由/说明 diff --git a/package-lock.json b/package-lock.json index cb4a8b5..0d0bea6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@lininn/openflow", - "version": "0.4.1", + "version": "0.4.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@lininn/openflow", - "version": "0.4.1", + "version": "0.4.2", "hasInstallScript": true, "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index b1d812c..dfc71d7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@lininn/openflow", - "version": "0.4.1", + "version": "0.4.2", "description": "OpenSpec + Superpowers workflow orchestrator for agentic development", "bin": { "openflow": "bin/openflow.js"