规格说明指南

学习如何为你的 Agent 编写清晰有效的规格说明。

为什么规格说明很重要

清晰的规格说明帮助 Agent 准确理解你的需求，从而：

❌ 不好："审查代码"

✅ 好："审查 src/auth.py 中的 Python 代码是否存在安全漏洞，重点关注输入验证和 SQL 注入风险"

task:
  name: code-review
  spec:
    context: |
      这是一个 Web 应用程序的认证模块。
      它处理用户登录、注册和密码重置。
    focus:
      - 安全漏洞
      - 错误处理
      - 代码风格

task:
  spec:
    output_format: markdown
    sections:
      - summary
      - issues_found
      - recommendations

结构良好的规格应包括：

spec:
  task: code-review
  files:
    - src/**/*.py
  criteria:
    - security
    - performance
    - maintainability

spec:
  task: documentation
  style: docstring
  format: google
  coverage: public-api