Глоссарий — система решений

Полезная терминологическая запись отвечает не только на вопрос «что означает слово?». Она хранит предпочтительный термин, определение, запрещённые и устаревшие варианты, контекст, грамматические особенности и владельца.

Начните с конфликтных понятий

Не пытайтесь переписать в глоссарий каждое существительное. Сначала возьмите термины, которые вызывают вопросы поддержки, расходятся в UI, плохо переводятся или постоянно спорят на ревью.

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

У одного понятия может быть несколько исторических имён. Опишите понятие один раз, выберите предпочтительный термин и сохраните aliases. Для локализации это особенно важно.

Встройте терминологию в процесс

Используйте один источник для редакционных правил, перевода и автоматического линтинга там, где это возможно. Глоссарий, который автор не видит во время работы, быстро превращается в архив.

Назначайте владельцев и пересмотр

Продукты меняются. У определения должен быть ответственный и повод пересмотреть запись при изменении поведения. Качественная терминология — постоянное обслуживание, а не разовая уборка.

Практический разбор

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

Фиксируйте дефекты наблюдаемыми формулировками:

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

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

Короткий редакционный чек-лист

  • Глоссарий — система решений. Полезная терминологическая запись отвечает не только на вопрос «что означает слово?».
  • Начните с конфликтных понятий. Не пытайтесь переписать в глоссарий каждое существительное.
  • Отделяйте понятие от названия. У одного понятия может быть несколько исторических имён.
  • Встройте терминологию в процесс. Используйте один источник для редакционных правил, перевода и автоматического линтинга там, где это возможно.

Связанные материалы