s3://rustfs-brand/voice/Guidelines · Voice

语言与文案Voice

先结论,后依据;用事实代替形容词。
人称 你 / 我们语言 中文 · English标准 可验证

Voice品牌口吻

品牌性格在文字上的体现。

特质写法推荐避免
精确给出数字、单位、条件与日期。EC 4+2 配置下,任意两块盘离线时数据仍可读取。极致可靠,永不丢数据。
坦诚标明预览状态与限制。S3 Tables 目前为预览功能。全面支持所有表格式。
工程化先结论,后原因,再步骤。上传失败:存储桶已达配额。请提高配额或删除旧版本。—
开放平视读者,欢迎参与。欢迎在 GitHub 提交 issue 与 PR。用户必须严格遵守……

Tone by context不同场景的语气

口吻不变,语气随场景调整。

场景语气要点
文档中性、直接第二人称,步骤可执行
官网与广告自信、克制一个信息,条件写脚注
发布说明清楚、完整破坏性变更放最前
安全公告冷静、准确编号、范围、严重程度、修复版本
社区与社媒友好、平视感谢具体的人,不玩梗
错误信息具体、可操作说明原因与解决办法,不道歉

Terminology术语表

中英文统一使用以下术语。

中文English说明
对象存储object storageRustFS 的品类;不称作文件系统
存储桶bucket—
对象object—
纠删码erasure coding缩写 EC,写作 EC 4+2
纠删集erasure set—
数据块 / 校验块data shard / parity shard—
存储池pool扩容以池为单位
位腐烂保护bitrot protection—
自愈 / 修复healing / heal名词用「修复」,功能名用 Healing
版本控制versioning—
对象锁定Object Lock (WORM)功能名首字母大写
服务端加密server-side encryption (SSE)—
站点复制 / 存储桶复制site replication / bucket replication—
生命周期管理lifecycle management (ILM)—
分层存储tiering—
控制台Console产品名 RustFS Console 不翻译

Writing rules写作规则

项目规则
标题英文句首大写;中文不加句号
按钮动词开头,说明结果
数字见字体页的数字规范
宣称须可验证,注明条件与来源
比较只比可验证的事实,不贬低他人
预览功能标注「预览」
链接文字描述目标,不写「点击此处」
包容性allowlist / denylist,primary / replica

Word list用词清单

左列无法验证,改用右列的具体表述。

避免改为
最快、最强、全球领先、业界第一同环境实测数据,注明条件与日期
100% 兼容 S3兼容 S3 API,范围见兼容性矩阵
军工级安全、绝对安全具体的机制:SSE-KMS、对象锁定、IAM 策略
零运维、开箱即用具体的步骤数与时间:两条命令启动单节点
颠覆、革命性、黑科技说明它解决的具体问题
赋能、抓手、生态闭环直接说明谁做了什么

Examples对照示例

1 MiB 对象的 GET 吞吐较上一版本提升 38%。

4 × NVMe · 25 GbE · 测试日期 2026-10-14 · 方法见基准测试说明

正确结论、依据、来源齐全。

史上最快的对象存储!性能碾压一切对手!!

错误无法验证的最高级与情绪化表达。

无法删除存储桶 my-bucket
存储桶中仍有 1,284 个对象。请先清空存储桶,或使用 --force 删除。

正确错误信息说明原因与解决办法。

哎呀,出错了!
非常抱歉,请稍后再试。

错误只有道歉,没有信息。
中英文意思相同,不逐字对应。