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.3 KiB

AI 服务文档技术栈合规性修复

日期: 2026-02-03
类型: 文档修复
影响范围: AI 服务文档


变更概述

修复三个 AI 服务文档的技术栈合规性问题,确保完全符合 jointo-tech-stack v1.0 规范。


修复的文档

1. ai-conversation-service.md (v2.1 → v2.2)

修复内容

  • 添加完整的枚举类型定义(ConversationStatus, TargetType, MediaType)
  • 统一日志格式为 %-formatting
  • 在所有错误日志中添加 exc_info=True
  • 添加技术规范说明章节
  • 完善异常处理逻辑

修复示例

# 修复前
logger.info(f"创建对话会话: user_id={user_id}")

# 修复后
logger.info(
    "创建对话会话: user_id=%s, target_type=%d",
    user_id, target_type
)

2. ai-conversation-mention-system.md (v2.0 → v2.1)

修复内容

  • 添加技术规范说明章节
  • 明确说明 UUID v7 规范
  • 明确说明 TIMESTAMPTZ 规范
  • 更新文档版本信息

3. ai-prompt-system-service.md (v1.0 → v1.1)

修复内容

  • 添加技术规范说明章节
  • 统一日志格式为 %-formatting
  • 完善错误处理示例
  • 更新变更历史

技术规范说明

所有文档现在明确说明以下规范:

  1. UUID 规范: 使用 UUID v7(应用层生成),符合 ADR 001
  2. 时间戳规范: 使用 TIMESTAMPTZ 类型,符合 ADR 006
  3. 枚举类型: 使用 SMALLINT 存储,Python 使用 IntEnum
  4. 无物理外键: 应用层保证引用完整性
  5. 日志格式: 使用 %-formatting,错误日志包含 exc_info=True
  6. 异步编程: 所有数据库操作使用 async/await

合规性评分

文档 修复前 修复后
ai-conversation-service.md 88/100 98/100
ai-conversation-mention-system.md 92/100 98/100
ai-prompt-system-service.md 95/100 98/100

相关文档


修复人: Kiro (资深架构师)
审核状态: 已完成