跳到主要内容

什么是 LeanSpec?

LeanSpec 是一种轻量级、敏捷的规范驱动开发(SDD)方法论和自适应工作流,旨在减少规范的"思维负担",让团队——包括人类和 AI 编码代理——专注于真正重要的事情。

LeanSpec 不仅仅是一个文档——它是 AI 驱动开发团队的自适应工作流、标准操作程序(SOP)和活的过程。

问题所在

传统的软件规范常常面临以下问题:

  • 文档过载:冗长的文档,无论人类还是 AI 都不会阅读或维护
  • 僵化合约:规范一旦开发开始就会过时
  • 过度思考:试图预先记录所有可能的边缘情况
  • 思维负担:管理冗长、复杂文档的认知负荷
  • 意图丢失:"为什么"被埋在大量的"是什么"和"如何做"之下

开发团队——包括 AI 编码代理——需要明确的方向,而不是被淹没在文档债务中。

LeanSpec 解决方案

LeanSpec 是一种思维方式和方法论,而不是僵化的格式或工具。它的核心是用最小的开销捕获真正重要的内容。

一个简单的示例结构可能包括:

  • 目标:这项工作存在的原因
  • 关键场景:必须成功的关键用户旅程
  • 验收标准:清晰、可测试的"完成"条件
  • 技术契约:必要的接口和约束
  • 非目标:我们明确不做的事情(以保持专注)

但关键是思维方式:专注于清晰,保持精简,使其成为活的文档。结构应该服务于您的需求,而不是限制您。

主要优势

对开发团队

  • 减少认知负荷:简短、易读的规范,容易理解
  • 更快的入职:新团队成员快速掌握项目方向
  • 更好的协调:每个人都有相同的理解
  • 活的文档:规范随着需求演变而保持最新
  • 专注于结果:强调"是什么"和"为什么",而不是实现细节

对 AI 编码代理

  • 清晰的上下文:从"为什么"开始为 AI 代理提供工作背后的目的
  • 具体场景:具体示例帮助 AI 理解预期行为
  • 可测试的标准:明确的目标指导 AI 实现
  • 边界:明确的非目标帮助 AI 避免范围蔓延
  • 自适应结构:无论选择什么格式,一致性都有助于 AI 有效解析

AI 编码代理在清晰、简洁的规范中工作得最好,这些规范在上下文和简洁性之间取得平衡——正是 LeanSpec 思维方式所倡导的。

您将获得什么

核心 CLI - 从终端进行轻量级规范管理:

  • 使用简单命令创建、组织和搜索规范
  • 使用看板(lean-spec board)和分析(lean-spec stats)跟踪项目健康状况
  • 验证规范的质量和复杂性(lean-spec validate
  • 理解规范之间的依赖关系(lean-spec deps
  • 完整 CLI 参考 →

MCP 服务器 - 原生 AI 助手集成:

  • 与 Claude Desktop、Cline 和其他兼容 MCP 的工具一起工作
  • 您的规范可直接在 AI 聊天上下文中使用
  • AI 代理可以读取、搜索和理解您的规范
  • 设置指南 →

模板和自定义

  • 三个模板:minimal、standard、enterprise
  • 自定义字段适应您的工作流
  • 随着团队成长的渐进式结构

想看看接下来会有什么?查看我们的路线图了解计划的功能,如 VS Code 扩展、GitHub Actions 等。

一个简单的示例

这是一个示例结构(根据您的需求调整部分):

---
status: in-progress
created: 2025-11-07
tags: [api, feature]
priority: high
---

# 用户认证 API

## 目标
为移动应用启用安全的用户登录和会话管理。

## 关键场景
1. 用户使用电子邮件/密码登录 → 接收 JWT 令牌
2. 用户使用令牌访问受保护的端点 → 获取数据
3. 用户令牌过期 → 接收 401,必须重新认证

## 验收标准
- [ ] 登录端点在成功时返回有效的 JWT
- [ ] JWT 包含用户 ID 和过期时间
- [ ] 受保护的端点验证 JWT 签名
- [ ] 过期的令牌被拒绝,返回 401

## 技术契约
- 端点:POST /api/auth/login
- 令牌过期:24 小时
- 密码哈希:bcrypt

## 非目标
- 社交登录(未来功能)
- 密码重置(单独的规范)
- 双因素认证(目前不需要)

干净、专注、可操作。

哲学

"最好的规范是被阅读、理解和执行的规范——无论是人类还是 AI。"

LeanSpec 倡导:

  • 从为什么开始:您要解决什么问题?
  • 捕获要点:绝对必须传达的是什么?
  • 保持精简:如果它不能增加清晰度,就删除它
  • 保持活跃:随着学习而更新

下一步

准备好开始了吗?前往快速开始指南安装 LeanSpec 并创建您的第一个规范。

想了解基础约束?从理解 LeanSpec 开始,了解为什么 LeanSpec 是这样设计的。

需要实用的执行指导?探索 AI 可执行规范的 12 种模式以获取日常技术。

与 AI 编码代理一起工作?查看代理配置MCP 集成获取设置指南。