s3://rustfs-brand/voice/Guidelines · Voice
Voice语言与文案
Conclusion first, then evidence; facts instead of adjectives.
Person you / weLanguages 中文 · EnglishStandard Verifiable
VoiceHow RustFS sounds
The brand traits, in writing.
| Trait | Habit | Write | Avoid |
|---|---|---|---|
| Exact | Give the number, unit, condition and date. | With EC 4+2, data stays readable with any two drives offline. | Ultra-reliable. Never lose data. |
| Candid | Label previews and limits. | S3 Tables is in preview. | Full support for every table format. |
| Engineered | Conclusion, then cause, then steps. | Upload failed: the bucket has reached its quota. Raise the quota or delete old versions. | — |
| Open | Speak as a peer and invite participation. | Issues and pull requests are welcome on GitHub. | Users are strictly required to… |
Tone by contextTone by context
One voice; the tone shifts with context.
| Context | Tone | Key points |
|---|---|---|
| Documentation | Neutral, direct | Second person, actionable steps |
| Website and ads | Confident, restrained | One message, footnoted conditions |
| Release notes | Clear, complete | Breaking changes first |
| Security advisories | Calm, precise | ID, scope, severity, fixed version |
| Community and social | Friendly, level | Thank specific people; no memes |
| Error messages | Specific, actionable | Cause and fix; no apology |
TerminologyTerminology
Use these terms in both languages.
| 中文 | English | Notes |
|---|---|---|
| 对象存储 | object storage | RustFS's category; never “file system” |
| 存储桶 | bucket | — |
| 对象 | object | — |
| 纠删码 | erasure coding | Abbreviated EC, written EC 4+2 |
| 纠删集 | erasure set | — |
| 数据块 / 校验块 | data shard / parity shard | — |
| 存储池 | pool | Capacity grows by pools |
| 位腐烂保护 | bitrot protection | — |
| 自愈 / 修复 | healing / heal | Use 修复 as the noun; Healing as the feature name |
| 版本控制 | versioning | — |
| 对象锁定 | Object Lock (WORM) | Feature name capitalised |
| 服务端加密 | server-side encryption (SSE) | — |
| 站点复制 / 存储桶复制 | site replication / bucket replication | — |
| 生命周期管理 | lifecycle management (ILM) | — |
| 分层存储 | tiering | — |
| 控制台 | Console | Product name RustFS Console is not translated |
Writing rulesWriting rules
| Item | Rule |
|---|---|
| Headings | Sentence case; no full stop in Chinese |
| Buttons | Start with a verb that names the result |
| Numbers | See the numbers rules on Typography |
| Claims | Verifiable, with conditions and source |
| Comparisons | Verifiable facts only; never disparage |
| Preview features | Label as Preview |
| Link text | Describe the target, never “click here” |
| Inclusive language | allowlist / denylist, primary / replica |
Word listWord list
The left column cannot be verified; write the right.
| Avoid | Write instead |
|---|---|
| Fastest, best, world-leading, number one | A like-for-like measurement with conditions and date |
| 100% S3 compatible | Compatible with the S3 API; see the compatibility matrix |
| Military-grade, absolutely secure | The mechanism: SSE-KMS, Object Lock, IAM policies |
| Zero ops, works out of the box | The steps and time: two commands start a single node |
| Disruptive, revolutionary, magic | The specific problem it solves |
| Empower, leverage, synergy | Say who does what |
ExamplesSide by side
GET throughput on 1 MiB objects is 38% higher than the previous release.
4 × NVMe · 25 GbE · tested 2026-10-14 · method in the benchmark notes
The fastest object storage ever! Crushes every competitor!!
Cannot delete bucket my-bucket
The bucket still holds 1,284 objects. Empty it first, or delete with --force.
Oops, something went wrong!
We're so sorry. Please try again later.
Same meaning in both languages, never word for word.