Техническая документация, инструменты и профессия — независимый журнал
TECHWRITERS.ORG

Редакционные правила

Статьи с меткой: Редакционные правила

Термины и определения
Стандарты

Термины и определения

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

Редакционная техническая иллюстрация к статье: Правила структурированного письма, которые работают при сотнях авторов.
Стандарты

Правила структурированного письма, которые работают при сотнях авторов

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

Редакционный гайд, которым люди действительно пользуются
Стандарты

Редакционный гайд, которым люди действительно пользуются

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

Редакционная техническая иллюстрация к статье: Vale как quality gate, а не полиция запятых.
Инструменты

Vale как quality gate, а не полиция запятых

Линтинг стиля полезен, когда ловит расползание терминологии, рискованные формулировки и повторяемые редакционные дефекты. Держите набор правил небольшим, объяснимым и достаточно тихим, чтобы авторы доверяли падению проверки. Линтер способен проверить тысячи предложений за секунды, поэтому хочется закодировать в нём каждое редакционное предпочтение.