Предполагаю, что вам, дорогие читатели, в своей работе приходилось иметь дело с технической документацией и, возможно, даже с теми, кто ее создает - с техническими писателями.
И в нашем блог Возможно, вы встречали технического писателя из команды Veeam.
Сегодня мы переходим на новый уровень понимания того, как работает разработка технической документации в Veeam Software. 
КДПВ обманчив - это не чудо, а такая же работа, как и у всех остальных коллег из НИОКР.
Однако у тех, кто создает гайды, есть волшебные слова – свои гайды по созданию гайдов! Вот что такое рекурсия.
Подробнее читайте в рассказе моей коллеги Дарьи Шалыгиной.
Здравствуйте, меня зовут Даша, я руководитель отдела качества контента в Veeam Software. Я отвечаю за качество контента, создаваемого отделом технического письма нашей компании.
По сути, я технический писатель и редактор в одном лице.
В мои обязанности входит:
- ведение собственных проектов — как и у всех технических писателей, у меня есть своя зона ответственности, то есть ряд продуктов, по которым я создаю и веду документацию;
- обучение сотрудников младшего звена — я создал вводный курс для «новичков», который провожу для объяснения основных правил написания документации;
- консультирование сотрудников более высокого уровня (опытных и старших) – у меня запланированы ежедневные сессии, в ходе которых любой член нашей команды может задать мне любой вопрос по документации (будь то формулировка, структура и т.д.);
- проведение контрольной проверки — периодически я выборочно проверяю документы членов нашей команды на предмет форматирования, ошибок, опечаток, несоответствий по стилю и так далее.
Когда приходил кто-то новый, он изучал уже существующие гайды и начинал писать примерно в том же духе.
Это было чудесное время, когда у всех нас было примерно одинаковое чувство прекрасного, и мы легко могли прийти к единому пониманию того, как писать документацию к нашим продуктам.
Время шло, компания росла, продуктов становилось все больше, возникла необходимость увеличения штата технических писателей.
Сегодня нас уже 18 человек, и мы не планируем останавливаться на достигнутом.
Все бы ничего, но вдруг оказалось, что при таком количестве людей становится сложно договориться о прекрасном.
Это требует времени, времени и еще раз времени.
Чтобы снизить энергозатраты на передачу знаний вновь прибывшим, а также раз и навсегда запечатлеть все «красивое» в технической документации Veeam, мы решили создать собственное руководство по стилю.
Надо сказать, что некоторые наброски на тему стиля существовали уже много лет в виде статей по Confluence и заметок на полях в блокнотах, но все это было неорганизованно, разбросано, и, конечно, мы не можем Говорить о каком-либо удобстве использования и актуальности информации мне не приходилось.
Был: 
Когда мы создавали наше руководство по стилю, мы взяли за основу 3 больших руководства, которые обычно берут за образец при написании документации:( Чикагское руководство по стилю , Руководство Microsoft по стилю И Лучшие практики DITA ), изучил ряд сторонних руководств по стилю, существующих от других компаний (например, Руководство по стилю IBM , Руководство по стилю документации для OpenSolaris и другие), провели исследование последних тенденций в области документации и смешали все это с нашим собственным одиннадцатилетним опытом работы в Veeam Software. Стал: 
В результате в Руководство по стилю технического письма Veeam включили такие актуальные темы, как структурирование контента по типам тем, принципы Plain English, пунктуация, статьи, форматирование, оформление скриншотов и диаграмм, оформление ссылок на собственную и стороннюю документацию, а также полезные напоминания на каждый день.
С появлением руководства по стилю мы не только облегчили процесс передачи знаний новым сотрудникам, но и получили следующие преимущества:
- предотвращение необходимости поиска в сторонних гадах и Интернете ответов на вопросы, возникающие регулярно;
- мгновенное решение спорных вопросов относительно языка, оформления и структуры документов;
- удобная навигация по собственной базе знаний;
- возможность предоставлять ссылки на определенные разделы коллегам из других отделов, которые прямо или косвенно занимаются написанием текстов (будь то Поддержка или QA).
Знаменитый мем о том, как резко меняется стиль письма после работы техническим писателем.
Наше руководство по стилю было создано не носителями английского языка и предназначено для неносителей языка.
Однако его прочитали и проверили наши коллеги-носители языка, лингвисты отдела маркетинга, имеющие соответствующее образование, давно пишущие тексты для сайта компании и разработавшие собственное руководство по стилю, также на основе принципы работы упомянутых гигантов отрасли.
В настоящее время мы работаем над расширением нашей базы знаний.
Мы хотим создать отдельные руководства по стилю для справочных документов, таких как Справочник по REST API и Справочник по PowerShell. Содержание таких документов должно быть структурировано определенным образом, и это необходимо фиксировать, чтобы обеспечить согласованность между продуктами.
Мы будем рады, если наш гид по стилю будет полезен другим компаниям, которые все еще находятся в поиске своего стиля.
Еще советую посмотреть справочный раздел , что, по нашему опыту, часто бывает необходимо в работе — там много интересного.
:) Руководство по стилю технического письма Veeam (на английском языке) Теги: #Карьера в ИТ-индустрии #Образовательный процесс в ИТ #техническая документация #veeam #техническое письмо #техническое письмо #технический писатель #стильгайды #стильгайд #стильгайд
-
Пост О Том, Как Я Лепила Игру Из Пластилина.
19 Oct, 24 -
Millenium Bsa – Бесплатная Erp В России?
19 Oct, 24 -
Микрокосм, Демо-Версия
19 Oct, 24 -
Omegle – Поговорить С Кем-Нибудь
19 Oct, 24 -
Последний Раз Про Vista Sp1 - Кто На Чём?
19 Oct, 24
