🌐 Key 多语言管理系统 - 需求设计文档#

📌 一、核心需求梳理#

1. 项目管理#

  • 项目增删改查
  • 项目成员管理
  • 项目权限控制

2. Key 管理#

  • Key 增删改查
  • 批量导入/导出
  • 批量删除
  • 批量替换
  • 版本管理

🔍 二、完整需求文档#

模块一:项目管理#

1.1 项目 CRUD

  • 创建项目(名称、标识、描述)
  • 编辑项目信息
  • 删除项目(软删除,可恢复)
  • 项目列表/详情

1.2 项目成员管理

  • 邀请成员(邮箱/用户名)
  • 移除成员
  • 角色分配(管理员/开发者/翻译/只读)

1.3 项目设置

  • 默认语言设置
  • 启用的语言列表
  • 审核流程开关
  • 机器翻译配置关联

1.4 项目统计

  • Key 数量统计
  • 翻译进度(按语言)
  • 成员活跃度
  • 最近更新时间

模块二:语言管理#

2.1 语言配置

  • 语言代码(en-US, zh-CN, ja-JP)
  • 语言名称(English, 中文,日本語)
  • 文字方向(LTR/RTL)
  • 启用/禁用状态

2.2 缺失翻译检测

  • 扫描未翻译的 Key
  • 生成缺失报告
  • 一键跳转到翻译

2.3 机器翻译集成(⭐ 重点扩展)

2.3.1 翻译配置管理

  • 服务商配置(DeepL / Google Translate / 百度翻译 / 有道 / 通义千问)
  • API Key 管理(加密存储)
  • 接口地址配置
  • 请求限制配置(QPS、并发数)
  • 翻译策略配置(源语言、目标语言映射、翻译风格)
  • 术语表配置(专业词汇固定翻译)
  • 成本控制(单次限制、每日配额、费用估算)
  • 测试连接(API 连通性测试)

2.3.2 翻译记录

  • 记录内容(时间、项目、Key 列表、语言对、原文、译文、服务商、字符数、费用)
  • 查询过滤(时间、项目、语言、状态、服务商)
  • 统计分析(次数、字符消耗、费用、成功率)
  • 导出功能(CSV/Excel)

2.3.3 Key 一键翻译

  • 翻译范围选择(单个/批量/按分组/按语言/全项目)
  • 翻译模式(立即/后台/定时)
  • 翻译流程(选择→配置→估算→执行→结果)
  • 翻译结果处理(成功/失败/部分成功)
  • 批量操作优化(分批请求、失败重试、断点续翻)

2.4 术语表管理

  • 添加术语(原文→固定译文)
  • 术语分类(技术/产品/品牌)
  • 术语导入导出
  • 翻译时自动应用术语表

2.5 翻译记忆库(TM)

  • 存储历史翻译对
  • 相似句段推荐
  • 减少重复翻译成本

模块三:Key 管理#

3.1 Key CRUD

  • 创建 Key(命名、命名空间、默认值)
  • 编辑 Key 内容
  • 删除 Key(软删除)
  • Key 详情(所有语言版本)

3.2 批量操作

  • 批量导入(JSON/YAML/CSV/Excel)
  • 批量导出(多格式)
  • 批量删除
  • 批量替换(查找替换)

3.3 Key 类型支持

  • 普通文本
  • 带参数文本({name} 占位符)
  • 复数形式(one/other)
  • HTML 内容
  • 数组/列表

3.4 Key 分组/标签

  • 命名空间(user.login, user.profile)
  • 自定义标签
  • 树形结构展示

3.5 冲突检测

  • Key 重复检测
  • 格式错误检测
  • 占位符不一致警告

3.6 未使用 Key 扫描

  • 代码扫描(前端项目)
  • 标记未使用 Key
  • 建议清理

模块四:版本管理#

4.1 版本创建

  • 语义化版本号(v1.0.0)
  • 版本说明
  • 版本快照

4.2 版本对比

  • Diff 可视化
  • 新增/修改/删除标记
  • 按语言对比

4.3 版本回滚

  • 选择历史版本
  • 一键回滚
  • 回滚预览

4.4 版本发布流程

  • 草稿状态
  • 审核状态(可选)
  • 已发布
  • 已废弃

4.5 版本标签

  • beta(测试版)
  • stable(稳定版)
  • lts(长期支持)

4.6 版本历史

  • 版本列表
  • 发布时间线
  • 发布人记录

模块五:协作流程#

5.1 翻译状态

  • 待翻译
  • 翻译中
  • 已完成
  • 已审核
  • 需要修改

5.2 翻译进度统计

  • 按语言统计
  • 按项目统计
  • 进度可视化

5.3 审核流程(可配置)

  • 开启/关闭审核
  • 审核人指定
  • 审核意见
  • 通过/拒绝

5.4 变更通知

  • Webhook 配置
  • 邮件通知
  • 飞书/钉钉通知
  • 通知模板自定义

5.5 评论/批注

  • Key 级别评论
  • @提及成员
  • 评论历史

模块六:搜索与分析#

6.1 全局搜索

  • Key 搜索
  • 内容搜索
  • 注释搜索
  • 正则匹配

6.2 高级过滤

  • 按状态过滤
  • 按语言过滤
  • 按类型过滤
  • 按标签过滤

6.3 使用统计

  • 热点 Key(频繁访问)
  • 访问日志

6.4 未使用 Key 检测

  • 代码扫描
  • 引用分析
  • 清理建议

6.5 翻译质量分析

  • 长度异常检测
  • 缺失占位符检测
  • 术语一致性检查

模块七:系统管理#

7.1 用户管理

  • 用户 CRUD
  • SSO/LDAP(可选)
  • 用户组

7.2 角色权限(RBAC)

  • 超级管理员
  • 项目管理员
  • 开发者
  • 翻译人员
  • 只读用户

7.3 操作审计日志

  • 谁在何时做了什么
  • 操作类型过滤
  • 日志导出

7.4 数据备份/恢复

  • 自动备份(每日)
  • 手动备份
  • 一键恢复

7.5 系统监控

  • 性能监控
  • 错误日志
  • 告警配置

🎯 三、优先级建议#

优先级模块说明
P0项目管理 + Key 管理核心功能
P0多语言管理 + 导入导出核心功能
P0机器翻译集成核心差异化功能
P1版本管理基础版本控制
P2协作流程翻译审核
P2搜索过滤提升效率
P3统计分析优化参考
P3术语表 + 翻译记忆库高级功能

📊 四、数据表设计#

翻译配置表#

id, project_id, provider, api_key_encrypted, api_endpoint
qps_limit, daily_quota, style, auto_detect_source
default_source_lang, mark_as_review, created_at, updated_at

翻译记录表#

id, project_id, config_id, batch_id, key_ids
source_lang, target_lang, total_chars, estimated_cost
status, success_count, failed_count, error_message
started_at, completed_at, created_at

翻译记录详情表#

id, log_id, key_id, original_text, translated_text
status, error_message, chars_count, created_at

术语表#

id, project_id, source_term, target_term, target_lang
category, notes, created_at

翻译记忆库#

id, project_id, source_text, target_text
source_lang, target_lang, usage_count, created_at

🔄 五、一键翻译流程#

用户操作
   ↓
选择翻译范围(单个/批量/全部)
   ↓
选择源语言 + 目标语言
   ↓
选择翻译服务商
   ↓
系统检查配置 → 无配置则引导配置
   ↓
费用估算(字符数 × 单价)
   ↓
用户确认
   ↓
执行翻译(同步/异步)
   ↓
结果处理(成功/失败/部分成功)
   ↓
记录日志(统计和审计)

📄 文档版本:v1.0 创建时间:2026-03-09 会话:main-session