Ferroma v0.1.7
参考 · 文档

术语表 — Ferroma 文档中译

本文件是 docs/ 中文版的唯一术语来源。十份文档由不同译者在同一时间产出,只有 共用这份表,读者才能把它们当成一套文档来读。

英文侧的术语源文件是 ../GLOSSARY.md:它记录同一批决定,并给出每条术语 在英文文档中的首选写法。两份文件不是译本关系,改动一处就要同步另一处。

一、绝不翻译的内容

以下内容一律原样保留,包括大小写与标点。译错一个字符就等于文档说谎:

  • 配置键server.hostnamelimits.max_message_sizeapi.jwt_secret
    [dns] resolverstls.cert_path 等。保留点号与方括号。
  • 环境变量DATABASE_URLFERROMA_JWT_SECRETFERROMA__API__WEBMAIL_DIR
    FERROMA__API__ADMIN_DIRFERROMA__API__SHARED_DIR
  • 命令行ferroma serveferroma database initcargo test --workspace
  • HTTP 方法与路径GET /api/v1/messages/{id}DELETE /api/v1/drafts/{id}
  • 协议关键字EHLOMAIL FROMRCPT TODATAIDLEAPPENDFETCH
  • 错误码与应答码550 5.1.1426 Upgrade Required4.2.25.3.4
  • Rust 类型与标识符FerromaError::MailboxFullClientHandleSyncChange
    ferroma-mailDatabase::connect
  • 数据库对象:表名、列名、change_logrfc_message_idTIMESTAMPTZ
  • JSON 字段名"type"message_id_headeraccess_token
  • 文件名与路径web/migrations/0001_initial.sql/var/lib/ferroma
  • RFC 编号:RFC 5322、RFC 3501、RFC 7489(写「RFC 5322」而不是「RFC 5322 标准」)。

二、术语对照

英文中文说明
mail core邮件核心ferroma-mail 这一层
repository / repositories仓储层不译作「仓库」(那是 git 的意思)
mailbox邮箱指一个地址对应的容器
folder文件夹IMAP 文件夹,与邮箱区分
message邮件不用「消息」;email 也写「邮件」
envelope信封SMTP 信封(MAIL FROM / RCPT TO)
header头部 / 头字段按语境;Received: 这类叫「头字段」
body正文不用「身体」
attachment附件
blob store二进制存储内容寻址的附件存储
content-addressed内容寻址
quota配额
cursor游标增量同步位置
change log变更日志数据库表 change_log
incremental sync增量同步
idempotency key幂等键
outbox发件箱客户端待发队列
device设备客户端注册的设备
session会话
access token访问令牌
refresh token刷新令牌
throttling限流登录尝试限制
open relay开放中继
relay中继
submission提交587 端口,认证后发信
inbound / outbound收信 / 发信不用「入站 / 出站」描述邮件方向
delivery投递
queue队列
retry重试
bounce退信
quarantine隔离策略判定后放入 Junk
deliverability投递率
resolver解析器DNS
lookup查询DNS 查询
blackhole黑洞式丢弃指不回应答的解析器
deadline / budget超时上限 / 预算区分「兜底上限」与「实际预算」
preflight预检ferroma doctor
health check健康检查
migration迁移数据库
MaildirMaildir保持原样
front-end前端名词与定语,指 web/admin/;不写作 frontend
WebmailWebmail保持原样,不译作「网页邮件」
AdminAdmin保持原样;不译作「管理后台」,首次出现可写「Admin 管理后台」
client客户端指官方桌面客户端
shell外壳指图形外壳
core核心
seam接缝接口边界
contract契约指冻结的接口约定
drift漂移实现与文档不一致
hollow green虚假的绿色测试跳过却被当成通过
ratchet棘轮只允许单向收紧的约束
acceptance run验收运行server/tests/e2e.rs
fixture夹具测试数据
gate / gated门控
operator运维者指运行主机的人;不写作「操作者」,也别与搜索运算符混淆
login / log in登录名词与动词同形
backup / back up备份名词、定语与动词同形
real time实时real-time 作定语时也写「实时」
first-run wizard首次运行向导首次出现写全称,之后可简称「向导」
named volume命名卷Docker 存储,与「绑定挂载」相对
bind mount绑定挂载Docker 存储,与「命名卷」相对
reverse proxy反向代理首次出现写全称,之后可简称「代理」
release发布一次发布是 X.Y.Z
tag标签给发布命名的标签,如 0.2.0latest
digest摘要镜像 manifest 的不可变摘要;密码与校验和才叫「哈希」
provenance attestation来源证明BuildKit 附加到已发布镜像的声明
layer cache层缓存本地 buildx 缓存:.cache/buildx,检出路径含非 ASCII 字符时改用 $HOME/.cache/ferroma-buildx
sidecar边车已废弃:0.1.3 及更早版本随附的备份/恢复容器,只在历史说明中出现
job作业指「某人分内的事」时写「……的事」
roadmap路线图
TODO待办代码里的 TODO(0.1.8) 保持原样
setup / set up设置(名词)/ 设置(动词)名词与定语用 setup,动词写 set up;别写 set-up

三、文体

  • 用简体中文,技术文档语气:直接、克制、不用感叹号。
  • 英文原文里的破折号插入语(em dash)在中文里用逗号或括号处理,不要照搬
  • 代码块内的注释要翻译,代码本身不翻译。
  • 表格的表头翻译,单元格里的标识符不翻译。
  • 中文与拉丁字母、数字之间加一个空格:写 使用 rustls共 14 天,不写 使用rustls共14 天
    全角标点两侧不加空格,照中文排版直接相连:写 邮件,共 12 封。标识符(路径、配置键、命令)一律放进反引号。
  • 首次出现的术语可以「中文(English)」,之后只用中文。
  • 保持原文的段落划分与章节顺序,不要合并或拆分小节。
  • 保留原文所有的 Markdown 结构:代码块、表格、列表、引用块、链接。

四、交叉链接

中文版位于 docs/zh/,与英文版同级文件名。文档之间的链接指向同目录的中文版

[architecture.md](architecture.md)      ← 正确,指向 docs/zh/architecture.md
[architecture.md](../architecture.md)   ← 错误

指向仓库其它位置(../crates/../config/)的链接保持原样,因为那些文件没有中文版。

Ferroma · AGPL-3.0-only · 源码仓库 · 由 docs/ 生成