2learn

Голос, правила и поддержка

Что это такое

После аудита появляется короткий документ, который останавливает ветшание: голос, которым пишет продукт, и правила именования его понятий. В нём же назван человек, который отвечает за то, чтобы и то и другое оставалось верным. Документ должен целиком умещаться на одной странице, иначе его никто не прочитает.

Почему это важно

Согласованность — то, что заставляет доверять контенту, однако без правил она не выживает, если авторов несколько. Альтернатива — руководство по стилю, которое никто не открывает, или узкое место ревью, где один человек утверждает каждую строку. Голос и правила именования на одной странице с названным владельцем стоят между этими крайностями: авторы пользуются правилами сами, а владелец решает действительно новые случаи.

Ключевые идеи

Голос — это три прилагательных и их границы

Выберите три и скажите, что каждое из них исключает. «Понятно» не значит ничего, пока не исключает «в сообщении об ошибке мы говорим „аутентификация“».

Понятно        — говорите «войти», никогда «аутентифицироваться»
Прямо          — одна мысль на предложение; никаких «обратите внимание, что»
По-человечески — признайте проблему; никогда не вините человека
Границы: без шуток в ошибках, без восклицательных знаков в подтверждениях

Одно слово на понятие, записанное

Таблица именования связывает каждое понятие с одним термином для пользователя, одним внутренним термином и запрещёнными словами. Это самый выгодный артефакт документа.

Понятие        Термин для пользователя   Запрещено
подписка       тариф                     пакет, уровень, членство
счёт-фактура   счёт                      выписка, квитанция
удалить        удалить                   убрать, архивировать, корзина

Правила для повторяющихся трудных случаев

Даты, числа, валюта, регистр, кнопки и пустые состояния. Десять правил покрывают большую часть того, о чём спорят авторы, и короткого примера на каждое достаточно.

Назовите владельца и маршрут для вопросов

Один человек и определённый способ спросить его. Без владельца правила остаются пожеланием, с комитетом никто не успевает ответить вовремя.

Вшейте правила в инструменты

Сложите строки в один файл или одну библиотеку компонентов, чтобы значением по умолчанию были правильные слова. Правило, которое требует помнить, будет нарушено. Правило, зашитое в компонент, — нет.

Практика

Напишите одностраничный стандарт

Сделайте страницу с тремя прилагательными голоса и их границами, таблицей именования минимум на восемь понятий, пятью правилами форматирования и именем владельца.

Готово, когда: автор, который никогда не встречал команду, может следовать этому при написании нового экрана, не задав ни одного вопроса.

Примените стандарт к одному экрану целиком

Перепишите каждую строку на одном экране по стандарту. Отметьте каждое место, где стандарт молчал.

Готово, когда: экран использует только утверждённые термины, а найденное молчание вы добавили как правило.

Частые ошибки

  • Руководство по стилю, которое никто не читает — документ длинный, а продукт остаётся несогласованным; исправить: сократите его до одной страницы и сохраните таблицу именования.
  • Правила без владельца — у первого спора нет арбитра, и правила забрасывают; исправить: назовите одного владельца и способ спросить его.
  • Прилагательные голоса без границ — «дружелюбно» оправдывает что угодно; исправить: скажите, что каждое прилагательное исключает.
  • Несколько слов для одного понятия — пользователи не могут искать, переводить и доверять продукту; исправить: держите таблицу именования и удалите запрещённые синонимы из кода.
  • Правила, живущие вне инструментов — авторы не могут им следовать в срок; исправить: зашейте стандартные строки в библиотеку компонентов.

Что читать дальше

Разобранные примеры

Файлы cookie аналитики ставятся только с вашего согласия. До вашего выбора ничего не загружается и никуда не отправляется.