Определите проблему
Добавляйте правило, когда авторы регулярно сталкиваются с одним решением и несогласованность действительно мешает. Style guide начинают использовать, когда он быстро разрешает повторяющиеся редакционные решения, а не хранит каждое предпочтение редактора за всю историю команды.
Выберите рабочую модель
Сначала показывайте предпочтительную форму, затем короткое объяснение и пример. Начните с правил, предотвращающих терминологические расхождения, опасные инструкции и дорогие споры на ревью; добавляйте новое только после появления реального повторяемого случая.
Встройте в процесс
Правило должно легко сканироваться, а rationale и исключения можно разместить после него. Формулируйте правило как решение с примерами и исключениями, чтобы автор мог применить его без отдельной интерпретации редактора.
Проверьте результат
Автоматизируйте однозначные правила, а контекстные решения оставляйте человеку. Автоматизируйте только то, что инструмент способен оценить надёжно; субъективное руководство должно оставаться в ревью, где есть контекст.
Сохраните сопровождаемость
Удаляйте устаревшее, чтобы гайд оставался действующим стандартом, а не архивом противоречий. Удаляйте устаревшие правила и отмечайте существенные изменения, чтобы руководство оставалось живым договором, а не историческим архивом.
Практический разбор
Примените «Редакционный гайд, которым люди действительно пользуются» к одной реальной странице, а не обсуждайте правило в вакууме. Лучше выбрать материал, где есть заголовки, таблица, примечание, пример, повторяющийся термин и хотя бы одно действие пользователя. Просмотрите страницу сначала как автор, а затем как читатель, который не знает внутреннюю лексику продукта.
Фиксируйте дефекты наблюдаемыми формулировками:
- какая структура передаёт смысл, которого нет в обычном тексте;
- какой термин меняет написание или значение;
- какая инструкция зависит от неописанного контекста;
- какое правило трудно одинаково проверять на ревью.
Стандарт полезен, когда два редактора приходят примерно к одному решению на одном материале. Если правило звучит правильно, но его нельзя показать на типичной странице, уточните формулировку, добавьте пример или сузьте область действия.
Короткий редакционный чек-лист
- Определите проблему. Добавляйте правило, когда авторы регулярно сталкиваются с одним решением и несогласованность действительно мешает.
- Выберите рабочую модель. Сначала показывайте предпочтительную форму, затем короткое объяснение и пример.
- Встройте в процесс. Правило должно легко сканироваться, а rationale и исключения можно разместить после него.
- Проверьте результат. Автоматизируйте однозначные правила, а контекстные решения оставляйте человеку.
