Четкие и понятные требования — фундамент, на котором строится качественная документация. Такая, где каждый пользователь быстро находит нужную информацию, а технические писатели поддерживают и обновляют задокументированные знания с минимальными затратами.
Стайлгайд — инструмент, который устанавливает стиль и тон изложения, оформление текста и структуру, использование терминологии и других особенностей.
Как создать стайлгайд? Что он должен включать в себя?
На мастер-классе я расскажу о целях стайлгайда, видах, применении и жизненном цикле.
Затем вместе с участниками мы разработаем шаблон стайлгайда и получим обратную связь от коллег. С мастер-класса вы уйдете с рабочим прототипом руководства по стилю, а в будущем сможете адаптировать и внедрить его в вашей компании.
Что понадобится для участия в мастер-классе:
ноутбук или мобильный телефон;
учетная запись Google.
0