跳到主要内容

模板

LeanSpec 提供可自定义的模板以匹配您的工作流程和团队结构。

概述​

模板是包含以下内容的完整工作模型：

  • 规范结构和示例
  • 用于 AI 代理集成的 AGENTS.md
  • 支持文件（CONTRIBUTING.md、检查清单等）
  • 项目特定配置

可用模板​

最小化​

基本要素 - 仅文件夹结构，无额外内容。

最适合： 快速原型、个人项目、当您想要绝对简单时

包括：

  • 最小的前置元数据（仅状态、创建时间）
  • 轻量级结构
  • 没有 AGENTS.md 或额外文件
  • 专注于速度

示例前置元数据：

---
status: planned
created: 2025-11-02
---

章节：

  • 目标
  • 关键点
  • 非目标
  • 注释

标准​

大多数项目推荐 - 包括 AGENTS.md 和稳固的结构。

最适合： 单人开发者、小团队（2-5 人）、大多数项目

包括：

  • 状态、标签、优先级字段
  • 用于 AI 集成的 AGENTS.md
  • 概述、设计、计划、测试章节
  • 复杂功能的子规范指导

示例前置元数据：

---
status: planned
created: 2025-11-02
tags: [api, feature]
priority: high
---

章节：

  • 概述
  • 设计
  • 计划（带子规范指导）
  • 测试
  • 注释

企业​

带审批和合规的治理。

最适合： 大型组织、受监管行业、>10 人的团队

包括：

  • 完整元数据（负责人、审查者、问题、史诗、相关）
  • 研究和依赖部分
  • 安全与合规检查清单
  • 风险评估
  • 推出计划

示例前置元数据：

---
status: planned
created: 2025-11-02
tags: [security, compliance]
priority: critical
assignee: alice
reviewer: bob
issue: JIRA-1234
epic: security-hardening
related: [042, 043]
---

章节：

  • 概述
  • 研究
  • 设计（带依赖、安全与合规）
  • 计划（带负责人）
  • 测试
  • 风险
  • 推出
  • 注释

选择模板​

运行 lean-spec init 并选择"选择模板"：

lean-spec init
? 您想如何设置？
  ❯ 快速开始（推荐）
    选择模板
    自定义一切

? 您想使用哪个模板？
  ❯ minimal - 仅文件夹结构，无额外内容
    standard - 推荐 - 包括 AGENTS.md
    enterprise - 带审批和合规的治理

自定义模板​

您可以在 .lean-spec/templates/ 中创建自己的模板。

创建自定义模板​

  1. 创建模板文件：
mkdir -p .lean-spec/templates
touch .lean-spec/templates/my-template.md
  1. 使用占位符编辑模板：
---
status: planned
created: {date}
---

# {name}

**团队**：{team}
**作者**：{author}

## 概述

[您的自定义章节...]
  1. 在 .lean-spec/config.json 中配置：
{
  "template": "my-template.md"
}

可用变量​

  • {name} - 规范名称
  • {date} - 创建日期（ISO 格式）
  • {project_name} - 来自 package.json
  • {author} - 来自 git config user.name
  • {git_user} - Git 用户名
  • {git_email} - Git 电子邮件
  • {git_repo} - 仓库名称

在配置中添加自定义变量：

{
  "variables": {
    "team": "平台工程",
    "company": "Acme Corp"
  }
}

模板结构​

完整的模板包括：

1. 前置元数据​

---
status: planned
created: {date}
tags: []
priority: medium
---

2. 视觉徽章​

> **Status**: 📅 计划中 · **Created**: {date}

3. 内容章节​

## 概述
## 目标
## 关键场景
## 验收标准
## 技术方法
## 非目标

自定义章节以适应您的需求。

切换模板​

要在项目中途更改模板：

  1. 更新 .lean-spec/config.json：
{
  "template": "new-template.md"
}

  1. 新规范将使用新模板

  2. 现有规范保持不变（如果需要手动更新）

最佳实践​

从简单开始

从最小化或标准模板开始。仅在您感到没有它的痛苦时才添加复杂性。

迭代模板

根据实际使用情况完善您的模板。删除未使用的章节。

保持章节可选

并非每个规范都需要每个章节。使用有价值的，跳过没有价值的。

共享模板

导出您的 .lean-spec/templates/ 目录以与其他团队或项目共享。

下一步：了解前置元数据字段或探索自定义字段。