AI Coding SDD开发规范_02_技术规范与组件

markdown
2026年7月17日11 min read2,034 words

Updated 2026年7月17日

AI Coding SDD开发规范_02_技术规范与组件

一、工具配置指南

1.1 工具统一概述

工具统一是 AI Coding 有效落地的重要组成部分。

工具类型 推荐工具 厂商 适用场景
开发首选 Trae 字节 新功能开发、复杂需求
日常开发 Qoder 阿里 通用开发任务
IDE插件 Lingma 阿里 已有IDEA用户
存量系统 Cursor/Copilot - 上下文构建阶段首选
CLI工具 Claude Code Anthropic 终端驱动的AI编程助手,支持Agent模式
CLI工具 Codex CLI OpenAI 终端内代码生成与修改
CLI工具 OpenCode 开源社区 开源终端AI编程助手,兼容多模型

核心原则

  • Trae 和 Qoder 在代码管理和UI交互上拥有更完整的控制权限,适合 GUI 场景
  • Claude Code / Codex / OpenCode 以终端为核心,适合 CI/CD 流水线、脚本化工作流
  • 建议优先使用 Trae 进行日常 GUI 开发,CLI 工具用于自动化和批量场景

二、Trae 安装与配置

2.1 下载与安装

  • 当前版本:v3.3.65
  • 下载地址https://www.trae.cn/
  • 安装方式:根据设备选择适配版本,按照默认方式安装

2.2 JetBrains IDEs 插件安装

两种方式:

  1. 方式一:IDEA插件市场搜索 "TRAE" 或 "Trae AI",点击 Install,重启 IDEA
  2. 方式二:参考官方教程 https://www.trae.cn/plugin

2.3 注册登录流程

管理员登录

  1. 联系企业管理员开通,等待邮件邀请获取管理员密码
  2. 登录管理员页面:https://console.enterprise.trae.cn/login
  3. 点击"人员管理",邀请成员
  4. 成员申请后需在此处审批

成员登录

  1. 等待管理员邀请审批通过后,选择"企业用户"
  2. 输入公司邮箱,如有专属域名,输入专属域名
  3. 点击登录即可使用

2.4 首次配置流程

依次完成配置:

  1. 选择主题
  2. 配置快捷键
  3. 添加命令行
  4. 选择企业用户登录
  5. 点击设置配置 Rule、MCP、Skill 等

2.5 功能介绍

对话模式

模式 说明 适用场景
Chat 智能问答 代码问答、知识查询
Agent 自主编码任务执行 端到端完成编码任务
SOLO 单文件编辑 简单代码修改

⚠️ 注意:Agent模式存在循环情况,注意观察日志,防止Token被无效消耗

推荐模型

场景 推荐模型
日常开发 Doubao-seed-2.0-Code
复杂推理 DeepSeek-V4-Pro
通用场景 GLM5.1

三、Qoder 安装与配置

3.1 下载与安装

3.2 注册登录流程

  1. 官网注册账号https://qoder.com/users/sign-up

    • 使用公司邮箱进行注册
    • 实名格式:团队-姓名(如 项目组-姓名)
  2. 申请企业席位:向 AI Coding 负责人申请企业席位邀请链接

3.3 首次配置流程

  1. 首次打开选择界面语言:中文
  2. 可选择导入 VS Code 插件(也可安装后按需导入)
  3. 选择模式:编辑器模式Quest模式(可随时切换)

3.4 对话模式配置

模式 说明
智能问答 简单的问答模式,基于上下文提供解决方案和建议,不修改代码
智能体 自主编码任务执行,具备自我决策、环境感知和工具使用能力

推荐模型

  • 日常开发:Kimi-K2.6、GLM5.1
  • 前端效果不理想:可尝试 Qoder 的极致模式

3.5 Skill配置

目前 IDE 不需要做特殊配置,启动 Qoder 后,可以直接通过提示词输入 / 触发提示,看到各类技能指令。


四、Lingma IDE 安装与配置

4.1 IDE 下载

4.2 专属版配置

访问方式

场景 配置方式
涉及客户项目代码、生产代码等敏感场景 内网连接(默认全员使用)
开发人员 内网连接(默认)
面向非接触客户项目代码的人员 公网连接

内网/公网配置

域名类型 配置地址
内网地址 由企业管理员提供
公网地址 由企业管理员提供

注意:使用公网域名时登陆账号仍需在内网环境下登陆,登陆成功后灵码可在公网环境使用。

配置步骤

  1. 安装 Lingma IDE 后,打开 IDE
  2. 点击右上方 "User Settings""Lingma Settings"
  3. 在 "General" 中,修改 "Dedicated Domain URL" 配置
  4. 修改 "Language" 配置为"简体中文"

4.3 专属版登录

  1. 向团队 AI Coding 负责人统一申请企业版账号
  2. 点击右上角"用户设置" → 登录
  3. 在浏览器中输入分配好的企业专属版账号进行登录
  4. 登录成功后,返回 IDE 客户端可以看到登录的账户名称

注意:初次登陆账号会要求更改密码,请记住修改后的密码。

4.4 对话模式及模型设置

模式 说明
智能问答 纯研发问答模式,根据问题结合上下文给出解决方案和建议,不会直接对工程文件进行修改
智能体 自主的编码任务执行模式,具备自主决策、环境感知、工具使用等能力,可以端到端完成编码任务

推荐模型:Kimi-K2.6、Qwen3.6-plus

4.5 JetBrains IDEs 插件安装

插件下载

配置步骤

  1. 点击 导航 → 设置 → 插件
  2. 在插件市场中搜索 "Lingma" 插件,点击安装
  3. 安装完成后,在右下角可以看到通义灵码的图标,点击选择"高级设置"
  4. 在高级设置中,选择"专属域账号",输入专属域 URL

登录配置

  1. 向团队 AI Coding 负责人统一申请企业版账号
  2. 点击 Lingma 设置中,配置专属域 URL 后,点击登录
  3. 在浏览器中输入分配好的企业专属版账号进行登录

五、CLI 工具安装与配置

5.1 Claude Code

Claude Code 是 Anthropic 推出的终端 AI 编程助手,以 Agent 模式在终端内完成代码生成、文件修改、命令执行等任务。

npm install -g @anthropic-ai/claude-code
  • 首次登录
claude          # 启动交互模式,按提示完成浏览器授权

对话模式

模式 说明 适用场景
交互模式 claude 直接启动 REPL 临时问答、小任务
Agent模式 自动执行多步任务 端到端编码、重构、修复
非交互模式 claude -p "提示词" CI/CD 流水线、脚本调用

推荐模型

场景 推荐模型
日常开发 claude-sonnet-5(默认)
复杂推理 claude-opus-4-8
轻量任务 claude-haiku-4-5

规则配置(CLAUDE.md)

在项目根目录创建 CLAUDE.md,Claude Code 会自动加载作为项目规范:

# 项目规范

## 技术栈
- 后端:SpringBoot 3.x + Java 17
- 前端:Vue3 + TypeScript

## 编码规范
- 使用驼峰命名
- 所有接口必须有参数校验
- 禁止使用 System.out.println,统一用 SLF4J

注意CLAUDE.md 等同于其他工具的 Rules 文件,是 Claude Code 获取项目上下文的核心入口。


5.2 Codex CLI

Codex CLI 是 OpenAI 推出的终端 AI 编程工具,支持代码生成、解释、修复。

npm install -g @openai/codex
  • 首次配置
export OPENAI_API_KEY="your-api-key"
codex          # 启动交互模式

审批模式

模式 说明
suggest(默认) 建议变更,人工确认后执行
auto-edit 自动修改文件,执行命令需确认
full-auto 完全自主执行,适合沙箱环境
codex --approval-mode full-auto "修复所有单元测试"

规则配置(AGENTS.md)

在项目根目录创建 AGENTS.md 提供项目规范,Codex 会自动读取:

# 项目约定
- 所有新增函数必须配套单元测试
- 代码风格遵循 Google Java Style Guide

5.3 OpenCode

OpenCode 是开源的终端 AI 编程助手,兼容 Claude、OpenAI、Gemini 等多种模型提供商。

npm install -g opencode-ai
# 或使用 Go 安装
go install github.com/opencode-ai/opencode@latest
  • 首次配置
opencode        # 启动,按提示选择模型提供商和 API Key

配置文件(opencode.json)

在项目根目录创建 opencode.json

{
  "model": "claude-sonnet-5",
  "provider": "anthropic",
  "apiKey": "${ANTHROPIC_API_KEY}"
}

对话模式

模式 说明
Chat 代码问答,不修改文件
Agent 自主执行编码任务,修改文件并运行命令

5.4 三款 CLI 工具对比

工具 厂商 默认模型 规则文件 开源 适用场景
Claude Code Anthropic claude-sonnet-5 CLAUDE.md Agent编码、复杂任务、CI集成
Codex CLI OpenAI gpt-4o AGENTS.md 代码生成、批量修复
OpenCode 开源社区 可配置 opencode.json 多模型灵活切换

5.5 CLI 工具与 IDE 工具协同使用

阶段 推荐工具 说明
上下文构建 Cursor / Claude Code 梳理存量代码、生成项目规范
日常需求开发 Trae / Qoder / Lingma GUI 工具,交互体验好
CI/CD 自动化 Claude Code / Codex CLI 流水线内无人值守代码修复
批量重构 OpenCode / Claude Code 跨文件批量改动
安全扫描修复 Claude Code Agent模式 自动扫描并修复安全漏洞

六、项目规则配置(Rules)

5.1 规则配置概述

核心原则:规范先行

通过约定存量项目工程的业务规范,引导 AI 分析当前项目的技术架构与业务架构进行功能设计和编码。

5.2 Trae/Qoder 规则配置

添加项目级规范

  1. 打开 Trae/Qoder IDE
  2. 在设置 → 规则中,点击"添加"按钮
  3. 输入规则名称并创建规则
  4. 创建完成后会在项目根目录下的 .trae/rules.qoder/rules 目录下创建对应文件

规范参考案例

项目类型 参考案例 说明
前端规范 frontend-rules 包含 Vue2/Vue3 等前端框架规范
后端规范 code-style Java编码规范
私有技术栈 custom-framework 自定义框架规范

重要:各项目组需要参考规范案例编写自己的项目规则

5.3 规则文件类型

规则类型 文件位置 主要内容 作用
公共技术规范 /project/tech.md 技术栈、依赖管理、MDB规范、SDL/RDL接口规范 统一开发框架、规范接口定义
工程结构规范 /project/structure.md 目录架构、模块分类、代码组织方式 明确代码组织方式、便于AI协作
工程构建规范 /project/build.md 项目构建方式说明 明确代码构建方法
模块规范 /模块目录/readme.md 各业务模块功能定义、处理流程、接口规范 明确业务边界、规范模块间协作
私有技术规范 common_rule 技术栈、目录结构、三方组件使用、日志打印 适配私有框架

七、Skills 技能配置

6.1 Skills 概述

Skills(技能)是为编程智能体扩展特定能力的包,包含:

  • SKILL.md:技能入口,评估流程、合规规则、报告生成说明
  • assets/:技能资源文件
  • references/:技能参考资料
  • scripts/:技能脚本

6.2 Skills 安装方式

Trae IDE

项目根目录创建 .trae/skills 目录,下载使用手册并解压到 skills 目录下

Qoder IDE

项目根目录创建 .qoder/skills 目录,下载使用手册并解压到 skills 目录下

注意:目前 IntelliJ IDEA 的插件暂不支持 Skills 能力,请使用 Lingma AI IDE 或 Qoder

6.3 常用 Skills 一览

技能名称 用途 适用场景
UI-UX-PRO-MAX UI/UX设计技能 智能原型设计、67种UI风格
architecture-review 架构合规检查 12维度架构评估、组件合规性检查
ddl_to_java_generator SQL生成Java代码 数据库表结构转Java实体
test-case-generator 测试用例生成 基于Spec文档生成测试用例
ui-automation UI自动化测试 Playwright智能生成测试脚本
私有全栈框架 私有技术栈开发 私有全栈一体化开发
openspec C++开发工作流 需求→分析→设计→编码全流程

6.4 UI-UX-PRO-MAX 安装与使用

Skill下载

# 全局安装技能
npm install -g uipro-cli

# 进入项目目录
cd /path/to/your/project

# 生成Qoder技能(可迁移至灵码)
uipro init --ai qoder

功能特性

特性 数量 说明
UI风格 67种 毛玻璃、黏土拟物、极简主义、粗野主义、新拟物等
配色方案 161套 针对不同行业定制
字体搭配 57组 精选排版组合
图表类型 25种 数据仪表盘与分析场景
技术栈 15种 React、Next.js、Vue、Nuxt等
UX设计指南 99条 最佳实践、反模式、无障碍规范

6.5 architecture-review 架构合规检查

目录结构

architecture-review/
├── SKILL.md                    # 技能入口
├── checklist.md                # 12维度详细检查清单
├── report-template.md          # 评估报告模板
├── component-compliance.md     # 组件合规说明
├── project-custom.example.md   # 项目自定义配置示例
└── data/                       # 公司级禁止清单
    ├── java-banned.json        # Java禁止组件(约110条)
    ├── middleware-banned.json  # 中间件禁止清单(约48条)
    └── vue-banned.json         # Vue禁止组件

配置步骤

  1. 下载 Skills 配置文件
  2. 使用 Lingma IDE 打开目标项目
  3. 将文件拷入 .trae/skills 文件夹下并解压

使用方法

在智能体模式下,引用该 Skills,然后输入:

帮我完成整体架构评估

执行完成后会在当前项目目录下生成评估报告:architecture-review-report.md

添加自定义稽查规则

.trae/skills/architecture-review 文件夹下创建 project-custom.md 即可。

6.6 私有技术栈 Skills

安装配置

  1. 下载私有技术栈的 Skills
  2. 针对 Trae IDE:项目根目录创建 .trae/skills 目录,解压到 skills 目录下
  3. 针对 Qoder IDE:项目根目录创建 .qoder/skills 目录,解压到 skills 目录下

编写规范

规范类型 说明
page_rules 前端页面规则
common_rule 后端规则,包括技术栈、目录结构、三方组件使用、日志打印等

业务规范模板

  • 后端规则模板参考
  • 任务开发参考模板
  • 新业务开发参考

八、MCP 服务配置

7.1 Figma MCP 配置

安装 Figma 桌面应用

  1. 下载 Figma 桌面应用:https://www.figma.com/downloads/
  2. 在本地 Figma 应用程序中打开设计稿
  3. 开启 DEV 模式

开启 MCP 服务

  1. 点击 Figma 客户端右侧 MCP 配置区域 "Enable desktop MCP server" 按钮
  2. 获取 MCP server 地址:http://127.0.0.1:3845/mcp

注意:专业设计工具生成的高保真设计稿通常自带 Figma MCP 功能,其他设计稿需要购买付费账号

Trae 中配置 Figma MCP

{
  "mcpServers": {
    "figma-mcp": {
      "url": "http://127.0.0.1:3845/mcp"
    }
  }
}

注意:在使用 Figma MCP 生成代码过程中会调用 MCP 截图工具,请使用多模态模型 qwen3.6-plus

7.2 Mermaid 插件安装

当 Markdown 文档中有 Mermaid 流程图时,需要特殊插件才能展示。

Lingma IDE 安装

在 Lingma IDE 中安装 Mermaid 插件,安装完成后点击右上角按钮预览即可看到流程图。


九、技术栈规范

8.1 开源技术栈

层级 技术栈 说明
前端框架 Vue3 主流前端框架
后端框架 SpringBoot 主流后端框架
AI支持 依赖大模型开源主流框架内生能力 可直接使用

8.2 私有技术栈

框架 特点 适配状态
私有全栈框架 全栈一体化开发模式,同时生成前端界面和后端业务逻辑代码 ✅ 已适配
私有Vue2组件库 Vue2私有组件库 ✅ 已适配
私有后端框架 后端框架 ✅ 已适配

建议:私有技术栈不及开源技术栈的 AI Coding 效果,后续可以引导进行架构治理,逐步迭代升级为开源技术栈。

8.3 C++ 技术栈

Openspec 安装配置

# 安装Openspec
npm install -g @fission-ai/openspec@latest

# 下载 Openspec 定制包
# 放到目标项目的根目录(.git)同级目录下

Openspec 目录结构

openspec/
├── project/
│   ├── structure.md      # 工程结构规范
│   ├── tech.md           # 公共技术规范
│   └── build.md          # 代码构建规范
├── requirements/
│   └── templates/
│       ├── requirement-template.md   # 需求规格模板
│       └── research-template.md      # 需求分析模板
├── designed-template.md             # 详细设计模板
├── tasks-template.md                # 任务清单模板
├── skills/
│   └── xxx/SKILL.md                 # 技能
├── workflows/
│   └── opsx-xxx.md                  # 工作流指令
├── project_rules.md                 # 项目规则文档
├── install.sh/bat                   # 安装脚本
└── report.sh/bat                    # 指标采集脚本

十、架构合规核查

9.1 架构合规检查清单(12维度)

序号 维度 检查内容
1 代码结构 目录架构、模块分类、代码组织方式
2 技术栈合规 技术选型、版本管理、依赖管理
3 安全规范 敏感信息、SQL注入、XSS防护
4 性能规范 慢查询、缓存使用、资源释放
5 命名规范 类名、方法名、变量名、文件名
6 代码风格 格式化、注释规范、代码复用
7 接口规范 RESTful规范、参数校验、错误处理
8 数据库规范 SQL规范、索引设计、分表分库
9 日志规范 日志级别、日志内容、日志存储
10 配置规范 配置文件、环境变量、敏感配置
11 测试规范 单元测试覆盖率、测试用例质量
12 部署规范 容器化、版本管理、回滚机制

9.2 组件禁止清单

Java 禁止组件

  • 约110条禁止使用的组件
  • 包含 groupId/artifactId、状态、替换建议

中间件禁止清单

  • 约48条禁止使用的中间件

Vue/前端禁止组件

  • 如 concurrently 等

十一、开发设计文档编写规范

10.1 文档类型

文档类型 模板 用途
业务方法设计文档 业务方法设计-XXX(模板) 内部调用的业务方法
业务接口设计文档 业务接口设计-XXX(模板) 功能模块的对外接口

10.2 文档编写流程

业务方法/接口设计文档

  1. 下载模板

    • 内部方法:下载"业务方法设计-用户信息(模板)"
    • 接口功能:下载"业务接口设计-实验管理(模板)"
  2. 人工编写核心章节

    • 业务方法:方法概述、处理流程
    • 业务接口:功能概述、处理流程
  3. AI辅助补全

    • 拖拽模板、补全规则、数据模型到对话上下文
    • 使用提示词:请按照《XXX补全规则》对《XXX》进行文档补全
  4. 评审确认

    • 与开发组长或产品经理评审
    • 评审通过后进入开发态

10.3 任务开发文档

文档结构

# 前端需求设计文档

## 约束条件
- 严格按照任务中指定的文件路径生成文件
- 严格遵守项目规范

## 需求
- 类型:新增需求
- 文件路径:/path/to/file.vue
- 需求说明:
  - 功能点1
  - 功能点2

接口文档引用

## 接口文档
[接口文档](设计文档.md)

## 任务清单

### 1. 页面1
- 组件类型:有左侧菜单的页面
- 文件路径:src/views/xxx.vue
- 页面路由:/xxx
- 说明:
  - 使用figma mcp服务将设计稿转换为代码
  - 新建功能:主要按钮,点击打开弹窗
  - 列表功能:使用接口文档中的接口:X.X.X 接口名称

十二、存量系统开发配置

11.1 存量系统上下文构建

Context目录结构图

工具选择

阶段 推荐工具 模型
上下文构建阶段 Cursor/Copilot Claude
需求开发阶段 Qoder Kimi-K2.6/GLM5.1

Context 目录结构

.ai-sdd/context/
├── business/        # 业务上下文
│   ├── domain/      # 领域术语
│   ├── rules/       # 业务规则
│   └── flows/       # 业务流程
├── data/            # 数据上下文
│   ├── models/      # 数据模型
│   ├── relations/   # 表关系
│   └── dicts/       # 枚举字典
├── engineering/     # 工程上下文
│   ├── coding/      # 编码规范
│   ├── interface/   # 接口规范
│   ├── ui/          # UI规范
│   └── db/          # DB规范
├── security/        # 安全上下文
├── system/          # 系统上下文
│   ├── arch/        # 架构说明
│   ├── modules/     # 模块视图
│   └── patterns/    # 设计模式
├── sdd/             # SDD流程上下文
│   ├── index/       # 上下文索引
│   └── templates/   # SDD模板
└── changes/         # 按需求工单隔离的临时上下文

11.2 需求分类分级

需求分类分级图

模式 需求类型 典型场景 推荐路径
Full-SDD 复杂需求 跨多仓库、状态机流转、核心业务逻辑 完整SDD流程
Lite-SDD 简单需求、Bug修复 单模块修改、规则简单、简单CRUD 简化流程
Skill Coding 配置变更 需求复杂但改动不涉及代码 定制化Skills
Vibe Coding 简单开发 UI调整、文字修改、明确漏洞修复 直接实施

十三、快速参考卡片

13.1 工具配置速查

工具 安装包大小 配置文件位置 登录方式
Trae ~100MB ~/.trae/ 企业邮箱
Qoder ~200MB ~/.qoder/ 企业邮箱+邀请码
Lingma IDE ~300MB ~/.lingma/ 企业专属账号
Lingma插件 ~50MB IDEA插件目录 企业专属账号
Claude Code ~10MB ~/.claude/ Anthropic账号/API Key
Codex CLI ~10MB ~/.codex/ OpenAI API Key
OpenCode ~15MB ./opencode.json 各模型提供商 API Key

13.2 模型推荐速查

场景 Trae推荐 Qoder推荐 Lingma推荐 Claude Code推荐
日常开发 Doubao-seed-2.0-Code Kimi-K2.6 Kimi-K2.6 claude-sonnet-5
复杂推理 DeepSeek-V4-Pro GLM5.1 Qwen3.6-plus claude-opus-4-8
前端开发 GLM5.1 GLM5.1(极致模式) Qwen3.6-plus claude-sonnet-5
多模态 - - Qwen3.6-plus claude-sonnet-5

13.3 常见问题排查

问题 解决方案
Agent模式循环 观察日志,手动中断,检查提示词
Token消耗过快 使用Lite-SDD模式,减少上下文
代码不符合规范 检查Rules配置,更新项目规范
Figma MCP连接失败 确认Figma桌面应用开启MCP服务
Skills不生效 确认Skills目录位置正确
Claude Code无法连接 检查 API Key 或重新执行 claude 登录授权
Codex CLI权限被拒 切换为 suggest 模式,逐步确认变更
OpenCode模型切换失败 检查 opencode.json 中的 provider 和 apiKey 配置