跳到主要内容

创建和管理规范

学习使用 LeanSpec 规范的基本操作：创建、更新、查看和管理规范生命周期。

创建新规范​

基本创建​

lean-spec create my-feature

这会创建一个新规范，包含：

  • 自动生成的唯一 ID（例如，042-my-feature）
  • 初始化的前置元数据（状态：planned，创建日期）
  • specs/042-my-feature/README.md 中的基本规范模板

交互式创建​

lean-spec create

不带名称时，您将被交互式提示：

  • 规范名称
  • 可选描述
  • 初始状态（默认为 planned）

高级选项​

# 使用初始状态创建
lean-spec create my-feature --status in-progress

# 使用标签创建
lean-spec create my-feature --tags api,backend

# 使用优先级创建
lean-spec create my-feature --priority high

另见：CLI 参考：create 获取所有选项

更新规范​

状态更新​

更新规范状态（必需 - 永远不要手动编辑前置元数据）：

# 移至进行中
lean-spec update 042 --status in-progress

# 标记为完成
lean-spec update 042 --status complete

# 完成后归档
lean-spec update 042 --status archived

可用状态：planned、in-progress、complete、archived

优先级和标签​

# 设置优先级
lean-spec update 042 --priority high

# 添加/更新标签
lean-spec update 042 --tags api,backend,refactor

# 分配给某人
lean-spec update 042 --assignee alice

重要：始终使用 lean-spec update 更新系统管理的字段。手动编辑会损坏元数据。

另见：CLI 参考：update

查看规范​

快速查看​

# 查看规范（格式化以便阅读）
lean-spec view 042

# 查看子规范文件
lean-spec view 042/DESIGN.md

原始输出​

# 获取原始 markdown（用于解析）
lean-spec view 042 --raw

# 获取结构化 JSON
lean-spec view 042 --json

在编辑器中打开​

# 在默认编辑器中打开
lean-spec open 042

# 打开特定子规范
lean-spec open 042/TESTING.md

另见：CLI 参考：view

列出规范​

查看所有规范​

# 列出所有规范
lean-spec list

# 按状态列出
lean-spec list --status in-progress

# 按标签列出
lean-spec list --tag api

看板视图​

# 可视化看板视图
lean-spec board

显示按状态分组的规范及项目健康指标。

另见：看板和统计

管理规范文件​

子规范文件​

对于复杂规范，拆分为多个文件：

# 列出规范中的所有文件
lean-spec files 042

常见子规范文件：

  • README.md - 主规范（必需）
  • DESIGN.md - 详细设计
  • IMPLEMENTATION.md - 实现计划
  • TESTING.md - 测试策略
  • CONFIGURATION.md - 配置示例

**为什么？**保持每个文件在 400 行以下（上下文经济原则）。

另见：子规范文件

查看文件列表​

# 显示规范中的所有文件
lean-spec files 042

输出：

📄 042-my-feature 中的文件

必需：
  ✓ README.md        (234 行)  主规范

文档：
  ✓ DESIGN.md        (187 行)
  ✓ TESTING.md       (145 行)

总计：3 个文件，566 行

归档规范​

当工作完成并且您想将规范移出活动视图时：

# 归档已完成的规范
lean-spec update 042 --status archived

归档的规范：

  • 不会出现在默认的 lean-spec list 中
  • 仍可搜索
  • 以后可以取消归档

依赖和关系​

声明依赖​

硬依赖（阻塞）：

# 在规范前置元数据中（目前必须手动编辑）
depends_on:
  - spec-041  # 在此之前必须完成

软关系（信息性）：

# 在规范前置元数据中（目前必须手动编辑）
related:
  - spec-043  # 相关工作，不阻塞

查看依赖​

# 显示依赖关系图
lean-spec deps 042

输出：

042-my-feature 的依赖关系图

依赖于：
  → 041-authentication [complete]

被需要：
  ← 043-dashboard [in-progress]

相关规范：
  ⟷ 044-api-refactor [planned]

另见：依赖

验证​

检查规范结构和前置元数据：

# 验证所有规范
lean-spec validate

# 验证特定规范
lean-spec validate 042

捕获：

  • 无效的前置元数据结构
  • 缺少必需字段
  • 依赖循环
  • 行数警告（>400 行）

另见：验证

搜索​

通过内容、名称或元数据查找规范：

# 搜索规范内容
lean-spec search "authentication"

# 使用过滤器搜索
lean-spec search "API" --status in-progress --tag backend

另见：查找规范

常见工作流​

开始新工作​

# 1. 创建规范
lean-spec create auth-refactor --tags security,backend

# 2. 编辑规范（定义问题、解决方案、成功标准）
lean-spec open 042

# 3. 准备好时移至进行中
lean-spec update 042 --status in-progress

完成工作​

# 1. 标记为完成
lean-spec update 042 --status complete

# 2. 验证一切仍然正常
lean-spec validate

# 3. 可选：如果不再需要则归档
lean-spec update 042 --status archived

复杂规范管理​

# 1. 检查规范是否变得过大
lean-spec view 042 --raw | wc -l

# 2. 如果 >400 行，拆分为子规范
# 创建 DESIGN.md、TESTING.md 等

# 3. 验证结构
lean-spec files 042

最佳实践​

要做：

  • ✅ 使用 lean-spec update 更新状态/优先级/标签（永远不要编辑前置元数据）
  • ✅ 保持 README.md 专注（使用子规范获取详细信息）
  • ✅ 随着工作进展更新状态
  • ✅ 归档已完成的规范以减少混乱
  • ✅ 定期验证（lean-spec validate）

不要：

  • ❌ 手动编辑系统管理的前置元数据（status、priority、tags、assignee、transitions、timestamps）
  • ❌ 让规范在没有拆分的情况下超过 400 行
  • ❌ 让规范保持陈旧状态
  • ❌ 在提交前跳过验证

下一步​

参考：CLI 文档 获取完整命令参考