ZecHub 风格指南

ZecHub 的风格应简洁、易于接近。我们欢迎每一个人，并专注于 Zcash 社区。

原则

1. 随时提供帮助 - 向 Zcash 用户展示我们与他们站在一起。

2. 简明扼要： 传达尽可能简单的信息。先讲最重要的点。

3. 以用户为中心： 我们优先为用户写作，其次是开发者，最后是其他所有人。

基础规则

• 直奔主题。从最重要的点开始。把关键词前置，方便快速浏览。清楚说明用户有哪些选项以及下一步该做什么。

• 像说话一样写作。我们的用户是真实的人。要像与他们交谈一样去写。

• 保持简洁。提供足够的信息，让用户能够解决问题或做出选择。

• 标题中不要用句号。删除标题、标题层级、小标题、UI 标题，以及不超过三个词的列表项末尾的标点。段落和正文中使用句号。

  • 示例：Press the Send button->Press the Send button

• 拿不准时，避免大写。只对专有名词或名称（如 Zcash）以及标题或短语的第一个词使用大写。

  • 示例：How to Send ZEC with Unified Address. → How to send ZEC with unified address

• 改写薄弱表达。大多数时候，每句话都应以动词开头。像 You can 和 there were 这样的表达应当改写。

  • 示例：You can send and receive ZEC from your mobile phone->Send and receive ZEC with your phone

• 不要乱加空格。句号和冒号后只保留一个空格。

• 避免使用非英语词语，例如 de facto 或 ad hoc。避免使用常见英文短语的拉丁语缩写。

  使用这个	不要使用这个
  例如	e.g.
  也就是说	i.e.

推文

本通用风格指南适用于为 ZecHub 撰写文章或用户指南。它也适用于推文和其他简短陈述：保持简洁，先说重点，短句末尾不加标点。

---

ZecHub 风格指南改编自 Microsoft Writing Style Guide，并做了修改。在有需要时，请参考 Microsoft 指南。