Техническая документация

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

План:

"Книжный" формат пользовательской доки: кажется, он устарел.

Структура справки: как делали проще.

Стиль и язык изложения: как делали легче.

Люди: как адаптировали к быстрым и постоянным изменениям.

Опыт: как замапить успешный опыт на остальные продукты.

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

За последние 8 месяцев я изменила формат анонсов (они же и release notes) продуктов нашей внутренней экосистемы для разработчиков. Важно:

— этими продуктами пользуются более 3500 инженеров;

— продуктов в экосистеме много;

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

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

Примерный план рассказа:

— Частые ошибки, почему ваша коммуникация с пользователем неэффективна (в том числе и наши ошибки)

— Об аудитории, какие у неё потребности и проблемы

— Наши требования к анонсам с описанием. Пунктов будет много, разберём с примерами.

— Практика — разберём анонсы инженеров: как было и как стало

— Как оценить эффективность коммуникации с пользователем.

В рассказе интересно опишу и свой опыт, и базу по technical communication.

Почему тема отличная:

— мало докладов про technical communication;

— с проблемой сталкивается каждый человек, который делает технологический продукт;

— полезно и интересно будет разным ит-профессиям;

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

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

В своем докладе мы расскажем:

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

• Как подготовиться к каждому этапу коммуникации и как вести себя на встрече.

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

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

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

В докладе расскажу о работе над инструкциями в редакции на примере этой самой РП для МП. Подробно разберём каждый шаг на пути к гайду: от осознания потребности до вывода в прод

В итоге слушатели получат ответы на вопросы:

- зачем мы вообще пишем инструкции

- почему этим занимаются рядовые редакторы

- какие этапы есть в создании инструкции

- с кем, кроме редакторов, мы советуемся

- как пользуемся инструкциями и поддерживаем их актуальность

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