AGENTS.md 2.5 KB

superpowers

AI开发工具配置和规范,用于辅助项目开发。

WHERE TO LOOK

Task Location Notes
设计文档 specs/ 功能需求和设计规范
实现计划 plans/ 开发任务分解和计划
技能配置 项目根目录 AGENTS.md, CLAUDE.md配置

STRUCTURE

superpowers/
├── specs/           # 设计规范文档
│   ├── feature-*.md # 功能需求文档
│   └── api-*.md     # API设计文档
├── plans/           # 实现计划
│   ├── sprint-*.md  # 迭代计划
│   └── task-*.md    # 具体任务分解
└── AGENTS.md        # 本文件

CONVENTIONS

  • 文档格式: Markdown格式,中英文混合
  • 需求描述: 用户故事格式 (As a..., I want..., So that...)
  • API设计: OpenAPI风格,包含请求/响应示例
  • 任务分解: 使用TODO列表,明确验收标准
  • 版本控制: 文档随代码一起提交到git
  • 变更追踪: docs/superpowers/ 目录下任何文件的添加、更新、归档,必须同步更新 PROJECT-OVERVIEW.md 中的对应条目(版本号、状态、文档索引)

ANTI-PATTERNS

  • DO NOT 写模糊不清的需求描述
  • DO NOT 跳过验收标准的定义
  • DO NOT 将设计和实现混为一谈
  • NEVER 不更新文档就直接修改代码
  • NEVER 创建无法验证完成的任务
  • NEVERdocs/superpowers/ 下增删改文件后,不更新 PROJECT-OVERVIEW.md

UNIQUE WORKFLOWS

  1. 需求分析: 先写specs文档,明确边界和验收标准
  2. 计划制定: 在plans中分解任务,估计工作量
  3. AI辅助: 使用Sisyphus等AI工具执行具体实现
  4. 代码审查: 确保实现符合设计和规范
  5. 文档更新: 完成后更新相关文档

EXAMPLES

功能需求文档结构

# 功能名称
**优先级:** P0/P1/P2
**预计工时:** X小时

## 用户故事
As a [角色], I want [能力], so that [价值].

## 验收标准
- [ ] 标准1
- [ ] 标准2

## 技术考虑
- 涉及模块
- 数据变更
- 性能影响

任务分解结构

# 任务标题
**状态:** pending/in_progress/completed
**依赖:** 相关任务

## TODO列表
1. [ ] 步骤1
2. [ ] 步骤2

## 验证步骤
1. 运行测试
2. 检查功能

NOTES

  • 所有文档应与代码保持同步
  • AI辅助开发时需提供清晰上下文
  • 定期回顾和更新计划状态
  • 保持文档简洁但完整