s3://rustfs-brand/voice/Guidelines · Voice
语言与文案Voice
先结论,后依据;用事实代替形容词。
人称 你 / 我们语言 中文 · English标准 可验证
Voice品牌口吻
品牌性格在文字上的体现。
| 特质 | 写法 | 推荐 | 避免 |
|---|---|---|---|
| 精确 | 给出数字、单位、条件与日期。 | EC 4+2 配置下,任意两块盘离线时数据仍可读取。 | 极致可靠,永不丢数据。 |
| 坦诚 | 标明预览状态与限制。 | S3 Tables 目前为预览功能。 | 全面支持所有表格式。 |
| 工程化 | 先结论,后原因,再步骤。 | 上传失败:存储桶已达配额。请提高配额或删除旧版本。 | — |
| 开放 | 平视读者,欢迎参与。 | 欢迎在 GitHub 提交 issue 与 PR。 | 用户必须严格遵守…… |
Tone by context不同场景的语气
口吻不变,语气随场景调整。
| 场景 | 语气 | 要点 |
|---|---|---|
| 文档 | 中性、直接 | 第二人称,步骤可执行 |
| 官网与广告 | 自信、克制 | 一个信息,条件写脚注 |
| 发布说明 | 清楚、完整 | 破坏性变更放最前 |
| 安全公告 | 冷静、准确 | 编号、范围、严重程度、修复版本 |
| 社区与社媒 | 友好、平视 | 感谢具体的人,不玩梗 |
| 错误信息 | 具体、可操作 | 说明原因与解决办法,不道歉 |
Terminology术语表
中英文统一使用以下术语。
| 中文 | English | 说明 |
|---|---|---|
| 对象存储 | object storage | RustFS 的品类;不称作文件系统 |
| 存储桶 | 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 删除。
哎呀,出错了!
非常抱歉,请稍后再试。
中英文意思相同,不逐字对应。