Редакционный стайлгайд проекта

Редакционный стайлгайд проекта

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

Плохой стайлгайд — это сто страниц правил, которые никто не читал. Хороший — десять страниц с примерами, к которым обращаются каждый день.

Зачем нужен стайлгайд

Без договорённостей каждый автор пишет по своим привычкам: один ставит «ё», другой нет, третий использует разные термины для одного понятия. Читатель видит небрежность раньше, чем содержание.

Стайлгайд сокращает число правок и споров, особенно если тексты пишут несколько человек и подрядчиков.

Что включать

Обязательный минимум: терминология со ссылкой на глоссарий, обращение к читателю, оформление заголовков, списков и ссылок, правила для чисел и дат, типичные ошибки.

Каждый пункт сопровождается примером «так» и «не так». Без примера правило понимают по-разному.

Чего избегать

Не переносите в стайлгайд внешние справочники целиком: достаточно сослаться на них. Не описывайте случаи, которые не встречаются в вашей практике.

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

Терминология

Раздел о терминах — самый важный. В нём фиксируют основной вариант, допустимые синонимы и запрещённые формы с причиной запрета.

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

Обращение к читателю

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

Определите, допустимы ли повелительные конструкции в инструкциях и как обращаться к читателю в разных продуктах.

Заголовки

Правила касаются длины, регистра, наличия точки и стиля. Заголовок должен быть информативным, а не просто обозначать раздел.

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

Списки и таблицы

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

Для таблиц укажите, как оформляются заголовки, единицы измерения и пропуски в данных.

Числа и единицы

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

Единицы измерения записываются единообразно, с указанием системы там, где возможна путаница.

Ссылки и цитаты

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

Если проект использует определённый стиль цитирования, сошлитесь на него, а не переписывайте правила.

Иллюстрации

Подписи к рисункам, скриншоты и схемы подчиняются общим правилам: краткость, пояснение, единообразие оформления. Подпись должна работать без чтения основного текста.

Отметьте, допустимы ли скриншоты с иностранным интерфейсом и как их обрабатывать.

Тон

Тон зависит от аудитории: инструкция требует нейтральности, маркетинговый текст — большей свободы. Но и там нужны границы: что можно обещать, а что нет.

Запрет на преувеличения формулируется прямо, с примерами допустимых и недопустимых фраз.

Размер и структура

Документ должен быть коротким настолько, чтобы его прочитали. Разделы — по темам, а не по типам правил, если так удобнее искать.

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

Как вводить

Новый стайлгайд не стоит публиковать сразу целиком: команда не успеет привыкнуть. Начните с десяти самых важных правил и добавьте остальные через месяц.

Проверьте правила на трёх реальных текстах: если они противоречат практике, значит, сформулированы неверно.

Проверка соблюдения

Правила без проверки не работают. Включите ключевые пункты в редакторский чек-лист и в автоматические проверки, где это возможно.

Не превращайте соблюдение в самоцель: если правило мешает тексту, его стоит пересмотреть.

Обновление

Стайлгайд меняется вместе с продуктом и языком. Раз в полгода просматривайте разделы и удаляйте устаревшее.

Изменения фиксируются с датой и причиной, чтобы команда понимала, почему правило появилось.

Типичные ошибки

Первая — написать документ и не использовать его. Вторая — включить противоречивые правила. Третья — не дать примеров.

Четвёртая — сделать стайлгайд настолько строгим, что авторы тратят больше времени на формальности, чем на содержание.

Пример

Правило: «В интерфейсе используем „учётная запись“, в маркетинговых текстах допустимо „аккаунт“». Пример показывает, где граница, и снимает половину вопросов.

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

Как хранить и распространять

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

Если проект ведётся в репозитории, стайлгайд хранится рядом с материалами и меняется через те же правки, что и тексты. Тогда история изменений и обсуждения доступны команде.

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

Пример из практики

Команда перешла на новую терминологию, но стайлгайд не обновили. Через месяц в текстах появились оба варианта, и редактор тратил время на споры вместо работы.

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

Итог

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

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

Чек-лист

• Документ короткий.
• Есть примеры «так» и «не так».
• Термины связаны с глоссарием.
• Правила проверяемы.
• Противоречий нет.
• Владелец назначен.
• Дата пересмотра указана.

Частые вопросы

Кто пишет стайлгайд?

Редактор вместе с авторами.

Нужен ли он небольшой команде?

Да, если текстов больше одного.

Можно ли менять правила?

Да, с фиксацией причины.