Техническое руководство по стилю

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

Что такое стайлгайд?

Дословный перевод английского словосочетания Style guide — «руководство по стилю». Применительно к документации это набор правил и требований, включающий особенности стиля и тона изложения, оформления текста и структуры, использования терминологии и т.д.

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

В англоязычном сегменте интернета легко найти стайлгайды разных компаний: например, Google, Mailchimp, Veeam. Они буквально-таки всеобъемлющие. Но годятся только для английского языка. А как быть с русским?

Как таковых «стайлгайдов» для великого и могучего нет. Но есть ГОСТы, из которых можно почерпнуть информацию о структуре и содержании тех или иных технических документов; есть “Справочник издателя и автора”, который дает наиболее полную информацию о правилах оформления документов; наконец, есть справочник Д. Э. Розенталя с правилами правописания.

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

Стайлгайд: начало

Мы разделили стайлгайд на три основных части. Или на три документа:

• стайлгайд документации в вики-системе;
• стайлгайд составления схем;
• стайлгайд документации для клиентов.

Различия правил документации в вики-системе и документации, которая передаётся клиентам, обусловлены по большей части, используемым инструментарием. У нас вики-система Confluence, и у клиентов нет к ней доступа. Им мы передаем документацию в формате офисных документов или переносим в их базу знаний. По этой причине и существуют определенные различия в структуре и оформлении документов.

Вначале мы выделили основные вопросы, которые возникают у технического писателя при создании документации:
— Как мы пишем те или иные термины? Например, мы пишем «кубернетес» или «Kubernetes»? Или «k8s»?
Ответ на такой вопрос должен давать глоссарий. И значит он нам нужен.

— В каком порядке располагаем статьи и как заполняем шаблоны? Какой структуры придерживаемся?
Нужны правила структуры по пространствам, разделам, подразделам и статьям.

— Как мы пишем? Подробно или кратко? Какой стиль написания используем?
Нужно сформулировать хотя бы несколько основных правил.

— А каким языком? Например, насколько допустимо использование профессионализмов, сокращений, канцеляризмов и т.п?
Нужны конкретные правила их использования в документации. А также любые другие правила по написанию, которые помогут привести документацию к единому виду.

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

— Как привести схемы к единому виду? Какие есть общие правила при их составлении? Что нужно отобразить на схеме, какие отношения и связи? Какие типы схем мы составляем?
Нужно сделать унификацию элементов схемы, записать правила использования цветов, шрифтов и размеров, составить библиотеки используемых элементов и привести примеры правильных схем, в которых наиболее полно используются элементы и показаны связи между ними.

В глоссарий мы записали самые распространенные термины, с которыми возникала путаница, и оформили его в виде таблицы:

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

Основной стайлгайд включает в себя следующие разделы:

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

Целевая аудитория — это краткий портрет пользователей, для которых пишется документация. Он позволяет правильно сформулировать правила написания и язык статей.

Раздел с оформлением статей включает в себя такие правила, как:

• обязательное использование макроса оглавления;
• использование заголовков: определили, что для структуры наших статей будет достаточно заголовков 2-го и 3-го уровней — использование заголовков ниже третьего уровня будет только усложнять структуру;
• использование для кода и файлов конфигурации макроса — «блок кода»;
• использование макросов выделения. Например, в каких случаях использовать макрос «информация», а в каких «предупреждение»;
• использование макроса «раскрыть» для длинных списков. Особенность нашей документации в том, что там часто используются списки и они могут существенно удлинять статью. Поэтому если в списке более 10 пунктов, то такой список желательно сделать раскрывающимся;
• использование макроса drawio для схем. Так как схемы требуется постоянно обновлять, то удобнее, когда в документации они располагаются не в виде картинки, а внутри макроса. Это позволяет быстро и просто вносить в схему нужные изменения;
• использование дефисов и тире, жирного и курсива;
• подписи к картинкам и скриншотам — в каких случаях они нужны, а когда их можно опускать;
• использование маркированных и нумерованных списков — в чем разница, когда и какой нужно использовать. Также правила их оформления — пункты маркированных списков начинаются с маленькой буквы и заканчиваются точкой с запятой, пункты нумерованных списков начинаются с заглавной буквы и заканчиваются точкой;
• использование макросов для добавления ссылок и таблиц.

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

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

Например, мы определили четыре основных возможных варианта структуры клиентского проекта:

• простой;
• стандартный;
• расширенный 1;
• расширенный 2.

Для наглядного представления структуры была составлена майндмапа, в которой расписан каждый из 4-х вариантов структуры:

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

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

При этом правила тегов для пространства с документацией по клиентским проектам и остальными разделами несколько различаются. Эти различия также добавлены в стайлгайд.

В последнем разделе основного стайлгайда — язык статей. Мы указали все основные правила, которых нужно придерживаться при написании статей документации:

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

Правила оформления схем мы вынесли в отдельный стайлгайд:

Введение описывает, какие типы схем мы составляем и для чего применяется этот стайлгайд.

В общих правилах оформления мы указали:

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

В правилах оформления элементов облачных сервисов описано:

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

Также мы добавили примеры для схем облачных сервисов.

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

Правила оформления для документации, которая передается клиентам, мы также оформили в отдельный документ со следующим содержанием:

Разделы Введение и Язык написания полностью дублируют основной стайлгайд — здесь правила едины как для статей в вики-системе, так и для офисных документов. Эти разделы скопированы сюда только для удобства — чтобы все правила для определенных документов были в одном месте.

В одноименном разделе мы определили основные типы документов, которые мы передаем нашим клиентам на текущий момент:

• приёмо-сдаточная документация;
• отчет по нагрузочному тестированию;
• отчет по аудиту Kubernetes.

В разделе оформление документов мы подробно описали следующие правила:

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

На этом основной этап создания стайлгайда завершен. Главных доработок требует только стайлгайд для схем.

Какие проблемы решило наличие стайлгайда

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

1. Приведение документации к единому виду. Это помогает быстрее и проще ориентироваться по документации.
2. Сокращение времени на адаптацию нового сотрудника в отделе документирования. Теперь не нужно передавать знания из уст в уста, всё хранится в одном месте.
3. Сокращение времени на подготовку документов для клиентов. То есть ускорение оказания услуг нашим заказчикам.
4. Формализация знаний, которые ранее хранились в головах разных людей.

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

Какие вопросы остаются

Самый основной вопрос и сложность — как привести всю документацию в соответствие со стайлгайдом и как это соответствие поддерживать…

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

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

Пока самым логичным решением видится добавление обязательного этапа ревью. Он будет включать не проверку технических вопросов и смыслового содержания статей, а соответствие букве закона стайлгайдам. Ревью можно сделать перекрестным — это, во-первых, улучшит качество статей и повысит соответствие принятым правилам, а во-вторых, доведёт следование правилам до автоматизма на эти правила — все выучат их назубок и будут быстро находить и исправлять несоответствия.

Что дальше?

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

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

Гайдлайн (guideline) — это технический документ с подробным описанием и правилами использования элементов фирменного стиля компании. В нем рассказывают, как на практике применять визуальную атрибутику бренда: логотип, цвета, шрифты.

Брендбук, логобук и гайдлайн: в чем отличия

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

В брендбуке собрана вся фундаментальная информация о бренде: история компании, ее философия, миссия, цели, ценности, целевая аудитория, tone of voice, достоинства, корпоративная стилистика. 

Гайдлайн — это скорее инструкция. В нем делают упор на визуальную айдентику: вид и размер шрифтов, форму логотипа, сочетание цветов, оформление страниц на сайте и в соцсетях, размещение элементов на вещественных носителях (рекламе, сувенирах, канцелярии). Иногда раскрывают смысловые и идейные основы бренда. 

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

Ещё один документ, связанный с айдентикой бренда — логобук. В нем описывают логотип и правила его применения: форму, размер, пропорции, цвет, шрифт, размещение на носителях. Логобук входит в гайдлайн или является самостоятельным руководством.

Преимущества использования гайдлайна

Гайдлайн приносит бизнесу большую пользу. Его основные плюсы:

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

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

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

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

Кому и зачем нужен гайдлайн

Гайдлайн полезен любому бизнесу при решении следующих задач: 

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

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

Виды и форматы гайдлайна

В зависимости от содержания гайдлайны бывают двух видов:

Технические. В них есть только подробная инструкция по работе с элементами фирменного стиля. Этот вид гайдлайна встречается чаще всего.

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

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

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

PDF-файл. Это самый популярный формат. Электронный файл легко отправить получателю на почту или в мессенджер, а также разместить на сайте в открытом доступе. 

Важное преимущество PDF-гайдлайна — при его разработке компании не нужно тратиться на печать полиграфии.

Презентации. Это файлы PowerPoint, Keynote, Google Презентации. Презентация со слайдами легко отредактировать при необходимости. Такой формат востребован для офлайн-мероприятий.

Структура гайдлайна

У гайдлайна всегда есть четкая логическая структура. Сначала важно описать основной элемент — логотип, его концепцию, философию, строение. А далее переходить к другим элементам айдентики — шрифтам, цвету, применению.

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

Логотип. Здесь описывают элементы логотипа, его размеры, цветовую гамму, правила работы с охранным полем (свободным пространством вокруг лого), фон, ошибки использования знака. 

Цветовая палитра. Список цветов фирменного стиля, их названия, правила использования, возможные сочетания. VK предлагает парные комбинации:

Шрифты. Они бывают стандартными (бесплатными) и купленными по лицензии в коммерческих целях, уникальными. У «Большого театра» есть несколько фирменных шрифтов:

Дополнительные элементы. Корпоративные узоры (паттерны), фоны, линии и другие второстепенные детали общей визуальной айдентики. 

Брендирование. Примеры и рекомендации, как разместить элементы фирменного стиля на рекламных носителях, транспорте, униформе, аксессуарах, визитках, сувенирах, упаковке и другой вещественной продукции.

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

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

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

Интерьер и экстерьер. Внешний вид помещений компании (офисов, магазинов). К этому блоку относятся вывески, входные таблички, стены, двери и другие элементы.

Как создать гайдлайн

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

Выбрать исполнителя.  Можно обратиться к фрилансеру, брендинговому агентству или поставить задачу штатному сотруднику. Некоторые компании выбирают студию для разработки логотипа, а вот за документацией и гайдами идут к фрилансерам. Такое решение помогает сэкономить. 

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

Сделать макет и согласовать. Подрядчик или сотрудники готовят макет и согласовывают его с заказчиками и руководством. Чаще всего проект контролируют руководитель компании, маркетолог или бренд-менеджер.  Лучше согласовывать поэтапно, чтобы не пришлось переделывать весь документ полностью. 

Распространить. Наличие гайдлайн не гарантирует порядка в визуальной коммуникации. Маркетологи должны следить, чтобы вся команда соблюдала требования. Это касается дизайнеров, SMM-менеджеров, верстальщиков. 

Советы по созданию гайдлайна

Чтобы гайдлайн стал полноценной качественной инструкцией по работе с вашим фирменным стилем, придерживайтесь рекомендаций:

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

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

Предоставьте больше возможностей. Не устанавливайте слишком жесткие правила использования корпоративного стиля — оставьте специалистам право на творчество и фантазию.

Главные мысли

Список статей Викимедиа

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

Содержание

• 1 Международный
• 2 Австралия
• 3 Канада
  • 3.1 Газеты
• 4 Европейский Союз
• 5 Великобритания
  • 5.1 Общие положения
  • 5.2 Для юридических документов
  • 5.3 Для журналистики
  • 5.4 Для компьютерной индустрии (программное и аппаратное обеспечение)
• 6 США
  • 6.1 Для общего письма
  • 6.2 Для юридических документов
  • 6.3 Для научных статей
  • 6.4 Для журналистики
  • 6.5 Для электронных публикаций
  • 6.6 Для бизнеса
  • 6.7 Для компьютерной индустрии (программное и аппаратное обеспечение)
  • 6.8 Руководства по редакционному стилю подготовки рукописи к публикации
• 7 Академический
• 8 Сообщества
• 9 Art
• 10 См. Также
• 11 Ссылки
• 12 Внешние ссылки

International

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

Австралия

• Руководство по стилю : Для авторов, редакторов и типографий Snooks Co для Depar Управление финансов и администрирования. 6-е изд. ISBN 0-7016-3648-3 .

Канада

• Канадский стиль: руководство по написанию и редактированию: издано Dundurn Press в сотрудничестве с Общественными работами и Государственной службой Канады Бюро переводов. ISBN 1-55002-276-8 .

Газеты

• CP Stylebook: Руководство по газетному стилю в Канаде, поддерживаемое Canadian Press. ISBN 0-920009-38-7 .
• Книга стилей Globe and Mail: изначально создавалась, чтобы помочь писателям и редакторам Globe and Mail представлять ясные, точные и сжатые истории. ISBN 0-7710-5685-0

Европейский Союз

• Межведомственное руководство по стилю.
• Руководство по стилю английского («Руководство для авторов и переводчиков в Европейская Комиссия «- исполнительная власть Европейского Союза.)

Соединенное Королевство

Общее

• Редактирование копий: Кембриджское руководство для редакторов, авторов и издателей Джудит Бутчер 3-е изд. 1992 г. Кембридж: Cambridge University Press ISBN 0-521-40074-0
• Современное английское использование Фаулера. Ред. RW Burchfield. Rev. 3-е изд.. Лондон: Clarendon Press, 2004. ISBN 0-19-861021-1 (твердый переплет). Основано на современном английском языке, автор Генри Ватсон Фаулер.
• The King’s English, Генри Ватсон Фаулер и Фрэнсис Джордж Фаулер.
• Руководство по стилю Oxford (изд. 2003 г.). Объединяет Oxford Guide to Style и Оксфордский словарь для писателей и редакторов, в котором основное внимание уделяется общим проблемам.
• The Complete Plain Words, сэр Эрн St Gowers.
• Использование и злоупотребление, Эрик Партридж.

Для юридических документов

• Оксфордский стандарт цитирования юридических органов (OSCOLA), Факультет Оксфордского университета закона

Для журналистики

• Руководство по стилю новостей BBC: от Британской радиовещательной корпорации.
• Руководство по стилю Economist: от The Economist.
• Руководство по стилю новостей The Fourth Estate: от Fourth Estate Public Benefit Corporation
• Руководство по стилю Guardian: от The Guardian
• Руководство по стилю и использованию The Times от The Times.

Для компьютерной индустрии (программное и аппаратное обеспечение)

• Руководство по стилю технических публикаций Acorn, автор: Acorn Computers. Содержит редакционные правила для текста в RISC OS учебных публикациях, технической документации и справочной информации.
• RISC OS Style Guide от RISC OS Open Limited. Содержит рекомендации по дизайну, справку и примеры формулировок диалоговых окон для пользовательского интерфейса программного обеспечения.

США

В США как корпоративные, так и журналистские формы массовой коммуникации полагаются на стили, указанные в Associated Нажмите Stylebook (AP). Классическое руководство по стилю грамматики, которое разработано как дополнение к книге стилей AP, — это Элементы стиля. Вместе эти две книги упоминаются чаще, чем любая другая книга общего стиля письма от третьего лица в США, используемая в большинстве профессий.

Для общего письма

• The Careful Writer, Теодор Бернштейн.
• Словарь сомнительных слов Брайсона: Руководство для писателей, как все исправить, от Билла Брайсона.
• Современное американское использование Гарнера от Брайана А. Гарнера.
• Классика стиля — представляет собой руководство по написанию от Уильям Странк младший, Эмерсон, Уитмен, По и другие писатели.
• Книга стилей Associated Press Основные книги ISBN 978-0-917360-63-3 .
• Элементы стиля. Авторы Уильям Странк-младший и Э. Б. Уайт. (Часто именуется «Странный и Белый».)

Для юридических документов

• The Bluebook: Единая система цитирования. Совместно, Harvard Law Review, Yale Law Journal, Columbia Law Review и Penn Law Review.
• ALWD Guide to Legal Citation, ранее ALWD Citation Manual, Association of Legal Writing Director
• : The Tanbook, by New York State Reporter

Для научных статей

• Чикагское руководство по стилю, Чикаго : Издательство Чикагского университета.
• Руководство для авторов исследовательских работ, тезисов и диссертаций, стиль Чикаго для студентов и исследователей, Кейт Л. Турабиан. Часто упоминается как «Turabian.»
• Справочник MLA для авторов исследовательских работ, автор Джозеф Гибальди. Часто упоминается как« MLA ».
• Руководство по публикациям Американского психолога Association, Американская психологическая ассоциация (APA).

Для журналистики

• The Associated Press Stylebook Basic Books ISBN 978-0-917360-63-3 .
• Руководство по стилю новостей Fourth Estate: Fourth Estate Public Benefit Corporation
• Руководство по стилю и использованию New York Times. Аллан М. Сигал и Уильям Дж. Коннолли.
• The Wall Street Journal Guide to Business Style and Usage, Рональд Дж. Олсоп и сотрудники Wall Street Journal.
• The BuzzFeed Style Guide: Эмми Фавилла и Меган Паолоне.

Для электронных публикаций

• Колумбийское руководство по онлайн-стилю, Дженис Уокер и Тодд Тейлор.
• Руководство по веб-стилю: основные принципы дизайна для создания веб-сайтов, Патрик Дж. Линч и Сара Хор ton.
• The Associated Press Stylebook, Associated Press, Basic Books ISBN 978-0-917360-63-3 .

Для бизнеса

• Справочник стилей Associated Press Базовые книги ISBN 978-0-917360-63-3 .
• Справочник по деловому стилю, Руководство от А до Я для эффективного письма на Работа, Хелен Каннингем и Бренда Грин.
• Справочное руководство Грегга, Уильям А. Сабин.

Для компьютерной индустрии (программное и аппаратное обеспечение)

• Руководство по стилю Apple, опубликованное в Интернете от Apple Inc. Содержит рекомендации по редактированию текста в учебных публикациях Apple, технической документации, справочной информации, обучающих программах и пользовательском интерфейсе программного обеспечения.. Более ранней версией было Руководство по стилю публикаций Apple.
• Руководство по стилю документации для разработчиков Google, опубликованное в Интернете компанией Google. Предоставляет набор редакционных рекомендаций для всех, кто пишет документацию для разработчиков по проектам, связанным с Google.
• The IBM Style Guide: Conventions for Writers and Editors, 2011, and Developing Quality Technical Information: A Handbook for Writers and Editors, 2014, из IBM Press.
• Microsoft Writing Style Guide, опубликованного в Интернете Microsoft Corporation. Предоставляет стандарт стиля для технической документации, включая использование терминологии, условных обозначений, процедур, методов проектирования, а также использования знаков препинания и грамматики. До 2018 года Microsoft издала книгу Руководство по стилю для технических публикаций Microsoft.
• Руководство по стилю написания Mozilla, опубликованную в Интернете на сайте Mozilla.
• Прочтите в первую очередь! Руководство по стилю для компьютерной индустрии, Sun Technical Publications, 3-е изд., 2010.
• Руководство по стилю Splunk, опубликовано в Интернете на Splunk. Предоставляет справочник по стилю письма для всех, кто пишет или редактирует техническую документацию.
• Yahoo! Style Guide, 2010.

Руководства по редакционному стилю подготовки рукописи к публикации

• The Associated Press Stylebook Basic Books ISBN 978-0-917360-63- 3 .
• Чикагское руководство по стилю, составленное сотрудниками University of Chicago Press.
• Words into Type, by Marjorie E. Skillin, Roberta

Academic

• Чикагское руководство стиля. Стандарт академической издательской индустрии, включая многие журнальные публикации.
• Руководство для авторов курсовых, тезисов и диссертаций (часто называемое «турабским стилем») — Издано Кейт Л. Турабиан, секретарь магистерской диссертации в Чикагском университете с 1930 по 1958 год. Школа требовала ее одобрения для каждой магистерской и докторской диссертации. Ее стилистические правила полностью соответствуют Чикагскому руководству по стилю, хотя есть некоторые отличия.
• Руководство по стилю ACS — для научных статей, опубликованных в журналах из Американского химического общества.
• Руководство по стилю Американской медицинской ассоциации — для медицинских статей, опубликованных в журналах Американской медицинской ассоциации.
• Руководство по стилю Американской психологической ассоциации — для поведенческих и социальных наук; опубликовано Американской психологической ассоциацией.
• Руководством по стилю Американской социологической ассоциации — для социальных наук; опубликовано Американской социологической ассоциацией.
• — для геологических отчетов в промышленности, академических кругах и других дисциплинах.
• Справочник по техническому письму Джеральда Дж. Алреда, Чарльза Т. Брусо и Уолтер Э. Олю — за общие технические работы.
• Стиль IEEE — используется во многих технических исследованиях, особенно в тех, которые касаются информатики.
• Леонарда Г. Госса и Кэролайн Стэнфорд. Госс — предоставляет явно религиозную экспертизу стиля и языка для писателей и редакторов в — ISBN 978-0-8054-2787-5 .
• Руководство по стилю MHRA — для искусства и гуманитарные науки ; опубликовано Ассоциацией современных гуманитарных исследований. Доступно для бесплатной загрузки (см. Статью).
• Руководство по стилю MLA и Руководство по MLA для авторов исследовательских работ — для предметов искусств и гуманитарные ; опубликовано Ассоциацией современного языка Америки (MLA).
• SBL Handbook of Style — Society of Biblical Literature style manual специально для области древнего Ближнего Востока, библейские и раннехристианские исследования. Руководство по стилю SBL включает рекомендуемый стандартный формат для сокращения основных источников в древневосточных, библейских и ранних христианских исследованиях.
• Научный стиль и формат: Руководство CSE для авторов, редакторов и издателей — для научные статьи, опубликованные Советом научных редакторов (CSE), группой, ранее известной как Совет редакторов биологии (CBE).
• Руководство по стилю для политологии — используется многими американские политологические журналы; опубликовано Американской ассоциацией политологии.

Сообщества

• GLAAD Справочное руководство по СМИ, 8-е изд., Справочное руководство по СМИ колледжа GLAAD, 1-е изд., Справочное руководство по китайским СМИ GLAAD, 1-е изд. — опубликовано GLAAD, чтобы побудить средства массовой информации использовать язык и практику с участием ЛГБТ. Доступна для свободного скачивания.

Art

• Ассоциация искусства Редакторы Стиль Руководство

Смотрите также

Ссылки

Внешние ссылки

Собственное руководство по стилю Википедии см. Википедия: Руководство по стилю.

Руководства по стилю

Руководство по стилю ACS Руководство по стилю AMA Книга стилей AP Стиль APA Руководство по стилю ASA Справочник делового стиля Кембриджское руководство по использованию английского языка Чикагское руководство стиля Ссылаясь на медицину Элементы стиля Элементы типографского стиля Современное английское использование Фаулера Современное английское использование Гарнера Стиль IEEE ISO 690 Руководство по стилю MHRA Руководство Microsoft по стилю Справочник ГНД Руководство New York Times Оксфордское руководство по стилю / Правила Нью-Харта Научный стиль и формат (стиль CSE) Турабян: Пособие для писателей Список сокращений в руководствах по стилю

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

Руководство по стилю устанавливает стандарт стиль требования к улучшению коммуникация путем обеспечения последовательность как в документе, так и в нескольких документах. Поскольку практики различаются, в руководстве по стилю могут быть установлены стандарты для использования в таких областях, как пунктуация, заглавные буквы, со ссылкой на источники, форматирование чисел и дат, внешний вид таблиц и другие области. Руководство по стилю может потребовать определенных лучшие практики в использование, языковая композиция, визуальная композиция, орфография и типография. За академический и технический документы, руководство может также применять передовой опыт в этика (Такие как авторство, этика исследования, и раскрытие ), педагогика (Такие как экспозиция и ясность), и соответствие (технический и регулирующий ).

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

Разновидности

Руководства по стилю сильно различаются по объему и размеру.

Размеры

Это разнообразие по объему и длине обеспечивается каскадированием одного стиля над другим, аналогично тому, как стили каскадируются. в веб-разработке и на рабочем столе каскадировать CSS стили.

Краткое руководство по стилю часто называют таблица стилей. Всеобъемлющее руководство обычно бывает длинным и часто называется руководство по стилю или же руководство по стилю (MOS или же MoS). Во многих случаях такой проект, как один книга, журнал, или же монография series обычно имеет короткую таблицу стилей, которая переходит в несколько более крупное руководство по стилю организации, например издательский компания, контент которой обычно называют домашний стиль. Большинство стилей дома, в свою очередь, перетекают отраслевое или профессиональное руководство по стилю это даже более комплексно. Вот некоторые примеры этих руководств по отраслевому стилю:

• AP стиль для журналистики и делового письма
• Чикагский стиль для делового письма и корпоративного общения, а также академического письма и публикации.
• USGPO стиль или же Стиль AGPS для государственных изданий
• Оксфордский стиль для научных публикаций и читателей
• Стиль APA и Стиль ASA для социальных наук
• CSE стиль для различных физических наук
• Стиль ACS по химии
• AMA стиль для медицины
• Синяя книга стиль для закона

Наконец, эти справочные работы проходят каскадом по орфографический нормы используемого языка (например, Английская орфография для англоязычных публикаций). Это, конечно, может зависеть от национального разнообразия, такого как различные варианты американского английского и британского английского.

Темы

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

Руководства по стилю, которые охватывают использование может предложить способы описания людей, которые избегают расизм, сексизм, и гомофобия. Руководства в конкретных научных и технических областях охватывают номенклатура, который определяет имена или классификационные метки, которые являются предпочтительными, поскольку они четкие, стандартизированные и онтологически звук (например, таксономия, химическая номенклатура, и номенклатура генов ).

Обновление

Большинство руководств по стилю время от времени пересматриваются с учетом изменений в соглашениях и правилах. использование. Частота обновления и контроль версий определяются тематикой. Для руководств по стилю в справочная работа формат, новый редакции обычно появляются каждые 1–20 лет. Например, Книга стилей AP ежегодно пересматривается, а руководства Chicago, APA и ASA находятся в 17-м, 6-м и 4-м изданиях соответственно. Многие стили домов и отдельные стили проектов меняются чаще, особенно для новых проектов.

Примеры

Международный

Несколько основных руководств по стилю для технических и научных коммуникаций были определены международными организации по стандартизации. Одним из примеров является ISO 215 Документация — Представление материалов для периодических и других периодических изданий..^[1]

Европа

В Евросоюз издает Межведомственное руководство по стилю — охватывающий 24 языка по всему Европейскому Союзу. Это руководство является «обязательным» для всех сотрудников учреждений ЕС, которые занимаются подготовкой документов и работ ЕС.^[2] В Главное управление переводов из Европейская комиссия издает собственный Руководство по английскому стилю, предназначенный в первую очередь для англоязычных авторов и переводчиков, но также нацеленный на обслуживание более широкой читательской аудитории.^[3]

Австралия

• Руководство по стилю: для авторов, редакторов и печатников от Snooks & Co для Департамент финансов и администрации. 6-е изд. ISBN  0-7016-3648-3.
• Австралийский справочник по юридическому цитированию
• Австралийское руководство научного стиля (AMOSS) — онлайн от Биотекста; иллюстрировано Биотекстом. 1-е изд. ISBN  978-0-9946369-0-4

Канада

Общий

• Книга стилей канадской прессы: руководство для писателей и редакторов, 14-е изд. Торонто: Канадская пресса, 2006. Путеводитель по газетному стилю в Канаде. ISBN  0-920009-38-7.
• Редактирование канадского английского, 2-е изд. Подготовлено для Ассоциации редакторов Канады / Канадской ассоциации ревизоров Кэтрин Крэгг, Барбара Чарнеки, Ирис Хоссе Филлипс, Кэтрин Вандерлинден и Шейла Протти. Торонто, Онтарио: Макфарлейн Уолтер и Росс, 2000.
• Руководство по стилю Комиссии по государственной службе. Оттава: Правительство Канады, 2011.
• Общественные работы и государственные услуги Канады, Бюро переводов. Канадский стиль: руководство по написанию и редактированию. Ред. Ред. Торонто: Dundurn Press, 1997. ISBN  1-55002-276-8.^[4]

Журналистика

• J.A. Макфарлейн и Уоррен Клементс. Книга стилей земного шара и почты: руководство по языку и использованию, изм. изд. Торонто: Макклелланд и Стюарт, 1998.

Закон

• Юридический журнал Макгилла. Canadian Guide to Uniform Legal Citation / Manuel canadien de la référence juridique. 8-е изд. Торонто: Карсвелл, 2014.^[5]

объединенное Королевство

Общий

• Стиль, к Ф. Л. Лукас, 1955; 3-е издание, Harriman House, 2012 г.
• Копировальное редактирование Мясника: Кембриджское руководство для редакторов, копировальных редакторов и корректоров, Джудит Бутчер, Кэролайн Дрейк, Морин Лич. 4-е изд. Кембридж, 2006: Издательство Кембриджского университета ISBN  978-0521847131
• Словарь современного английского языка Фаулера. Эд. Джереми Баттерфилд. 4-е изд. Oxford University Press, 2015.  ISBN  978-0-19-966135-0 (Твердая обложка). На основе Современное английское использование Фаулера, к Генри Ватсон Фаулер.
• Королевский английский, к Генри Ватсон Фаулер и Фрэнсис Джордж Фаулер.
• Правила Нового Харта 2005 г. (ранее переиздавалось как Оксфордское руководство по стилю, 2002).
• Полные простые слова, к Сэр Эрнест Гауэрс.
• Руководство по стилю MHRA: руководство для авторов, редакторов и авторов тезисов, 2-е изд. Лондон: Ассоциация современных гуманитарных исследований, 2008.
• Оксфордское руководство по стилю. Под редакцией Роберта Риттера. Oxford – New York: Oxford University Press, 2003 (переиздано как Новое руководство по стилю Оксфорд, 2012). Сочетает Правила Нового Харта (2002) и Оксфордский словарь для писателей и редакторов (2000).
• Использование и злоупотребление, к Эрик Партридж.

Журналистика

• Руководство по стилю BBC News: посредством Британская радиовещательная корпорация.^[6]
• Руководство по стилю Economist: к Экономист.^[7]
• Руководство по стилю Guardian: к Хранитель.^[8]
• Времена Руководство по стилю и использованию. Ред. Ред. Составлено Тимом Остином. Лондон: Times Books, 2003.^[9]

Соединенные Штаты

В Соединенных Штатах использование руководства по стилю зависит от отрасли и цели контента. Некоторые государственные корпорации следуют Книга стилей Associated Press для контента, связанного с журналистикой (например, пресс-релизов), но используйте Чикагское руководство стиля для печатных и цифровых документов, таких как отчеты или содержимое веб-сайтов. Многие корпорации создают свои собственные руководства по внутреннему стилю на основе нескольких руководств по стилю. Журналисты используют Книга стилей Associated Press. Книжные издатели и авторы журналов, требующих справочных разделов, обычно выбирают Чикагское руководство стиля, в то время как научные статьи часто следуют Руководство по стилю MLA и руководство по научным публикациям.^[10] Один из самых популярных грамматика руководства, используемые в письме от третьего лица, Элементы стиля.

Общий

• Осторожный писатель, к Теодор Бернштейн.
• Элементы стиля, к Уильям Странк мл. и Э. Б. Уайт. (Обычно называется «Странк и Белый»)
• Стиль: Уроки ясности и изящества, к Джозеф М. Уильямс
• Хорошо понятный тезаурус, к Том Хилер
• Чикагское руководство стиля, 17-е изд. Чикаго – Лондон: Издательство Чикагского университета, 2017.
• Руководство Мерриам-Вебстер для писателей и редакторов. Составлено редакцией Collegiate Dictionary Merriam-Webster. Спрингфилд, Массачусетс: Merriam-Webster, 1998. (ред. Стандартное руководство Вебстера по американскому стилю, 1985)
• Руководство по стилю и использованию Нью-Йоркской публичной библиотеки для писателей. Нью-Йорк: HarperCollins, 1994.
• Уильям А. Сабин. Справочное руководство Грегга: Руководство по стилю, грамматике, использованию и форматированию, 10-е изд. Бостон: Макгроу-Хилл, 2005.
• Слова в тип, 3-е изд. На основе исследований Марджори Э. Скиллин, Роберта М. Гей и других авторитетных источников. Энглвуд Клиффс, Нью-Джерси: Прентис-Холл, 1974.

Академические работы

• Справочник ГНД для авторов исследовательских работ, 8-е изд. Нью-Йорк: Американская ассоциация современного языка, 2016 г. (обычно называется «Стиль MLA «.)
• Руководство по стилю MLA и руководство в научных публикациях, 3-е изд. Нью-Йорк: Американская ассоциация современного языка, 2008 г. Прекращено с 2016 г.^[11]
• Уильям А. Сабин. Справочное руководство Грегга: Руководство по стилю, грамматике, использованию и форматированию. 10-е изд. Бостон: Макгроу-Хилл, 2005.
• Кейт Л. Турабян. Пособие для авторов научных статей, диссертаций и диссертаций: Чикагский стиль для студентов и исследователей, 7-е изд. Отредактировано Уэйном К. Бутом, Грегори Г. Коломбом, Джозефом М. Уильямсом и редакцией Чикагского университета. Чикаго: University of Chicago Press, 2007. (Обычно называется «Турабский стиль «.)
• Кейт Л. Турабян. Руководство для студентов по написанию статей для колледжа, 4-е изд. Отредактировано Грегори Г. Коломбом, Джозефом М. Уильямсом и редакцией Чикагского университета. Чикаго: Издательство Чикагского университета, 2010.

Бизнес

• Чикагское руководство стиля, 17-е изд. Чикаго – Лондон: Издательство Чикагского университета, 2017.^[12]
• Книга стилей Associated Press и Брифинг по Закону о СМИ, 44-е изд. Под редакцией Даррелла Кристиана, Салли Якобсен и Дэвида Минторна. Нью-Йорк: Ассошиэйтед Пресс, 2009.^[13]
• Справочник делового стиля, руководство от А до Я для эффективного письма на работе, Хелен Каннингем и Бренда Грин.^[14]
• Руководство Wall Street Journal по деловому стилю и использованию. Под редакцией Пола Р. Мартина. Лондон: Свободная пресса, 2002.

Правительство

• Полное руководство по цитированию государственных информационных ресурсов: руководство для писателей и библиотекарей. Ред. Ред. Под редакцией Дайан Л. Гарнер и Дайан Х. Смит. Бетесда, Мэриленд: Информационная служба Конгресса для круглого стола с правительственными документами, Американская библиотечная ассоциация, 1993.
• Министерство обороны, см. Военный стандарт США.
• Руководство по стилю правительственной типографии США, 31-е изд. Вашингтон, округ Колумбия: Государственная типография, 2016.^[15]
• Геологическая служба США. Предложения авторам отчетов Геологической службы США, 7-е изд. Отредактировано и отредактировано Уоллесом Р. Хансеном. Вашингтон, округ Колумбия: Правительственная типография, 1991.

Журналистика

• Сборник стилей и брифинг Associated Press по закону о СМИ, 44-е изд. Под редакцией Даррелла Кристиана, Салли Якобсен и Дэвида Минторна. Нью-Йорк: Ассошиэйтед Пресс, 2009.^[16]
• Руководство по стилю и использованию New York Times. Ред. Ред. Отредактированный Алланом М. Сигалом и Уильямом Г. Коннолли. Нью-Йорк: Three Rivers Press, 1999.

Закон

• Руководство по цитированию ALWD: профессиональная система цитирования, 3-е изд. Под редакцией Ассоциации директоров юридических писателей и Дарби Дикерсон. Нью-Йорк: Аспен, 2006.
• Синяя книга: единая система цитирования, составленный Гарвардский юридический обзор Ассоциация Columbia Law Review, то Обзор права Пенсильванского университета, а Йельский юридический журнал. Юристы в большинстве юридических школ США обучаются этому.
• Брайан А. Гарнер. Элементы юридического стиля, 2-е изд. Нью-Йорк: Издательство Оксфордского университета, 2002.
• Руководство по правовому цитированию Чикагского университета, 2-е изд. Под редакцией Юридического обзора Чикагского университета. 2000 г.

Несмотря на почти единообразное использование Bluebook, почти в каждом штате есть правила апелляционного суда, которые определяют методы цитирования и стили письма, характерные для этого штата, и Верховный суд Соединенных Штатов имеет свой собственный метод цитирования. Однако в большинстве случаев они взяты из Bluebook.

Есть также несколько других руководств по цитированию, доступных для юридических писателей, широко используемых в Соединенных Штатах. Практически все крупные юридические фирмы имеют собственное руководство по цитированию и несколько крупных издателей юридических текстов (West, Lexis-Nexis, Hein, и другие.) поддерживают свои собственные системы.

Религия

• Католическая служба новостей. Книга стилей CNS по религии: справочное руководство и руководство по использованию, 3-е изд. Вашингтон, округ Колумбия: Служба католических новостей, 2006.
• Небольшой справочник по стилю великих христианских писателей и издателей, 13-е изд. Леонард Г. Госс и Кэролайн Стэнфорд Госс.
• Справочник стиля SBL для библейских исследований и связанных дисциплин, 2-е изд. Отредактированный Патриком Х. Александром. Атланта: SBL Press, 2014 (1-е изд .: Справочник стиля SBL: для изучения древнего Ближнего Востока, Библии и раннего христианства. Пибоди, Массачусетс: Хендриксон, 1999).
• Репортаж о религии 2: сборник стилей о лучших традициях религии. Под редакцией Дайан Коннолли и Дебра И. Мейсон. Вестервиль, Огайо: журналисты новостей религии, 2007.

Естественные науки

• Американское химическое общество (ACS). В основном используется для физические науки, Такие как физическая химия, физика, и смежных дисциплин. Обычно называется «Стиль ACS «.
  • Руководство по стилю ACS: эффективная передача научной информации, 3-е изд. Отредактированный Энн М. Когхилл и Лоррин Р. Гарсон. Вашингтон, округ Колумбия: Американское химическое общество, 2006; и
  • Руководство по стилю ACS: Руководство для авторов и редакторов (1997).
• Роберт Томас Бейер, Американский институт физики Руководство по стилю, Нью-Йорк. 1-е изд .: 1951. 1990: 4-е изд.
• Американское математическое общество. Руководство по стилю AMS, Под редакцией Мэри Летурно и Дженнифер Райт Шарп, Провиденс, Род-Айленд, 2017.
• Американская медицинская ассоциация. Руководство по стилю: Руководство для авторов и редакторов, 10-е изд. Под редакцией Шерил Айверсон. Oxford University Press, Нью-Йорк 2007. В основном используется в лекарство. (Обычно называется «стиль Ама».)
• Американское общество микробиологии. Руководство по стилю ASM для журналов и книг, Вашингтон, округ Колумбия, 1991.
• Научный стиль и формат: Руководство CSE для авторов, редакторов и издателей, 7-е изд. Составлено Комитетом по руководству по стилю Совет научных редакторов. Рестон, Вирджиния: Совет научных редакторов в сотрудничестве с Rockefeller University Press, 2006. Широко используется в естественных науках, особенно в науках о жизни. (Обычно называется «CSE стиль «.)

Социальные и когнитивные науки

• КАК. Гид по стилю. 5-е изд. Вашингтон, округ Колумбия: Американская социологическая ассоциация, 2014.
• Руководство по публикациям Американской психологической ассоциации, 6 изд. Вашингтон, округ Колумбия.: Американская психологическая ассоциация, 2009. В основном используется в социальные науки. (Обычно называется «Стиль APA «.)
• Руководство по стилю для политологии, изм. изд. Вашингтон, округ Колумбия: Комитет по публикациям Американской ассоциации политических наук, 2006.
• «Язык Таблица стилей «.^[17] Лингвистическое общество Америки. В первую очередь для журнала Язык, но также используется в других местах.
• «Единая таблица стилей для лингвистики».^[18] Лингвистическое общество Америки, 2007.

Веб-публикации

• Дженис Уокер и Тодд Тейлор. Колумбийский путеводитель по онлайн-стилю, 2-е изд. Нью-Йорк: издательство Колумбийского университета, 2006.
• Руководство Microsoft по стилю к Корпорация Майкрософт.
• Yahoo! Руководство по стилю: исчерпывающий справочник по написанию, редактированию и созданию контента для Интернета, Крис Барр и Yahoo! Сотрудники редакции.
• Википедия Руководство по стилю

Рекомендации по цитированию веб-контента также появляются в подробных руководствах по стилю, таких как Oxford / Hart, Chicago и MLA.

Смотрите также

Рекомендации

внешняя ссылка

• Но в книге стилей сказано … — Сообщение в блоге о злоупотреблении таблиц стилей, автор Билл Уолш из Вашингтон Пост
• Раздаточные материалы о написании руководств по стилю, с конференции Американское общество редакторов-копировщиков в 2007
  • Уильям Дж. Коннолли. «Как написать книгу стилей за 10 простых шагов» (PDF). Архивировано из оригинал (PDF) 21 августа 2010 г.
  • Дуг Кума. «Создание собственной книги стилей» (PDF). Мередит Special Interest Media. Архивировано из оригинал (PDF) 21 августа 2010 г.
• Журнал языков »Поиск в 43 книгах стилей

Обзор

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

Good technical documentation makes it easier for people to contribute to Wikimedia projects.
It is important to follow clear standards and style guidelines for writing and editing documentation, especially when the contributors and readers have varying levels of skills and experience.
Whether or not you consider yourself a writer, your contributions are needed and appreciated!

English Wikipedia Manual of Style

The English Wikipedia’s Manual of style covers general writing topics (like punctuation) in detail, and summarizes the key points of other style guides.
It can be a useful reference for anyone writing or editing technical documentation in English across Wikimedia projects, especially if the local wiki doesn’t have more specific guidelines.

This page provides basic guidelines and tips to help get you started with technical documentation. It includes some information specific to technical documentation that is not covered in the Wikipedia Manual of Style.

Writing for technical audiences

Before you begin writing, consider the audience for your work:

Кто будет читать эту техническую документацию?

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

Writing with a purpose

What purpose will your technical documentation serve? There are many reasons to write documentation.
It is helpful to know why you are writing and what your goal is before you begin.

Writing within a context

When deciding what to write and how to frame it for your reader, it can help to define a context or occasion for your writing.
Your communication takes place in the context of a bigger situation.
Контекст может быть ограничен эпохой, в которую вы пишете, типом доступных технологий, вашим географическим положением и культурой или текущей культурой и стилями общения ваших читателей.
The occasion may be personal and arise from the situation that motivated you to create or improve a piece of documentation.

Например, если вы пишете техническую документацию для проектов Викимедиа, учитывайте культуру созданную людьми, которые участвуют в этих проектах.
How could you best position your writing within the context of this community and its culture to create the most meaningful and useful technical documentation?

User testing and feedback

Create technical documentation to communicate ideas and concepts to a real audience of users.
Naturally, this audience should play a critical role in how the documentation is shaped and reshaped.
Think about ways you can gather information about your users’ experiences.
Take some time to answer the following questions:

• Can you use forums like Stack Overflow or mailing lists to check if your document answers the most common questions people have about your specific topic?

Clarity and consistency

Ясность и последовательность облегчает доступ, чтение и создание технической документации в проектах MediaWiki / Wikimedia.
Technical documentation is written for a wide audience and edited by a variety of contributors.

Voice, tone, grammar usage, style, and format should be consistent across technical documentation and similar content collections.
This helps readers learn how to navigate information and makes it easier for contributors to understand how to edit and add new information.

Deciding on a document type

Identify your main audience, purpose, and context first to decide on the type of document you will create.

This section briefly mentions some topics worth exploring elsewhere in more detail.
Always check your words and expressions against these criteria on Wiktionary:
Wiktionary entries cover hundreds of languages, explicitly state the grammatical and lexical features of words and their declensions, provide detailed context labels (including about jargon, UK vs. USA English) and expose how translatable terms are in hundreds of other languages.

Plain English

Please remember: many visitors to these pages are not native English speakers.

For documentation written in English, Plain English (also called plain language) works best.
Clear writing is the most understandable by diverse audiences, and is also easiest to translate.
There are a number of good tools for checking your writing, at Tech News’ Writing Guidelines on Meta-Wiki.

Voice and tone

MediaWiki is a place where anyone can edit.
Thus, it can be difficult to maintain a consistent voice and tone in the documentation.

Consider using these elements in your writing:

This is not meant to be an exhaustive list or a strict set of rules.

Point of view

The following guidance overrides the general Wikipedia style guidelines for pronouns, but only for technical documentation.

• Use second person («You» or assumed «You») when addressing your audience.
• Avoid first person («I» or «we»), unless you are writing a FAQ with questions asked from the first person perspective.
• Use an imperative mood for most documentation focused on goals or process.

Dates

• Always use the full, four-digit year.
• Use absolute dates («in May 2037») instead of relative dates («next year in May»).
• Avoid adding dates that will require regular manual updates. Example: Write {{#time: Y }} instead of 2023 when referring to the current year, no matter what year it is currently.

Overview

All pages should include an overview section (also called the Lead section) that explains:

1. Purpose of the page
2. Audience of the page
3. Prerequisites the reader will need to know before proceeding (Ex. a working knowledge of Python)
4. Software or tools the reader will need to complete the processes or tasks outlined on the page (Ex. Java installed)
5. Use case, case study, a practical understanding of the product, service or tool in action. (optional)

Table of contents

• Each page should include a table of contents, so information can be accessed easily.

Titles and headings

• Use sentence case for headings.
• Keep heading fonts consistent throughout documentation.
• Optional use of anchors to link sections or subsections in the same page.
• Add a blank line after section headings. This impacts how the content is packaged for translation.
• Do not put a heading before your overview or lead section.

Information flow

Technical documentation pages should follow a consistent pattern across content collections.

An ideal pattern for each page might be:

• Page title
• Introduction/Overview
• Heading
  • Content
    • Subheading if needed
      • Content

Основная страница: Help:Formatting

Formatting code examples and other technical elements

Formatting distinguishes code and other technical elements from regular text.

<syntaxhighlight lang="css">
.citation {
    margin: 0;
}
</syntaxhighlight>

.citation {
    margin: 0;
}

preformatted text
      with indent

''italics''

'''bold'''

Links

Основная страница: Help:Links

Templates

Templates are often used on MediaWiki.org pages.
Templates can help to maintain consistency and can make it easier to translate information.

Below are some common templates.

Templates for page formatting

• {{caution}}, {{fixtext}}, {{note}}, {{tip}}, {{todo}}, {{warning}} — for styles of inline highlight boxes
• {{fixme}}, {{historical}}, {{notice}}, {{outdated}}, {{update}} — for page/section message boxes
• {{main}}, {{see also}} — for page/section hatnotes (a short note placed at the top of an article)

Templates for MediaWiki core and Git source

• {{class doclink}}, {{file doclink}}, {{js doclink}} — to link to MediaWiki core’s generated documentation
• {{MW file}} — for a box with info and links for a file in MediaWiki core
• {{git file}} — to link to source code

Templates for Phabricator

• {{ptag}} — for the top-right-of-page Phabricator project tag
• {{tracked}} — for the related Phabricator task

Other useful templates

• {{irc|wikimedia-tech}} — for IRC link
• {{Key press}} — for, e.g. Ctrl+⇧ Shift+I, and {{button}} for, e.g. Предварительный просмотр
• {{ApiEx}} — for api.php request URLs
• {{Api help}} — to transclude generated API documentation
• {{wg}} — for global variables
• {{tag}} — for a quick way to mention an XML-style tag in a preformatted way

All pages on mediawiki.org are candidates for translation into multiple languages.
MediaWiki.org is a multilingual wiki, it uses the Translate extension to present alternative translations and manage the translation of pages.

См. также

• Some other technical documentation style guides:
  • Google Developer Documentation Style Guide
  • MDN Web Docs Writing Style Guide
• Wikiversity:Technical writing
• Other language related resources:
  • Inclusive language
  • word-list
  • Naming things

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

Международный

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

Австралия

Общий

• Руководство по стилю правительства Австралии от Агентства цифровой трансформации . 7-е изд.
• Руководство по стилю: для авторов, редакторов и печатников от Snooks & Co для Департамента финансов и администрации . 6-е изд.
  ISBN  0-7016-3648-3 .
• Австралийский справочник для писателей и редакторов Маргарет Маккензи. 4-е изд. ISBN  9781921606496 .
• Кембриджское руководство по использованию австралийского английского языка Пэм Питерс из Университета Маккуори . 2-е изд. ISBN  9780521702423 .
• Полное руководство по использованию английского языка для австралийских студентов Маргарет Рамзи. 6-е изд. ISBN  9780521702423 .

Закон

• Австралийское руководство по юридическому цитированию, опубликованное юридической школой Мельбурнского университета. 4-е изд. ISBN  9780521702423 .

Наука

• Австралийское руководство научного стиля (AMOSS) от Biotext; проиллюстрировано Биотекстом. 1-е изд. ISBN  978-0-9946369-0-4

Канада

• Канадский стиль: руководство по написанию и редактированию : издано Dundurn Press в сотрудничестве с Public Works и Бюро переводов государственных служб Канады. ISBN  1-55002-276-8 .

Газеты

• CP Stylebook : Руководство по газетному стилю в Канаде, поддерживаемое Canadian Press . ISBN  0-920009-38-7 .
• Книга стилей Globe and Mail : изначально создавалась, чтобы помочь писателям и редакторам Globe and Mail представлять ясные, точные и сжатые истории. ISBN  0-7710-5685-0

Европейский Союз

• Руководство по межведомственному стилю .
• English Style Guide («Справочник для авторов и переводчиков Европейской Комиссии » — исполнительная власть Европейского Союза .)

Великобритания

Общий

• Копирование-редактирование: Кембриджский справочник для редакторов, авторов и издателей Джудит Бутчер. 3-е изд. 1992 Кембридж: Издательство Кембриджского университета ISBN  0-521-40074-0
• Современное английское использование Фаулера . Эд. Р. У. Берчфилд. Ред. 3-е изд. Лондон: Clarendon Press , 2004. ISBN  0-19-861021-1 (твердый переплет). Основано на современном английском языке Генри Ватсона Фаулера .
• «Королевский английский » Генри Ватсона Фаулера и Фрэнсиса Джорджа Фаулера .
• Руководство по оксфордскому стилю (издание 2003 г.). Объединяет Оксфордское руководство по стилю и Оксфордский словарь для писателей и редакторов , в котором основное внимание уделяется общим проблемам.
• Полное членораздельно , по сэр Эрнест Гауэрс .
• Использование и злоупотребление , Эрик Партридж .

Для юридических документов

• Оксфордский стандарт цитирования юридических властей ( OSCOLA ),Юридический факультет Оксфордского университета

Для журналистики

• Руководство по стилю BBC News : Британской радиовещательной корпорацией .
• Руководство по стилю Economist : The Economist .
• Руководство по стилю новостей The Fourth Estate : от компании Fourth Estate Public Benefit Corporation
• Руководство по стилю Guardian : от The Guardian
• Руководство по стилю и использованию Times от The Times .

Для компьютерной индустрии (программное и аппаратное обеспечение)

• Руководство по стилю технических публикаций Acorn , Acorn Computers . Содержит редакционные рекомендации для текста в учебных публикациях, технической документации и справочной информации по ОС RISC .
• Руководство по стилю ОС RISC от RISC OS Open Limited . Предоставляет рекомендации по дизайну, справку и примеры формулировок диалоговых окон для пользовательского интерфейса программного обеспечения.

Соединенные Штаты

В Соединенных Штатах как корпоративные, так и журналистские формы массовой коммуникации опираются на стили, представленные в сборнике стилей Associated Press (AP). Классическое руководство по стилю грамматики, разработанное как дополнение к книге стилей AP, — это Элементы стиля . Вместе на эти две книги ссылаются больше, чем на любую другую книгу по общему стилю письма от третьего лица в США, используемую в большинстве профессий.

Для общего письма

• «Осторожный писатель » Теодора Бернштейна .
• Брайсон Словарь по хлопотно слов: Руководство Автора к Getting It Right , по Билл Брайсон .
• Современный американский Использование Гарнера по Bryan A. Garner .
• Классика стиля — представляет собой письменное руководство Уильяма Странка-младшего , Эмерсона , Уитмена , По и других писателей.
• ISBN 978-0-917360-63-3 книги стилей Associated Press . 
• Элементы стиля . По Уильям Strunk, младший и EB White . (Часто упоминается как «Странк и Белый».)

Для юридических документов

• Синяя книга: единая система цитирования . Совместно издано Harvard Law Review , Yale Law Journal , Columbia Law Review и Penn Law Review .
• ALWD Руководство по правовым Citation , ранее ALWD Цитирование Руководство, по ассоциации юридических документов директоров
• Руководство по стилю Нью-Йорка : The Tanbook, газета New York State Reporter

Для научных работ

• Чикагское руководство стиля , Чикаго: University of Chicago Press.
• Пособие для авторов исследовательских работ, тезисов и диссертаций в чикагском стиле для студентов и исследователей , написанное Кейт Л. Турабиан . Часто упоминается как « Турабский ».
• Справочник MLA для авторов исследовательских работ , Джозеф Гибальди . Часто упоминается как «MLA».
• Публикация Руководство Американской психологической ассоциации , по Американской психологической ассоциации (APA).

Для журналистики

• ISBN 978-0-917360-63-3 книги стилей Associated Press . 
• Руководство по стилю новостей The Fourth Estate : от компании Fourth Estate Public Benefit Corporation
• Руководство по стилю и использованию New York Times . Аллан М. Сигал и Уильям Г. Коннолли.
• Руководство Wall Street Journal по деловому стилю и использованию , Рональд Дж. Олсоп и сотрудники Wall Street Journal .
• Руководство по стилю BuzzFeed : Эмми Фавилла и Меган Паолоне.

Для электронных публикаций

• Колумбийский путеводитель по онлайн-стилю , Дженис Уокер и Тодд Тейлор.
• Руководство по веб-стилю: основные принципы дизайна для создания веб-сайтов , Патрик Дж. Линч и Сара Хортон .
• Книга стилей Ассошиэйтед Пресс , Ассошиэйтед Пресс, ISBN основных книг 978-0-917360-63-3 . 

Для бизнеса

• ISBN 978-0-917360-63-3 книги стилей Associated Press . 
• Руководство по деловому стилю, Руководство от А до Я по эффективному письму на работе , Хелен Каннингем и Бренда Грин.
• Справочное руководство Грегга , Уильям А. Сабин.

Для компьютерной индустрии (программное и аппаратное обеспечение)

• Руководство по стилю Apple , опубликованное в Интернете компанией Apple Inc. Содержит редакционные правила для текста в учебных публикациях Apple, технической документации, справочной информации, обучающих программ и пользовательского интерфейса программного обеспечения.
  Более ранней версией было Руководство по стилю публикаций Apple.
• Руководство по стилю документации DigitalOcean, опубликованное в Интернете компанией DigitalOcean .
• Руководство по стилю документации GNOME, опубликованное в сети GNOME .
• Руководство по стилю документации для разработчиков Google, опубликованное в Интернете компанией Google . Предоставляет набор редакционных правил для всех, кто пишет документацию для разработчиков по проектам, связанным с Google.
• Руководство по стилю контента Mailchimp, опубликованное в сети Mailchimp .
• Руководство по стилю письма Microsoft , опубликованное в Интернете корпорацией Microsoft . Предоставляет стандарт стиля для технической документации, включая использование терминологии, условных обозначений, процедур, методов проектирования, а также использования знаков препинания и грамматики. До 2018 года Microsoft опубликовала книгу Microsoft Manual of Style for Technical Publications .
• Руководство по стилю документации MongoDB, опубликованное MongoDB .
• Руководство по стилю написания Mozilla, опубликованное в Интернете компанией Mozilla .
• Руководство по стилю Rackspace для технического контента, опубликованное в Интернете компанией Rackspace .
• Прочтите меня в первую очередь! Руководство по стилю для компьютерной индустрии , Sun Technical Publications, 3-е изд., 2010 г.
• Руководство по стилю Red Hat для технической документации, опубликованное в сети Red Hat .
• Руководство по стилю Salesforce для документации и текста пользовательского интерфейса, опубликованное в сети Salesforce .
• Руководство по стилю документации SUSE, опубликованное SUSE в Интернете .
• Руководство по стилю IBM: соглашения для писателей и редакторов , 2011 г., и « Разработка качественной технической информации: справочник для писателей и редакторов» , 2014 г., издано IBM Press .
• Руководство по стилю Splunk , опубликованное на сайте Splunk . Предоставляет справочник по стилю письма для всех, кто пишет или редактирует техническую документацию.
• Yahoo! Гид по стилю , 2010.

Руководства по редакционному стилю подготовки рукописи к публикации

• ISBN 978-0-917360-63-3 книги стилей Associated Press . 
• Чикагское руководство по стилю , составленное сотрудниками Чикагского университета .
• Слова в шрифт, Марджори Э. Скиллин, Роберта

Академический

• Чикагское руководство стиля . Стандарт академической издательской индустрии, включая многие журнальные публикации.
• Пособие для писателей курсовых , тезисов и диссертаций (часто называемое « турабским стилем») — опубликовано Кейт Л. Турабиан , секретарем диссертаций в аспирантуре Чикагского университета с 1930 по 1958 год. Школа требовала ее одобрения для каждого кандидатская и докторская диссертации. Ее стилистические правила полностью соответствуют Чикагскому руководству по стилю , хотя есть некоторые отличия.
• ACS Руководство по стилю -для научных статей , опубликованных в журналах о Американском химическом обществе .
• Руководство по стилю Американской медицинской ассоциации — для медицинских статей, опубликованных в журналах Американской медицинской ассоциации .
• Руководство по стилю Американской психологической ассоциации — для поведенческих и социальных наук; опубликовано Американской психологической ассоциацией .
• Руководство по стилю Американской социологической ассоциации — для социальных наук; опубликовано Американской социологической ассоциацией .
• Рекомендации по составлениюотчетов по геонаукам — для отчетов по геонаукам в промышленности, академических кругах и других дисциплинах.
• Справочник по техническому письму , составленный Джеральдом Дж. Алредом, Чарльзом Т. Брусо и Уолтером Э. Олиу — для общего технического письма.
• Стиль IEEE — используется во многих технических исследованиях, особенно в тех, которые касаются информатики .
• «Маленькое руководство по стилю » Леонарда Г. Госса и Кэролайн Стэнфорд Госс — содержит отчетливо религиозную экспертизу стиля и языка для писателей и редакторов религии, философии религии и теологии — ISBN  978-0-8054-2787-5 .
• Руководство по стилю MHRA — для искусства и гуманитарных наук ; опубликовано Ассоциацией современных гуманитарных исследований . Доступно для бесплатной загрузки (см. Статью).
• MLA стиль руководства , и ГНД Руководство для писателей научно — исследовательских работ -для субъектов в области искусства и гуманитарных наук ; опубликовано Американской ассоциацией современного языка (MLA).
• SBL Handbook of Style — Руководство по стилю Общества библейской литературы, специально предназначенное для изучения древнего Ближнего Востока, библейских и раннехристианских исследований. SBL Справочник стиля включаетсебя рекомендуемый стандартный формат для сокращения источников первичных в Древнем ближневосточных, библейском и ранних христианских исследованиях.
• Научный стиль и формат: Руководство CSE для авторов, редакторов и издателей — для научных статей, опубликованных Советом научных редакторов (CSE), группой, ранее известной как Совет редакторов биологии (CBE).
• Руководство по стилям для политологии — используется многими американскими журналами по политологии ; опубликовано Американской ассоциацией политологии .

Сообщества

• Справочное руководство по СМИ GLAAD , 8-е изд., Справочное руководство по СМИ колледжа GLAAD , 1-е изд., Справочное руководство по китайским СМИ GLAAD , 1-е изд. — опубликовано GLAAD, чтобы побудить средства массовой информации использовать язык и практику с участием ЛГБТ. Доступно для бесплатной загрузки.

Изобразительное искусство

• Руководство по стилю Ассоциации художественных редакторов

Смотрите также

Рекомендации

Внешние ссылки

Стайл гайд —

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

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

Что такое стайлгайд?

Дословный перевод английского словосочетания Style guide — «руководство по стилю». Применительно к документации это набор правил и требований, включающий особенности стиля и тона изложения, оформления текста и структуры, использования терминологии и т.д.

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

В англоязычном сегменте интернета легко найти стайлгайды разных компаний: например, Google, Mailchimp, Veeam. Они буквально-таки всеобъемлющие. Но годятся только для английского языка. А как быть с русским?

Как таковых «стайлгайдов» для великого и могучего нет. Но есть ГОСТы, из которых можно почерпнуть информацию о структуре и содержании тех или иных технических документов; есть “Справочник издателя и автора”, который дает наиболее полную информацию о правилах оформления документов; наконец, есть справочник Д. Э. Розенталя с правилами правописания.

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

Стайлгайд: начало

Мы разделили стайлгайд на три основных части. Или на три документа:

• стайлгайд документации в вики-системе;
• стайлгайд составления схем;
• стайлгайд документации для клиентов.

Различия правил документации в вики-системе и документации, которая передаётся клиентам, обусловлены по большей части, используемым инструментарием. У нас вики-система Confluence, и у клиентов нет к ней доступа. Им мы передаем документацию в формате офисных документов или переносим в их базу знаний. По этой причине и существуют определенные различия в структуре и оформлении документов.

Вначале мы выделили основные вопросы, которые возникают у технического писателя при создании документации:
— Как мы пишем те или иные термины? Например, мы пишем «кубернетес» или «Kubernetes»? Или «k8s»?
Ответ на такой вопрос должен давать глоссарий. И значит он нам нужен.

— В каком порядке располагаем статьи и как заполняем шаблоны? Какой структуры придерживаемся?
Нужны правила структуры по пространствам, разделам, подразделам и статьям.

— Как мы пишем? Подробно или кратко? Какой стиль написания используем?
Нужно сформулировать хотя бы несколько основных правил.

— А каким языком? Например, насколько допустимо использование профессионализмов, сокращений, канцеляризмов и т.п?
Нужны конкретные правила их использования в документации. А также любые другие правила по написанию, которые помогут привести документацию к единому виду.

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

— Как привести схемы к единому виду? Какие есть общие правила при их составлении? Что нужно отобразить на схеме, какие отношения и связи? Какие типы схем мы составляем?
Нужно сделать унификацию элементов схемы, записать правила использования цветов, шрифтов и размеров, составить библиотеки используемых элементов и привести примеры правильных схем, в которых наиболее полно используются элементы и показаны связи между ними.

В глоссарий мы записали самые распространенные термины, с которыми возникала путаница, и оформили его в виде таблицы:

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

Основной стайлгайд включает в себя следующие разделы:

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

Целевая аудитория — это краткий портрет пользователей, для которых пишется документация. Он позволяет правильно сформулировать правила написания и язык статей.

Раздел с оформлением статей включает в себя такие правила, как:

• обязательное использование макроса оглавления;
• использование заголовков: определили, что для структуры наших статей будет достаточно заголовков 2-го и 3-го уровней — использование заголовков ниже третьего уровня будет только усложнять структуру;
• использование для кода и файлов конфигурации макроса — «блок кода»;
• использование макросов выделения. Например, в каких случаях использовать макрос «информация», а в каких «предупреждение»;
• использование макроса «раскрыть» для длинных списков. Особенность нашей документации в том, что там часто используются списки и они могут существенно удлинять статью. Поэтому если в списке более 10 пунктов, то такой список желательно сделать раскрывающимся;
• использование макроса drawio для схем. Так как схемы требуется постоянно обновлять, то удобнее, когда в документации они располагаются не в виде картинки, а внутри макроса. Это позволяет быстро и просто вносить в схему нужные изменения;
• использование дефисов и тире, жирного и курсива;
• подписи к картинкам и скриншотам — в каких случаях они нужны, а когда их можно опускать;
• использование маркированных и нумерованных списков — в чем разница, когда и какой нужно использовать. Также правила их оформления — пункты маркированных списков начинаются с маленькой буквы и заканчиваются точкой с запятой, пункты нумерованных списков начинаются с заглавной буквы и заканчиваются точкой;
• использование макросов для добавления ссылок и таблиц.

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

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

Например, мы определили четыре основных возможных варианта структуры клиентского проекта:

• простой;
• стандартный;
• расширенный 1;
• расширенный 2.

Для наглядного представления структуры была составлена майндмапа, в которой расписан каждый из 4-х вариантов структуры:

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

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

При этом правила тегов для пространства с документацией по клиентским проектам и остальными разделами несколько различаются. Эти различия также добавлены в стайлгайд.

В последнем разделе основного стайлгайда — язык статей. Мы указали все основные правила, которых нужно придерживаться при написании статей документации:

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

Правила оформления схем мы вынесли в отдельный стайлгайд:

Введение описывает, какие типы схем мы составляем и для чего применяется этот стайлгайд.

В общих правилах оформления мы указали:

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

В правилах оформления элементов облачных сервисов описано:

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

Также мы добавили примеры для схем облачных сервисов.

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

Правила оформления для документации, которая передается клиентам, мы также оформили в отдельный документ со следующим содержанием:

Разделы Введение и Язык написания полностью дублируют основной стайлгайд — здесь правила едины как для статей в вики-системе, так и для офисных документов. Эти разделы скопированы сюда только для удобства — чтобы все правила для определенных документов были в одном месте.

В одноименном разделе мы определили основные типы документов, которые мы передаем нашим клиентам на текущий момент:

• приёмо-сдаточная документация;
• отчет по нагрузочному тестированию;
• отчет по аудиту Kubernetes.

В разделе оформление документов мы подробно описали следующие правила:

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

На этом основной этап создания стайлгайда завершен. Главных доработок требует только стайлгайд для схем.

Какие проблемы решило наличие стайлгайда

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

1. Приведение документации к единому виду. Это помогает быстрее и проще ориентироваться по документации.
2. Сокращение времени на адаптацию нового сотрудника в отделе документирования. Теперь не нужно передавать знания из уст в уста, всё хранится в одном месте.
3. Сокращение времени на подготовку документов для клиентов. То есть ускорение оказания услуг нашим заказчикам.
4. Формализация знаний, которые ранее хранились в головах разных людей.

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

Какие вопросы остаются

Самый основной вопрос и сложность — как привести всю документацию в соответствие со стайлгайдом и как это соответствие поддерживать…

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

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

Пока самым логичным решением видится добавление обязательного этапа ревью. Он будет включать не проверку технических вопросов и смыслового содержания статей, а соответствие букве закона стайлгайдам. Ревью можно сделать перекрестным — это, во-первых, улучшит качество статей и повысит соответствие принятым правилам, а во-вторых, доведёт следование правилам до автоматизма на эти правила — все выучат их назубок и будут быстро находить и исправлять несоответствия.

Что дальше?

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

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

Стайл гайд —

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

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

Международный

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

Австралия

Общий

• Руководство по стилю правительства Австралии от Агентства цифровой трансформации . 7-е изд.
• Руководство по стилю: для авторов, редакторов и печатников от Snooks & Co для Департамента финансов и администрации . 6-е изд.
  ISBN  0-7016-3648-3 .
• Австралийский справочник для писателей и редакторов Маргарет Маккензи. 4-е изд. ISBN  9781921606496 .
• Кембриджское руководство по использованию австралийского английского языка Пэм Питерс из Университета Маккуори . 2-е изд. ISBN  9780521702423 .
• Полное руководство по использованию английского языка для австралийских студентов Маргарет Рамзи. 6-е изд. ISBN  9780521702423 .

Закон

• Австралийское руководство по юридическому цитированию, опубликованное юридической школой Мельбурнского университета. 4-е изд. ISBN  9780521702423 .

Наука

• Австралийское руководство научного стиля (AMOSS) от Biotext; проиллюстрировано Биотекстом. 1-е изд. ISBN  978-0-9946369-0-4

Канада

• Канадский стиль: руководство по написанию и редактированию : издано Dundurn Press в сотрудничестве с Public Works и Бюро переводов государственных служб Канады. ISBN  1-55002-276-8 .

Газеты

• CP Stylebook : Руководство по газетному стилю в Канаде, поддерживаемое Canadian Press . ISBN  0-920009-38-7 .
• Книга стилей Globe and Mail : изначально создавалась, чтобы помочь писателям и редакторам Globe and Mail представлять ясные, точные и сжатые истории. ISBN  0-7710-5685-0

Европейский Союз

• Руководство по межведомственному стилю .
• English Style Guide («Справочник для авторов и переводчиков Европейской Комиссии » — исполнительная власть Европейского Союза .)

Великобритания

Общий

• Копирование-редактирование: Кембриджский справочник для редакторов, авторов и издателей Джудит Бутчер. 3-е изд. 1992 Кембридж: Издательство Кембриджского университета ISBN  0-521-40074-0
• Современное английское использование Фаулера . Эд. Р. У. Берчфилд. Ред. 3-е изд. Лондон: Clarendon Press , 2004. ISBN  0-19-861021-1 (твердый переплет). Основано на современном английском языке Генри Ватсона Фаулера .
• «Королевский английский » Генри Ватсона Фаулера и Фрэнсиса Джорджа Фаулера .
• Руководство по оксфордскому стилю (издание 2003 г.). Объединяет Оксфордское руководство по стилю и Оксфордский словарь для писателей и редакторов , в котором основное внимание уделяется общим проблемам.
• Полное членораздельно , по сэр Эрнест Гауэрс .
• Использование и злоупотребление , Эрик Партридж .

Для юридических документов

• Оксфордский стандарт цитирования юридических властей ( OSCOLA ),Юридический факультет Оксфордского университета

Для журналистики

• Руководство по стилю BBC News : Британской радиовещательной корпорацией .
• Руководство по стилю Economist : The Economist .
• Руководство по стилю новостей The Fourth Estate : от компании Fourth Estate Public Benefit Corporation
• Руководство по стилю Guardian : от The Guardian
• Руководство по стилю и использованию Times от The Times .

Для компьютерной индустрии (программное и аппаратное обеспечение)

• Руководство по стилю технических публикаций Acorn , Acorn Computers . Содержит редакционные рекомендации для текста в учебных публикациях, технической документации и справочной информации по ОС RISC .
• Руководство по стилю ОС RISC от RISC OS Open Limited . Предоставляет рекомендации по дизайну, справку и примеры формулировок диалоговых окон для пользовательского интерфейса программного обеспечения.

Соединенные Штаты

В Соединенных Штатах как корпоративные, так и журналистские формы массовой коммуникации опираются на стили, представленные в сборнике стилей Associated Press (AP). Классическое руководство по стилю грамматики, разработанное как дополнение к книге стилей AP, — это Элементы стиля . Вместе на эти две книги ссылаются больше, чем на любую другую книгу по общему стилю письма от третьего лица в США, используемую в большинстве профессий.

Для общего письма

• «Осторожный писатель » Теодора Бернштейна .
• Брайсон Словарь по хлопотно слов: Руководство Автора к Getting It Right , по Билл Брайсон .
• Современный американский Использование Гарнера по Bryan A. Garner .
• Классика стиля — представляет собой письменное руководство Уильяма Странка-младшего , Эмерсона , Уитмена , По и других писателей.
• ISBN 978-0-917360-63-3 книги стилей Associated Press . 
• Элементы стиля . По Уильям Strunk, младший и EB White . (Часто упоминается как «Странк и Белый».)

Для юридических документов

• Синяя книга: единая система цитирования . Совместно издано Harvard Law Review , Yale Law Journal , Columbia Law Review и Penn Law Review .
• ALWD Руководство по правовым Citation , ранее ALWD Цитирование Руководство, по ассоциации юридических документов директоров
• Руководство по стилю Нью-Йорка : The Tanbook, газета New York State Reporter

Для научных работ

• Чикагское руководство стиля , Чикаго: University of Chicago Press.
• Пособие для авторов исследовательских работ, тезисов и диссертаций в чикагском стиле для студентов и исследователей , написанное Кейт Л. Турабиан . Часто упоминается как « Турабский ».
• Справочник MLA для авторов исследовательских работ , Джозеф Гибальди . Часто упоминается как «MLA».
• Публикация Руководство Американской психологической ассоциации , по Американской психологической ассоциации (APA).

Для журналистики

• ISBN 978-0-917360-63-3 книги стилей Associated Press . 
• Руководство по стилю новостей The Fourth Estate : от компании Fourth Estate Public Benefit Corporation
• Руководство по стилю и использованию New York Times . Аллан М. Сигал и Уильям Г. Коннолли.
• Руководство Wall Street Journal по деловому стилю и использованию , Рональд Дж. Олсоп и сотрудники Wall Street Journal .
• Руководство по стилю BuzzFeed : Эмми Фавилла и Меган Паолоне.

Для электронных публикаций

• Колумбийский путеводитель по онлайн-стилю , Дженис Уокер и Тодд Тейлор.
• Руководство по веб-стилю: основные принципы дизайна для создания веб-сайтов , Патрик Дж. Линч и Сара Хортон .
• Книга стилей Ассошиэйтед Пресс , Ассошиэйтед Пресс, ISBN основных книг 978-0-917360-63-3 . 

Для бизнеса

• ISBN 978-0-917360-63-3 книги стилей Associated Press . 
• Руководство по деловому стилю, Руководство от А до Я по эффективному письму на работе , Хелен Каннингем и Бренда Грин.
• Справочное руководство Грегга , Уильям А. Сабин.

Для компьютерной индустрии (программное и аппаратное обеспечение)

• Руководство по стилю Apple , опубликованное в Интернете компанией Apple Inc. Содержит редакционные правила для текста в учебных публикациях Apple, технической документации, справочной информации, обучающих программ и пользовательского интерфейса программного обеспечения.
  Более ранней версией было Руководство по стилю публикаций Apple.
• Руководство по стилю документации DigitalOcean, опубликованное в Интернете компанией DigitalOcean .
• Руководство по стилю документации GNOME, опубликованное в сети GNOME .
• Руководство по стилю документации для разработчиков Google, опубликованное в Интернете компанией Google . Предоставляет набор редакционных правил для всех, кто пишет документацию для разработчиков по проектам, связанным с Google.
• Руководство по стилю контента Mailchimp, опубликованное в сети Mailchimp .
• Руководство по стилю письма Microsoft , опубликованное в Интернете корпорацией Microsoft . Предоставляет стандарт стиля для технической документации, включая использование терминологии, условных обозначений, процедур, методов проектирования, а также использования знаков препинания и грамматики. До 2018 года Microsoft опубликовала книгу Microsoft Manual of Style for Technical Publications .
• Руководство по стилю документации MongoDB, опубликованное MongoDB .
• Руководство по стилю написания Mozilla, опубликованное в Интернете компанией Mozilla .
• Руководство по стилю Rackspace для технического контента, опубликованное в Интернете компанией Rackspace .
• Прочтите меня в первую очередь! Руководство по стилю для компьютерной индустрии , Sun Technical Publications, 3-е изд., 2010 г.
• Руководство по стилю Red Hat для технической документации, опубликованное в сети Red Hat .
• Руководство по стилю Salesforce для документации и текста пользовательского интерфейса, опубликованное в сети Salesforce .
• Руководство по стилю документации SUSE, опубликованное SUSE в Интернете .
• Руководство по стилю IBM: соглашения для писателей и редакторов , 2011 г., и « Разработка качественной технической информации: справочник для писателей и редакторов» , 2014 г., издано IBM Press .
• Руководство по стилю Splunk , опубликованное на сайте Splunk . Предоставляет справочник по стилю письма для всех, кто пишет или редактирует техническую документацию.
• Yahoo! Гид по стилю , 2010.

Руководства по редакционному стилю подготовки рукописи к публикации

• ISBN 978-0-917360-63-3 книги стилей Associated Press . 
• Чикагское руководство по стилю , составленное сотрудниками Чикагского университета .
• Слова в шрифт, Марджори Э. Скиллин, Роберта

Академический

• Чикагское руководство стиля . Стандарт академической издательской индустрии, включая многие журнальные публикации.
• Пособие для писателей курсовых , тезисов и диссертаций (часто называемое « турабским стилем») — опубликовано Кейт Л. Турабиан , секретарем диссертаций в аспирантуре Чикагского университета с 1930 по 1958 год. Школа требовала ее одобрения для каждого кандидатская и докторская диссертации. Ее стилистические правила полностью соответствуют Чикагскому руководству по стилю , хотя есть некоторые отличия.
• ACS Руководство по стилю -для научных статей , опубликованных в журналах о Американском химическом обществе .
• Руководство по стилю Американской медицинской ассоциации — для медицинских статей, опубликованных в журналах Американской медицинской ассоциации .
• Руководство по стилю Американской психологической ассоциации — для поведенческих и социальных наук; опубликовано Американской психологической ассоциацией .
• Руководство по стилю Американской социологической ассоциации — для социальных наук; опубликовано Американской социологической ассоциацией .
• Рекомендации по составлениюотчетов по геонаукам — для отчетов по геонаукам в промышленности, академических кругах и других дисциплинах.
• Справочник по техническому письму , составленный Джеральдом Дж. Алредом, Чарльзом Т. Брусо и Уолтером Э. Олиу — для общего технического письма.
• Стиль IEEE — используется во многих технических исследованиях, особенно в тех, которые касаются информатики .
• «Маленькое руководство по стилю » Леонарда Г. Госса и Кэролайн Стэнфорд Госс — содержит отчетливо религиозную экспертизу стиля и языка для писателей и редакторов религии, философии религии и теологии — ISBN  978-0-8054-2787-5 .
• Руководство по стилю MHRA — для искусства и гуманитарных наук ; опубликовано Ассоциацией современных гуманитарных исследований . Доступно для бесплатной загрузки (см. Статью).
• MLA стиль руководства , и ГНД Руководство для писателей научно — исследовательских работ -для субъектов в области искусства и гуманитарных наук ; опубликовано Американской ассоциацией современного языка (MLA).
• SBL Handbook of Style — Руководство по стилю Общества библейской литературы, специально предназначенное для изучения древнего Ближнего Востока, библейских и раннехристианских исследований. SBL Справочник стиля включаетсебя рекомендуемый стандартный формат для сокращения источников первичных в Древнем ближневосточных, библейском и ранних христианских исследованиях.
• Научный стиль и формат: Руководство CSE для авторов, редакторов и издателей — для научных статей, опубликованных Советом научных редакторов (CSE), группой, ранее известной как Совет редакторов биологии (CBE).
• Руководство по стилям для политологии — используется многими американскими журналами по политологии ; опубликовано Американской ассоциацией политологии .

Сообщества

• Справочное руководство по СМИ GLAAD , 8-е изд., Справочное руководство по СМИ колледжа GLAAD , 1-е изд., Справочное руководство по китайским СМИ GLAAD , 1-е изд. — опубликовано GLAAD, чтобы побудить средства массовой информации использовать язык и практику с участием ЛГБТ. Доступно для бесплатной загрузки.

Изобразительное искусство

• Руководство по стилю Ассоциации художественных редакторов

Смотрите также

Рекомендации

Внешние ссылки

Представьте, что ваша компания планирует расширяться на зарубежные рынки. Вам нужно перевести массу документации, маркетинговых материалов и сайт. Завести блог для продвижения тоже было бы неплохо. Эти задачи вы поручаете нескольким надежным профессионалам, но в последний момент решаете всё проверить у независимого специалиста. И вдруг выясняется, что тексты, формально соответствуя оригиналу, вызывают тем не менее совсем иные эмоции и ассоциации. А еще — что переводы разных текстов противоречат друг другу: в каталогах цены указаны в местной валюте, а на сайте — в долларах; в печатных буклетах название вашей компании переведено, а в онлайн-магазине, которым занимались другие подрядчики, осталось на языке оригинала. В результате на исправление всего этого уходит масса времени и денег.

Такие проблемы могут возникнуть не только из-за несогласованных действий нескольких подрядчиков. Даже если весь проект берет на себя одна компания-локализатор, но объемы и сроки вынуждают ее делить работу между несколькими сотрудниками, — расхождения весьма вероятны.

Впрочем, задача сохранить единый стиль и согласованность переводов не нова. И решение давно найдено: стайлгайд (от англ. style guide), или руководство по стилю.

Оговоримся сразу: речь пойдет не об избавлении от «шедевров» наполовину машинного, наполовину выполненного недоучками перевода типа «усиленного гидрой колесного руля» или «современных материалов хлопчатой кожи» (что бы это ни значило). Никакой уважающий себя переводчик такого не допустит независимо от того, есть у него руководство или нет. Мы поговорим о том, как вместо среднего перевода получить высококлассный.

Что такое руководство по стилю?

Стайлгайд — это документ, где собраны пожелания заказчика относительно стиля (что понятно из названия), тона изложения, особенностей оформления и другие вопросы, для которых в целевом языке перевода нет строгих правил. Какой должна быть интонация: сдержанно формальной или непринужденно разговорной? Можно ли использовать сленг? Что делать с ценами? Придерживаться метрической или имперской системы мер? Важно ли везде одинаково оформлять даты? Переводить ли названия организаций и инициатив?

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

Какие преимущества дает стайлгайд?

Руководство по стилю поможет добиться:

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

Итак, прежде всего руководство по стилю помогает выдерживать в переводах единое профессиональное оформление. Вы когда-нибудь делали презентации по работе? Тогда вы знаете, как легко испортить самый хороший доклад, просто покрасив слайды в плохо сочетающиеся цвета. То же происходит, если в буклетах, пресс-релизах и интерфейсе сайта неожиданно меняют форму кавычки, названия продуктов в одном месте переведены, а в другом нет, а цены прыгают из валюты в валюту. Такая небрежность создает впечатление работы, сделанной наспех, а это не прибавит ни уважения к компании, ни доверия к ее продукции.

Во-вторых, когда вы пишете для своих клиентов, будь то электронные рассылки или бумажные каталоги, вы наверняка выдерживаете общий стиль, тон обращения. Он может быть дружественным, даже почти фамильярным, а может — торжественным и в высшей степени уважительным. Вы можете допускать вольности и шутки или писать только строго по делу. Всё это и есть голос вашего бренда. Он позволяет читателям подсознательно отличать вас от конкурентов. Поэтому очень важно выдерживать единый стиль в переводных текстах. Здесь тоже поможет стайлгайд.

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

Заказать обратный звонок

В каких случаях необходим стайлгайд?

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

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

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

При локализации компьютерной игры руководство по стилю и вовсе становится предметом первой необходимости, так как позволяет заранее учесть многие (хотя и далеко не все) важные нюансы. Например, как переводить имена и географические названия? Как быть с говорящими прозвищами и наименованиями? Есть ли ограничения по числу символов в переводе? Каковы требования к аудиофайлам? На эти и многие другие вопросы отвечает правильно составленный стайлгайд.

Что стоит включить в руководство по стилю?

Объем стайлгайда может быть разным. У компаний с большим опытом перевода он больше: например, в руководстве у Facebook 30 с лишним страниц, а у другого IT-гиганта — более сотни. Если же компания только начинает работать с новыми рынками, достаточно самой важной информации на 6–8 страницах. Краткое руководство проще освоить тем, кто будет участвовать в локализации. Позже вы сможете добавить то, что окажется важным в ходе работы.

Обычно руководства по стилю делятся на две части. В первую входит то, что касается голоса вашего бренда, во вторую — технические требования и правила оформления.

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

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

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

В техническую часть включают рекомендации по формальным вопросам.

• Пунктуация. Как минимум — форма тире и кавычек, с ними вечные вопросы в большинстве языков. Хотя медиа-портал Buzzfeed, например, учитывает даже такие детали, как порядок знаков в довольно редком сочетании «?!».
• Региональные стандарты. Это в первую очередь оформление времени и дат, например, указывать сначала месяц или день. Сюда же относятся правила для номеров телефонов и адресов.
• Переводимость. Нужно ли оставлять на языке оригинала, переводить или транскрибировать названия компаний, линеек и моделей продукции, статей и так далее.
• Упоминания интерфейса ваших программ, если они есть в тексте. Оставлять их на языке оригинала, дублировать переводом или, может быть, уточнять этот вопрос для каждого проекта.
• Другие важные детали. Для русского языка, например, полезно указать, хотите ли вы видеть в своих текстах букву ё.

Кто составляет стайлгайд?

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

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

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

Что дальше?

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

Однако не стоит считать стайлгайд истиной, выбитой на камне. Руководства лучше всего работают, если их периодически пересматривать и адаптировать к переменам. При интенсивных переводах это полезно делать каждые полгода или год. Если вы локализуете материалы редко, документ может прожить 3–5 лет.

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

Четкие инструкции и слаженная работа — это высокое качество ваших текстов. А это — в наших общих интересах!

Текст: Полина Скурихина, Анна Марковская