跳转到主要内容

规范编写指南

7.1 Spec 目录结构和分层

分层原则
  • index.md 是入口,列出所有规范文件及其状态
  • 每个文件专注一个主题,200-500 行
  • 每个章节 20-50 行
  • 语言用英文(技术术语天然英文),中文项目可用中文

7.2 从空模板到完整规范

trellis init 会生成空模板,标记 “(To be filled by the team)“。填充步骤: Step 1:从实际代码中提取模式
Step 2:写下你的约定
Step 3:添加代码示例

Bad Example

7.3 好的规范 vs 差的规范

好的规范(具体、有代码、有原因):
Why: Parameterized queries are automatically escaped by the database driver.
过度规范(太细碎、限制创造力):

7.4 Bootstrap 引导首次填充

trellis init 时会自动创建 bootstrap 引导任务(00-bootstrap-guidelines),AI 在首次 /start 时会自动检测并引导你填充空白的 spec 文件。 AI 在这个引导任务中会分析代码库,提取现有模式,自动填充 spec 模板。

7.5 规范的持续演进

规范不是一次写好就不动的,而是随开发不断演进: 演进飞轮