✱ Подходы, инструменты, стандарты
Инструкция для инструкции. Как написать гид по стилю
Techwriter Days #2
2025-03-28 10:00
Секция D
40 мин
Просто
Спикеры
Доклад был на прошедшей конференции Techwriter Days #2 и сейчас находится в архиве.
Представляем вашему вниманию запись вдохновляющего доклада, который состоялся на конференции Techwriter Days 2 в категории «Подходы, инструменты, стандарты». Антон Копылов, технический писатель из Restream Media, поделился своим богатым опытом и уникальными подходами в создании гидов по стилю.
Из доклада вы узнаете, как подготовительный этап влияет на успех вашего стайл-гайда, почему важно тщательно прорабатывать фундамент, и как грамотно структурировать разделы.
Антон подробно рассказывает о том, какие правила стоит добавить, как тестировать их с помощью живой документации и что делать, чтобы гид был полезен не только техписателям, но и всей команде. Узнайте, как интегрировать правила в работу и поддерживать актуальность при изменении Legacy. Антон делится и тем, как презентация гидов всей команде помогает улучшить коммуникации и синхронизировать работу.
Оцените практический подход к созданию словарей и глоссариев, ведь они являются важной частью единого стиля компании. Не пропустите возможность улучшить ваши документы и увеличить продуктивность вашей команды.
В докладе расскажу про поэтапное создание гида по стилю. Вы узнаете, о чем нужно задуматься перед созданием гида, какие этапы нужно пройти во время его создания, чем наполнять и зачем.
Подробно разберем:
Фундамент для создания гида. На какие исходные данные нужно обращать внимание, а также какими внешними источниками вдохновляться.
Алгоритм создания с объяснением каждого шага.
Структура гида. Из каких разделов может состоять гид по стилю, и как пригодится каждый из них.
Наполнение гида. Типовые шаблоны для правил гида по стилю с примерами.
Особенности разработки глоссариев. Почему у нас их несколько, и как мы договаривались писать слова.
После доклада вы обзаведетесь инструментами: шаблонами, референсами, алгоритмами и полезными ссылками. С их помощью вы самостоятельно сможете создать гид по стилю, который будет работать в вашей команде.
Доступно только после покупки 😊