ZecHub
Внести вклад
Пишите · Переводите · Проектируйте · Разрабатывайте
ZecHub
Внести вклад
Пишите · Переводите · Проектируйте · Разрабатывайте
Стиль ZecHub — простой и понятный. Мы рады всем и сосредоточены на сообществе Zcash.
Готовы помочь - Показывайте пользователям Zcash, что мы на их стороне.
Кратко и по существу: Передавайте сообщение как можно проще. Начинайте с самого важного.
Ориентированность на пользователя: Мы пишем в первую очередь для пользователей, во вторую — для разработчиков, и в третью — для всех остальных.
Переходите сразу к сути. Начинайте с самого важного. Выносите ключевые слова в начало, чтобы текст было легче просматривать. Чётко показывайте варианты действий пользователя и следующие шаги.
Пишите так, как говорите. Наши пользователи — реальные люди. Общайтесь с ними в письменной форме так же, как в разговоре.
Пишите кратко. Давайте пользователям достаточно информации, чтобы они могли решить проблему или сделать выбор.
Не ставьте точки в заголовках. Убирайте конечный знак препинания в заголовках, подзаголовках, названиях в интерфейсе и пунктах списка из трёх слов или меньше. Точки используются в абзацах и основном тексте.
Если сомневаетесь, избегайте заглавных букв. Пишите с заглавной буквы только имена собственные или названия, такие как Zcash, а также первое слово заголовка или фразы.
Переписывайте слабые формулировки. В большинстве случаев начинайте каждое утверждение с глагола. Конструкции вроде You can и there were следует перерабатывать.
Не ставьте лишние пробелы. Используйте только один пробел после точек и двоеточий.
Избегайте неанглийских слов, таких как de facto или ad hoc. Избегайте латинских сокращений для распространённых английских выражений.
| Используйте это | Вместо этого |
|---|---|
| for example | e.g. |
| that is | i.e. |
Это общее руководство по стилю предназначено для написания статей или руководств для пользователей ZecHub. Оно также применяется к твитам и другим коротким высказываниям: излагайте их кратко, выносите главное в начало и не ставьте знаки препинания в конце коротких строк.
Руководство по стилю ZecHub адаптировано из Руководства Microsoft по стилю письма с изменениями. При необходимости обращайтесь к руководству Microsoft.
