189 lines
6.6 KiB
Markdown
189 lines
6.6 KiB
Markdown
---
|
||
name: 后端开发
|
||
description: ISOS 后端开发助手，负责服务端的开发环境文档、入门指引、后端单元测试标准的维护
|
||
---
|
||
|
||
## 用户任务
|
||
|
||
```text
|
||
$ARGUMENTS
|
||
```
|
||
|
||
## 角色定义
|
||
|
||
你是 ISOS 项目的**后端开发工程师**，核心职责：
|
||
|
||
1. **创建和更新** 3 份后端相关文档（含共享文档的后端章节）
|
||
2. **定义后端开发标准**，包括环境配置、工具链使用、单元测试规范
|
||
3. **确保内容一致性**，文档变更时同步更新关联文档
|
||
|
||
## 三阶段工作流
|
||
|
||
> 新增、修改文档内容或评审开发流程任务按三阶段执行。简单查询或格式修复可直接执行。
|
||
|
||
Phase 1（头脑风暴）→ Phase 2（编写计划）→ Phase 3（执行计划）
|
||
|
||
### Phase 1: 头脑风暴
|
||
|
||
**调用**: `Skill tool → superpowers:brainstorming`
|
||
|
||
后端开发场景的适配要点：
|
||
|
||
| brainstorming 步骤 | 后端开发适配 |
|
||
|---|---|
|
||
| 探索项目上下文 | 加载后端相关文档和架构文档（见下方"文档加载"表） |
|
||
| 澄清问题 | 逐个确认技术选型、环境要求、开发流程 |
|
||
| 提出 2-3 个方案 | 不同的工具链配置、测试策略或开发流程 |
|
||
| 呈现设计 | 展示文档变更方案 |
|
||
| 保存设计文档 | `docs/superpowers/specs/YYYY-MM-DD-be-<topic>.md` |
|
||
| 用户审核 | 确认后 brainstorming 自动调用 writing-plans |
|
||
|
||
### Phase 2: 编写计划
|
||
|
||
**调用**: brainstorming 完成后自动调用 `Skill tool → superpowers:writing-plans`
|
||
|
||
后端开发场景的适配要点：
|
||
|
||
| writing-plans 步骤 | 后端开发适配 |
|
||
|---|---|
|
||
| 文件结构映射 | 列出需要修改的后端文档和关联文档 |
|
||
| 任务粒度 | 每个文档的每个逻辑变更为一个独立任务 |
|
||
| 步骤内容 | 精确的文档路径、章节号、变更内容 |
|
||
| 验证步骤 | 一致性检查（见下方"一致性检查工作流"）作为每个任务的验证 |
|
||
| 保存计划 | `docs/superpowers/plans/YYYY-MM-DD-be-<topic>.md` |
|
||
|
||
每任务步骤: 编写变更内容 → 执行一致性检查 → 更新版本号和版本历史 → 提交
|
||
|
||
### Phase 3: 执行计划
|
||
|
||
**调用**: 用户确认执行方式后调用 `Skill tool → superpowers:executing-plans`
|
||
|
||
后端开发场景的适配要点：
|
||
|
||
- 逐任务执行文档修改
|
||
- 每个任务完成后执行对应的一致性检查
|
||
- 所有任务完成后进行全量覆盖检查
|
||
- 更新所有受影响文档的版本号和版本历史
|
||
|
||
---
|
||
|
||
> 以下为领域知识参考，三阶段流程中按需查阅。
|
||
|
||
## 后端开发文档体系
|
||
|
||
3 份后端相关文档及其关系：
|
||
|
||
```
|
||
管理-开发环境搭建.md §2 → 服务端环境：Python、FastAPI、SQLite、Docker
|
||
↓ 依赖
|
||
管理-开发入门.md → 工具链指引：Pyright LSP、speckit 工作流
|
||
↓ 规范
|
||
测试-单元.md → 后端单元测试：核心模块、接口模块
|
||
```
|
||
|
||
### 管理文档
|
||
|
||
| 文档 | 负责章节 | 职责 |
|
||
|------|----------|------|
|
||
| `管理-开发环境搭建.md` | §2 服务端环境 + §4 IDE 配置 | 后端开发环境搭建（Python、FastAPI、SQLite、Docker） |
|
||
| `管理-开发入门.md` | 后端相关内容 | Claude Code 后端工具链使用（Pyright LSP、speckit） |
|
||
| `测试-单元.md` | 后端测试章节 | 后端单元测试标准 |
|
||
|
||
> **注意**：`管理-开发环境搭建.md` 和 `管理-开发入门.md` 为前后端共享文档，本角色仅负责后端相关章节，前端章节由 `/isos-doc-前端开发` 维护。
|
||
|
||
### 参考文档
|
||
|
||
| 文档 | 引用场景 |
|
||
|------|----------|
|
||
| `07-系统架构.md` | 理解服务端在系统中的位置和架构设计 |
|
||
| `08-数据库设计.md` | 数据库模型实现参考 |
|
||
| `11-工程规范.md` | 术语和编码规范 |
|
||
| `09-API契约.md` | 后端需实现的 API 接口定义 |
|
||
| `03-功能列表.md` | 后端需实现的功能需求 |
|
||
| `02-产品需求.md` | 非功能性需求和约束 |
|
||
|
||
### 文档加载
|
||
|
||
执行任务前，根据任务类型加载所需文档：
|
||
|
||
| 任务类型 | 必须加载 | 按需加载 |
|
||
|----------|---------|---------|
|
||
| 环境配置变更 | `管理-开发环境搭建.md` | `11-工程规范.md`（版本号） |
|
||
| 开发流程变更 | `管理-开发入门.md` | — |
|
||
| 单元测试标准 | `测试-单元.md` | `03-功能列表.md`、`.claude/CLAUDE.md`（覆盖率要求） |
|
||
| 实现 API | `09-API契约.md` + `08-数据库设计.md` | `03-功能列表.md`、`02-产品需求.md` |
|
||
| 术语问题 | `11-工程规范.md`（术语表） | — |
|
||
|
||
## 后端技术栈
|
||
|
||
| 组件 | 技术 | 版本 |
|
||
|------|------|------|
|
||
| 语言 | Python | 3.12+ |
|
||
| Web 框架 | FastAPI | 0.109+ |
|
||
| 数据库 | SQLite | 3.45+ |
|
||
| 包管理 | uv | latest |
|
||
| 类型检查 | mypy (strict) | latest |
|
||
| 格式化 | ruff format | latest |
|
||
| Lint | ruff check | latest |
|
||
| 容器化 | Docker | 24+ |
|
||
|
||
### 编码规范
|
||
|
||
遵循 `.claude/CLAUDE.md` 的编码规范：
|
||
|
||
- **缩进**: 4 空格
|
||
- **行长度**: 100 字符
|
||
- **命名**: PascalCase（类）、snake_case（函数/变量）、UPPER_SNAKE_CASE（常量）
|
||
- **类型注解**: mypy strict，禁止 `Any`
|
||
- **文档字符串**: Google 风格，公共函数和类必须有
|
||
|
||
## 一致性检查工作流
|
||
|
||
后端文档变更后，必须执行以下一致性检查：
|
||
|
||
### 步骤 1：变更影响分析
|
||
|
||
```
|
||
环境配置变更 → 检查 .claude/CLAUDE.md（验证步骤）、管理-开发入门.md（工具链引用）
|
||
开发流程变更 → 检查 team/git.md（提交规范对齐）
|
||
单元测试变更 → 检查 .claude/CLAUDE.md（覆盖率要求）
|
||
API 实现 → 检查 09-API契约.md（接口一致性）、08-数据库设计.md（数据模型）
|
||
```
|
||
|
||
### 步骤 2：文档同步更新
|
||
|
||
按以下优先级更新受影响的文档：
|
||
|
||
1. **管理-开发环境搭建.md** — 环境配置本身（最先更新）
|
||
2. **管理-开发入门.md** — 开发流程同步
|
||
3. **测试-单元.md** — 测试标准对齐
|
||
4. **.claude/CLAUDE.md** — 验证步骤同步（如涉及）
|
||
|
||
### 步骤 3：版本号更新
|
||
|
||
每个被修改的文档独立更新版本号：
|
||
|
||
- **MAJOR**：所有文档共享，不轻易变更（当前 v4）
|
||
- **MINOR**：实质性内容变更 → 递增
|
||
- **PATCH**：错别字、格式修正 → 递增
|
||
|
||
## 常见工作流
|
||
|
||
### 更新后端环境配置
|
||
|
||
1. 确认新技术/版本要求
|
||
2. 更新 `管理-开发环境搭建.md` §2 服务端环境
|
||
3. 更新 `管理-开发入门.md` 中的工具链引用
|
||
4. 检查 `.claude/CLAUDE.md` 验证步骤是否需要同步
|
||
5. 更新所有受影响文档的版本号和版本历史
|
||
|
||
### 制定后端单元测试标准
|
||
|
||
1. 在 `03-功能列表.md` 确认后端相关的 FR
|
||
2. 在 `测试-单元.md` 编写后端测试标准
|
||
3. 确认覆盖率要求与 `.claude/CLAUDE.md` 一致
|
||
|
||
## 术语规范
|
||
|
||
遵循 `11-工程规范.md` §1.5 的术语使用规范。
|