75 lines
5.0 KiB
Markdown
75 lines
5.0 KiB
Markdown
# CODE REFERENCE INDEX
|
||
|
||
## 1. 目的
|
||
- 本文档承接 PMFlow 的“新增代码参考模式”与高频代码入口索引。
|
||
- `CLAUDE.md` 只保留摘要与跳转入口；详细的接口、页面、服务参考清单统一维护在这里。
|
||
- 当新增 API、关键页面入口、工作流入口或参考样式发生变化时，应同步更新本文档。
|
||
|
||
## 2. 后端接口参考
|
||
|
||
### 2.1 通用与基础
|
||
- 新增后端接口：参考 `backend/app/api/sstc_api/` 的结构
|
||
- 新增数据库表：参考 `alembic/versions/` 最新 migration
|
||
- 新增飞书事件处理：参考 `backend/app/services/integrations/feishu_integration_service/`
|
||
- 飞书卡片动作回调：参考 `backend/app/api/feishu_api/card_action_routes.py` 与 `backend/app/services/integrations/feishu_integration_service/mixin_card_action.py`
|
||
- 用户管理接口：参考 `backend/app/api/users_api/`（统一前缀 `GET /users/`、`GET /users/me`、`GET /users/available`、`GET /users/{user_id}`）
|
||
- 审计查询接口：参考 `backend/app/api/audit.py`（`GET /audit/operations`）
|
||
- 配置读取类接口：参考 `backend/app/api/llm_providers.py`（`GET /ai-steward/llm/providers`）
|
||
- LLM 引擎设置接口：参考 `backend/app/api/llm_engines.py`（`PUT /ai-steward/llm-engines/settings`）
|
||
|
||
### 2.2 AI Steward / Training / Mounted Runtime
|
||
- 项目创建接口：参考 `backend/app/api/ai_steward_api/routes_capture.py`
|
||
- 模型路由配置接口：参考 `backend/app/api/model_routing.py`
|
||
- 回复质量闭环接口：参考 `backend/app/api/ai_steward_api/routes_reply_iteration.py`
|
||
- 训练/微调管线接口：参考 `backend/app/api/ai_steward_api/routes_training_pipeline.py`
|
||
- Mounted Runtime 控制台接口：参考 `backend/app/api/ai_steward_api/routes_mounted_ai.py`
|
||
- 老板晨报接口：参考 `backend/app/api/ai_steward_api/routes_executive_briefing.py`
|
||
- 每日简报 v2 接口：参考 `backend/app/api/ai_steward_api/routes_brief_blockers.py`
|
||
- 脏数据修复接口：参考 `backend/app/api/ai_steward.py`（`POST /ai-steward/signal-sources/repair-dirty`）
|
||
- AI Steward 指挥规划接口已移除：`POST /ai-steward/command/dispatch`
|
||
|
||
### 2.3 RAG / AI PMO / Knowledge Graph
|
||
- RAG 问答主入口：参考 `backend/app/api/rag_api/` 与 `backend/app/api/rag_ask_contract.py`
|
||
- KG 上下文闭环接口：参考 `backend/app/api/knowledge_graph.py`
|
||
- 任务包中心接口：参考 `backend/app/api/task_briefs.py`
|
||
- AI PMO 恢复接口：参考 `POST /ai-pmo/work-items/{work_item_id}/resume`
|
||
- AI PMO 草稿决策接口：参考 `POST /ai-pmo/work-items/{work_item_id}/draft-decision`
|
||
- AI PMO 审批接口：参考 `POST /ai-pmo/work-items/{work_item_id}/decision`
|
||
- AI PMO 消息台列表接口：参考 `GET /ai-pmo/work-items`
|
||
|
||
### 2.4 Signal / Project / SSTC
|
||
- 需求点落信号源：参考 `backend/app/services/signal/signal_source_orchestration/mixin_registry_execute.py`
|
||
- 飞书捕获模拟接口：`POST /ai-steward/signal/capture-feishu`
|
||
- 项目删除接口：参考 `backend/app/api/projects.py`
|
||
- 项目成员分配接口：参考 `backend/app/api/projects.py` + `backend/app/services/project_member/service.py`
|
||
- 通用任务拆解接口：参考 `POST /tasks/breakdown`
|
||
- SSTC 总览接口：参考 `GET /projects/{project_id}/sstc/overview`
|
||
- SSTC 信号列表接口：参考 `GET /projects/{project_id}/signals`
|
||
- SSTC 宪章详情接口：参考 `GET /projects/{project_id}/charters/{charter_id}`
|
||
- SSTC 宪章 AI 预填充接口：参考 `POST /projects/{project_id}/charters/{charter_id}/ai-prefill`
|
||
- SSTC AI 拆解接口：参考 `POST /projects/{project_id}/charters/{charter_id}/tasks/ai-breakdown`
|
||
- SSTC 发布验证生成接口：参考 `POST /projects/{project_id}/releases/{release_node_id}/verification/generate`
|
||
- SSTC 负责人推荐接口：参考 `POST /projects/{project_id}/tasks/{task_id}/recommend-assignee`
|
||
- SSTC 任务更新接口：参考 `PATCH /projects/{project_id}/tasks/{task_id}`
|
||
- SSTC 发布创建接口：参考 `POST /projects/{project_id}/releases`
|
||
|
||
## 3. 前端参考
|
||
- 新增前端 API 调用：参考 `frontend/src/api/sstc.ts`
|
||
- AI Steward 页面入口：参考 `frontend/src/pages/ai-steward/`
|
||
- Inbox 页面入口：参考 `frontend/src/pages/inbox/`
|
||
- Scheduler Center / Mounted AI Console：参考 `frontend/src/pages/scheduler-center/`
|
||
- SSTC 工作流组件：参考 `frontend/src/components/sstc/`
|
||
- Model Routing 页面：参考 `frontend/src/pages/model-routing-config/`
|
||
|
||
## 4. 模型与配置真源
|
||
- 模型配置唯一来源：参考 `backend/app/services/model/model_config.py`
|
||
- 路由规则真源：`backend/.control_plane/pmflow-routing-rules.json`
|
||
- Prompt 聚合：`backend/app/config/ai_prompts.py`
|
||
- Prompt 场景化分片：`backend/app/config/ai_prompts_catalog/`
|
||
- Prompt registry：`backend/app/config/ai_prompt_registry.py`
|
||
|
||
## 5. 维护建议
|
||
- 新增接口时：先更新本文档，再同步 `API_CONTRACTS.md`
|
||
- 新增页面/关键入口时：同步本文档与 `ARCHITECTURE_INVENTORY.md`
|
||
- 若某条参考入口已经下线，应直接从本文档移除，不保留历史死链
|