spec-canon 0.1.0 → 0.1.2

package/README.md

@@ -48,6 +48,18 @@ domain_spec.md（演化更新）
 | 🧑 人（研发工程师） | 决策、审阅、判断对不对 | 做判断题 |
 | 🤖 AI（Coding Agent） | 生成、补全、确保全不全 | 做填空题 |
 
+## 安装
+
+```bash
+npm install -g spec-canon
+```
+
+或直接通过 `npx` 使用（无需全局安装）：
+
+```bash
+npx spec-canon --help
+```
+
 ## 快速开始
 
 ### 我要开始一个新项目
@@ -65,6 +77,7 @@ domain_spec.md（演化更新）
 docs/
 ├── SOP.md                    ← 导航索引（入口）
 ├── guide/                    ← 方法论（一次性阅读）
+│   ├── 00_introduction.md        SDD 框架综合介绍（对外发布用）
 │   ├── 01_claude_md.md           CLAUDE.md 书写指南
 │   ├── 02_spec_overview.md       三层文档体系总览
 │   ├── 03_spec_documents.md      各文档详解

package/dist/index.js

@@ -5,7 +5,7 @@ const program = new Command();
 program
     .name('spec-canon')
     .description('CLI toolkit for Spec-Driven Development (SDD)')
-    .version('0.1.0');
+    .version('0.1.2');
 registerInitCommand(program);
 registerPromptCommand(program);
 program.parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-canon",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "CLI toolkit for Spec-Driven Development (SDD)",
   "type": "module",
   "license": "MIT",

package/templates/claude-md-section.md

@@ -43,7 +43,7 @@ Change Spec 生成顺序（后者依赖前者作为上下文）：
 
 | 步骤 | 提示词 ID | 产出 | 人工审阅点 |
 |---|---|---|---|
-| Step 0 | `ctx`（`-d` 或 `-m`） | `00_context.md` | 补充技术约束和团队经验 |
+| Step 0 | `ctx`（`-d` 或 `-m`） | `00_context.md` | 审阅系统现状快照，补充 AI 无法推断的技术约束和团队经验 |
 | Step 1 | `req` | `01_requirement.md` | 审阅验收标准，Sign-off |
 | Step 2 | `iface` → `impl-spec` → `test-spec` | `02` / `03` / `04` | 审阅接口设计、文件路径、步骤顺序 |
 | Step 3 | `impl` | 分步编码 | 逐步确认，Gate 验证 |

package/templates/prompts/catalog.json

@@ -116,7 +116,7 @@
       "tags": ["iterative"]
     },
     {
-      "id": "domain-split",
+      "id": "domain-split-eval",
       "name": "单域拆分评估",
       "file": "iterative/split_evaluate.md",
       "stage": "iterative",

package/templates/prompts/daily/step1_requirement.md

@@ -1,11 +1,11 @@
-请阅读 @spec-canon/changes/{{CHANGE}}/00_context.md 和以下 PRD，
-生成 spec-canon/changes/{{CHANGE}}/01_requirement.md。
+若存在 @spec-canon/changes/{{CHANGE}}/00_context.md，请先阅读；否则跳过。
+阅读以下 PRD，生成 spec-canon/changes/{{CHANGE}}/01_requirement.md。
 要求：
 1. AC 至少覆盖主流程 + 幂等 + 2 个失败场景
-2. §3 Scope：基于 00_context.md §2 标注本次变更涉及的模块/文件
-3. §5 Constraints：必须参考 00_context.md §3；检查新需求是否与 00_context.md §2.3 已有接口契约冲突
-4. §6 Risks：须包含以下三项分析（基于 00_context.md §5）：
-   - 回归风险：00_context.md §5 中与本次变更相关的已知坑位
+2. §3 Scope：若已有 00_context.md，基于其 §2 标注本次变更涉及的模块/文件；否则基于代码库自行分析
+3. §5 Constraints：若已有 00_context.md，参考其 §3 并检查新需求是否与 §2.3 已有接口契约冲突；否则基于代码库分析填写（仅确认为全新项目、无既有接口约束时方可填写 N/A）
+4. §6 Risks：须包含以下三项分析（若已有 00_context.md 则基于其 §5，否则基于代码库自行分析）：
+   - 回归风险：与本次变更相关的已知坑位
    - 单测影响：是否影响已有的单测
    - 变更冲突：是否与其他进行中变更有 Spec 冲突
 5. 执行一致性自检

package/templates/prompts/daily/step3_execute.md

@@ -1,3 +1,11 @@
-请按照 @spec-canon/changes/{{CHANGE}}/03_implementation.md 的 Step 1 开始执行。
-每完成一步，运行该步骤的验证命令，通过后报告，
-然后我确认是否继续下一步。
+根据现有 Spec 文档按以下分支执行：
+
+— 若存在 @spec-canon/changes/{{CHANGE}}/03_implementation.md
+  → 按 03 中的 Step 列表逐步执行，每步运行该步骤的验证命令，通过后报告，然后我确认是否继续下一步
+
+— 若存在 @spec-canon/changes/{{CHANGE}}/02_interface.md 但无 03
+  → 基于 01_requirement + 02_interface 自行规划实现步骤，
+    每步完成后运行编译/单测，通过后报告，然后我确认是否继续下一步
+
+— 若只有 @spec-canon/changes/{{CHANGE}}/01_requirement.md
+  → 基于 01 的 AC 直接实现，分步完成，每步运行验证命令，通过后报告，然后我确认是否继续下一步

package/templates/prompts/daily/step4_review.md

@@ -1,4 +1,4 @@
-请基于 @spec-canon/changes/{{CHANGE}}/ 下的所有 Spec 文档（00_context ~ 04_test_spec），
+请基于 @spec-canon/changes/{{CHANGE}}/ 下现有的所有 Spec 文档（读取实际存在的文件），
 审查本次所有代码变更。对每个 AC 逐项检查：✅ / ⚠️ / ❌。
 所有 Must Fix 修复后，更新 AI_CHANGELOG.md。
-如果发现 00_context.md 中遗漏的坑位，回填 00_context.md §5。
+若存在 00_context.md 且发现遗漏坑位，回填其 §5；否则将坑位记录到 AI_CHANGELOG.md 或留待 domain-sync 回填。

package/templates/prompts/guide.md

@@ -14,8 +14,8 @@
 └─ SDD 已就绪，日常开发
    └─ 按任务规模裁剪:
       ├─ 小 Bugfix ────── 仅更新 AI_CHANGELOG（无需提示词）
-      ├─ 小需求 ────────── req
-      ├─ 中等需求 ──────── req → iface
+      ├─ 小需求 ────────── req → impl → review
+      ├─ 中等需求 ──────── req → iface → impl → review
       └─ 复杂需求 ──────── ctx → req → iface → impl-spec → test-spec → impl → review → domain-sync
 ```
 
@@ -62,7 +62,7 @@
 
 | 步骤 | 提示词 ID | 说明 | 人工审阅点 |
 |---|---|---|---|
-| Step 0 | `ctx`（`-d` 或 `-m`） | 生成 00_context.md | 补充技术约束和团队经验 |
+| Step 0 | `ctx`（`-d` 或 `-m`） | 生成 00_context.md | 审阅系统现状快照，补充 AI 无法推断的技术约束和团队经验 |
 | Step 1 | `req` | 生成 01_requirement.md | 审阅 AC，Sign-off |
 | Step 2 | `iface` → `impl-spec` → `test-spec` | 生成 02/03/04 文档 | 审阅文件路径、步骤顺序 |
 | Step 3 | `impl` | 分步编码 | 逐步确认 |
@@ -72,15 +72,15 @@
 按任务规模裁剪——小任务不必跑完全部步骤：
 
 - **小 Bugfix**：仅更新 AI_CHANGELOG（无需提示词）
-- **小需求**：`req`
-- **中等需求**：`req` → `iface`
+- **小需求**：`req` → `impl`（基于01）→ `review`（基于01）
+- **中等需求**：`req` → `iface` → `impl`（基于01+02）→ `review`（基于01+02）
 - **复杂需求**：完整流程 ctx → domain-sync
 
 ## 域拆分
 
 在批量基线过程中或日常迭代中，如果怀疑某个域需要拆分：
 
-1. 使用 `domain-split` 评估是否需要拆分（人工审阅评估结论）
+1. 使用 `domain-split-eval` 评估是否需要拆分（人工审阅评估结论）
 2. 确认拆分方案后，使用 `domain-split-run` 执行拆分操作（人工审阅草稿后写入）
 
 子域分拆规则详见 [guide/06_domain_splitting.md](../guide/06_domain_splitting.md)。