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 Writing Style Guide зі змінами. За потреби звертайтеся до посібника Microsoft.
