SuperAPI AI 工具集

phase-1-schema

编程与开发

查看项目

更新于 10-16 02:16

技能介绍

用途

Phase 1: Schema/Terminology Definition 是项目工作流的第一阶段,核心目标是统一项目语言,确保所有团队成员(或 AI)使用相同术语沟通,并清晰理解数据结构。它解决的是每次都要向 Claude Code 重复解释业务术语的痛点,通过建立术语表让 Claude 自动引用以理解上下文,同时保证团队沟通一致性、缩短新成员或 AI 的入门时间。

主要能力

该阶段包含四项工作:

  1. 建立术语表(Glossary):映射业务术语与全球标准术语。
  2. 识别实体(Entities):确定项目中存在哪些“事物”。
  3. 定义关系(Relationships):明确实体之间的关系。
  4. 设计 Schema:定义数据结构。

术语分为三类:

  • 业务术语(Business Terms):内部专有术语,例如 "Caddy"(高尔夫预订助手)。
  • 全球标准(Global Standards):行业通用或技术标准术语,例如 "OAuth"、"REST API"。
  • 映射(Mapping):业务术语与全球标准的对应关系,例如 "Member" = User,"Payment" = Payment。

使用方式

技能提供了术语表模板,包含业务术语表(字段:Term、English、Definition、Global Standard Mapping)、全球标准表(字段:Term、Definition、Reference)以及术语使用规则。使用规则包括:代码中使用英文(如 Caddy、Round),UI/文档中使用本地语言,API 响应优先使用全球标准(如 booking_assistant)。

要让 Claude Code 自动引用术语表,有两种方法:

  • 方法 1:在 CLAUDE.md 中加入术语引用,例如:
    ## Term Reference
    For this project's term definitions, see `docs/01-plan/glossary.md`.
    
  • 方法 2:在项目 CLAUDE.md 中添加术语规则,例如:
    <!-- Add to CLAUDE.md -->
    Project terms are defined in docs/01-plan/glossary.md.
    Always reference when using business terms.
    

适用场景

该技能适用于项目启动阶段,尤其是需要统一业务术语与数据模型定义的团队。它按项目级别提供不同应用深度:Starter 级别只需简单核心术语;Dynamic 级别需详细覆盖所有实体;Enterprise 级别需按微服务分别详细定义。该阶段也遵循 PDCA 循环:Plan(识别所需实体/术语)、Design(设计 schema 结构与关系)、Do(编写文档)、Check(检查遗漏/矛盾)、Act(定稿并进入 Phase 2)。

交付物

交付物位于 docs/01-plan/ 目录下,包括:

  • glossary.md:术语表(推荐新建),含业务术语、全球标准、映射表
  • schema.md:数据 schema
  • terminology.md:(已有)建议合并到 glossary.md
  • domain-model.md:领域模型

限制

资料未提供该技能的具体安装命令、收费方式、价格、平台支持范围或实际效果数据。模板文件位于 templates/pipeline/phase-1-schema.template.md。下一阶段为 Phase 2: Coding Convention,即在术语定义完成后定义代码规则。