前置元数据
LeanSpec 在每个规范顶部使用 YAML 前置元数据作为结构化元数据。
什么是前置元数据？
前置元数据是 YAML 格式的机器可读元数据：
---
status: in-progress
created: 2025-11-02
tags: [api, security]
priority: high
---
# 您的规范标题
[规范内容...]
核心字段
status（必需）
规范的当前状态。
有效值：
planned- 尚未开始in-progress- 当前正在处理complete- 工作已完成archived- 工作已归档
示例：
status: in-progress
created（必需）
规范创建的日期（ISO 8601 格式）。
格式： YYYY-MM-DD
示例：
created: 2025-11-02
当您使用 lean-spec create 时，这会自动填充。
可选字段
tags
用于分类和过滤的标签数组。
示例：
tags: [api, security, mvp]
用法：
lean-spec list --tag=api
priority
工作的重要性级别。
有效值：
lowmediumhighcritical
示例：
priority: high
用法：
lean-spec list --priority=high
completed
工作完成的日期（自动添加）。
格式： YYYY-MM-DD
示例：
completed: 2025-11-05
当您设置 status: complete 时，这会自动添加。
自定义字段
您可以在 .lean-spec/config.json 中定义自定义字段：
{
"frontmatter": {
"custom": {
"assignee": "string",
"reviewer": "string",
"epic": "string",
"sprint": "number",
"estimate": "string"
}
}
}
支持的类型：
stringnumberbooleanarray
用法：
lean-spec create feature --field assignee=alice --field sprint=42
lean-spec list --field epic=PROJ-123
详情请参见自定义字段。
视觉徽章
LeanSpec 从前置元数据自动生成视觉徽章：
> **Status**: ⏳ 进行中 · **Priority**: 高 · **Created**: 2025-11-02 · **Tags**: api, security
状态图标：
- 📅 计划中
- ⏳ 进行中
- ✅ 已完成
- 📦 已归档
当您使用 lean-spec update 时，这些徽章会自动更新。
完整示例
---
status: in-progress
created: 2025-11-02
completed:
tags: [api, authentication, security]
priority: high
assignee: alice
reviewer: bob
epic: PROJ-123
sprint: 42
---
# 用户认证 API
> **Status**: ⏳ 进行中 · **Priority**: 高 · **Created**: 2025-11-02
> **Tags**: api, authentication, security · **Assignee**: alice · **Reviewer**: bob
[规范内容...]
编辑前置元数据
通过 CLI
推荐的方法：
lean-spec update 001 --status=complete --priority=critical
这会更新前置元数据和视觉徽章。
手动编辑
您也可以直接在文件中编辑前置元数据：
- 在编辑器中打开
README.md - 修改
---标记之间的 YAML - 保存文件
注意：手动编辑不会自动更新视觉徽章。运行 lean-spec update 进行同步。
最佳实践
从最小开始
从 status 和 created 开始。仅在需要时添加字段。
一致地使用标签
为您的团队建立标签约定。示例：api、ui、backend、security。
定期更新状态
保持状态最新。使用 lean-spec list 查看进行中的内容。
不要过度自定义
谨慎添加自定义字段。每个字段都是要维护的开销。