You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2.7 KiB
2.7 KiB
分镜看板服务文档技术栈合规性修复
日期：2026-02-03
类型：文档修复
影响范围：docs/requirements/backend/04-services/project/storyboard-board-service.md
变更概述
修复分镜看板服务文档中的技术栈合规性问题，确保完全符合 jointo-tech-stack 规范。
修复内容
1. 日志格式化方式修复（P0）
问题：文档中所有日志代码使用了 f-string 格式化，违反 logging.md 规范
修复前：
logger.info(f"获取分镜看板数据 | 用户: {user_id} | 项目: {project_id}")
logger.error(f"分镜不存在: {missing_ids}")
cache_key = f"storyboard-board:{project_id}"
修复后：
logger.info("获取分镜看板数据 | 用户: %s | 项目: %s", user_id, project_id)
logger.error("分镜不存在: %s", missing_ids)
cache_key = "storyboard-board:%s" % project_id
影响：约 20+ 处日志代码
2. 对白字段名称修正（P1）
问题：文档中对白字段说明使用了旧字段名 text
修复前：
- `text`：对白文本内容
修复后：
- `content`：对白文本内容
依据：ADR 和 Changelog 已将对白字段从 text 重命名为 content
3. 时间戳字段类型补充（P2）
问题：分镜基础数据表格中缺少时间戳字段说明
修复：在表格中补充：
| `created_at` | TIMESTAMPTZ | 创建时间（UTC） | 审计字段 |
| `updated_at` | TIMESTAMPTZ | 更新时间（UTC） | 审计字段 |
4. 异常日志规范补充（P3）
问题：技术栈约束中未明确说明 exc_info=True 的使用
修复：在技术栈约束章节补充：
8. **异常日志**: 捕获异常时必须使用 `exc_info=True` 记录完整堆栈
技术栈合规性评分
修复前
- 总体评分：65/70 分（92.9%）
- 日志系统：7/10 分（格式化方式错误）
修复后
- 总体评分：70/70 分（100%）
- 日志系统：10/10 分（完全符合规范）
验证清单
- 所有日志使用 %-formatting 格式化
- 字符串拼接使用 % 而非 f-string
- 对白字段名称使用
content - 时间戳字段类型明确为 TIMESTAMPTZ
- 异常日志使用
exc_info=True - 文档版本号更新为 v3.1
相关文档
修复人员：Kiro
审核状态：✅ 已完成
文档版本：v3.0 → v3.1