Пока придумываю, чего б вам тут написать и разбираюсь с новой работой — придумала вот напомнить о Стачке в Ульяновске 18-19 апреля ✨

Провели черновые прогоны, готовим доклады и о ГОСТах (!)
впервые вы о них слышите от меня, кажется, но оставляли в формах обратной связи запросы

Других анонсов у меня пока нет 😄 готова выслушать ваши идеи 🙄

Почему внутреннюю документацию не читают
и как это исправить

📌 Главная проблема — документация существует отдельно от работы.

Люди не читают её не потому, что они плохие и ленивые, а потому что:
— проще спросить в чате, чем искать;
— инструкция не там, где её ожидают;
— текст перегружен, а ответа нет.

Как исправить?
нанять техписа

✅ Встраивать знания в процесс

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

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

хотя к шаблонам у меня особая любовь, о ней — отдельно 😅

✅ Не плодить текст ради текста

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

Поэтому:
— вместо гигантского FAQ — бот или автоподбор ответов в чате;
— вместо стены текста — структурированная стена текста и примеры.

✅ Актуализировать, когда есть реальный запрос

Бывает, что обновление документации — это задача без дедлайна.
Когда-нибудь, кто-нибудь может быть и дойдёт...

Решение:
— ловим триггеры: появился повторяющийся вопрос → обновляем инфу;
— связываем с процессами: новый релиз → автоматическое ревью документации.


Но кто всё это будет делать?

🥺 вы, если вам не хочется вечно отвечать на одни и те же вопросы.
🎧 тимлиды, если видят, что команда тратит время на поиск инфы.
💐 продукты, если саппорт завален повторами.

Документация должна экономить время. Всё остальное — бесполезный архив.

#этобаза

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

😈 Как продать команде новые процессы, чтобы они не сопротивлялись


Попытки улучшить процессы обычно заканчивается одинаково:
Зачем нам это?
Раньше было проще
и моё любимое

Очередная бюрократия, только мешает!

В итоге новые процессы либо игнорируют, либо выполняют формально, лишь бы отстали.


Как сделать так, чтобы люди приняли изменения?


✅ Решать реальную боль, а не улучшать ради улучшения

— Нельзя просто сказать: «Теперь мы пишем документацию перед задачей».
— Нужно показать: «У нас нет доки для разработки и мы тратим первую часть спринта на уточнение требований. Давайте сначала требования, потом разработка?».


✅ Показывать быстрые победы

Если ценность процесса можно почувствовать через неделю, а не через квартал, он приживётся вероятнее.

Новая форма баг-репорта? Первый же баг ушёл в работу без уточнений!
Автоматизация в Jira? Первая задача закрылась без ручного пинга!


✅ Встраивать в привычный ритм работы

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


Люди не против хороших процессов. Они против ненужных усложнений.

#этобаза

Очень рада за Майки и Анору — безумно понравился фильм даже после просмотра на русском.

Но я думала, что Оскар уйдёт Деми Мур.

И считаю, что победа Майки в одной номинации с Деми — буквально сюжет Субстанции 🫠

😱 FAQ не работают — что делать?
не делать факи

Логика появления чавошных понятная: люди задают одни и те же вопросы — давайте соберём их в FAQ.

Но на практике:
— FAQ есть, но в него никто не заглядывает
— ответ там есть, но люди всё равно спрашивают
— часть информации устарела, но её никто не обновляет


Почему так?

📌 FAQ — это ещё одно место, куда надо идти. Если человек уже пишет в чат, значит, путь до чата был проще и очевиднее, чем до фака*.
📌 Ответы требуют дополнительных действий. Прочитать, осмыслить, применить — проще спросить и получить готовое решение.


Что работает лучше?

✅ Встраивать знания в работу
Автоответы в мессенджере — бот сам кидает нужную ссылку
Подсказки в интерфейсе — решение сразу в контексте задачи
Ссылки в таск-трекере — почти как подсказки в интерфейсе, но для узкого кейса

✅ Давать результат, а не текст
Вместо инструкции «Как оформить доступ» — кнопка «Запросить доступ». И дальше уже подсказки по флоу, если они нужны.
Вместо «Как назвать задачу» — автогенерация заголовка (это ещё немножко магия)

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

📌 Пользователи всегда выбирают самый быстрый способ получить ответ. Если FAQ не помогает, значит, нужен другой формат.

—
*знаю кейсы намеренного усложнения дороги до чата или формы обратной связи, чтобы дойти до фака было проще — так не делайте, пожалуйста

#этобаза

На Хабре вышла статья как мы в Ozon стайлгайд собирали

Читать и лайкать 💙

Если у вас недостаток мотивации, держите этих двух гениев

🕺 Танец милкшейка

🕺 Педро и его airpods

now work it🎵

Напоминание перед завтрашней конфой


1. Заранее подумайте о вопросах, которые хотели задать спикерам. Не надо ходить на конфу просто послушать — для этого будут записи в х2. Список вопросов я обычно просила ещё на этапе согласования командировки, чтобы понять будет ли реальная польза от билета 😿


2. Выберите доклады, на которые точно не пойдёте. Как раз те, которые посмотрите в записи. Оцените, есть ли смысл отдельно подойти ко спикеру и познакомиться. Но если к докладу нет вопросов, просто интересненько — лучше скипайте и смотрите на х2.


3. Приготовьте ссылку на свои контакты: тгк, сайт, сетку. С людьми можно просто знакомиться. Просто подходить и говорить «Привет, я Катя, занимаюсь процессами документирования и поддержки». Даже если кроме обмена контактами ничего не произойдёт — прокачаете свой иммунитет к кринжу 🐈


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


#TWD2
Меня там снова не будет, делитесь фотками и впечатлениями 😽

🎨Кто выступит в секции «Техническая документация» на IT-конференции «Стачка» в Ульяновске?

→ Татьяна Тимофеева – аналитик в Ibs. Доклад: «Трудности перевода, или Как хорошо написать документацию ГОСТ»
→ Дарья Цыплакова – руководитель отдела технической документации в Nemo.Travel. Доклад: «Писать нельзя делегировать: как маленькая команда техписов живет в большом бизнесе»
→ Вера Крючкова – руководитель направления технической документации в РУСАЛ. Доклад: «Как оптимизировать систему документации в компании, если требуется и клиентов привлечь, и ГОСТам соответствовать»
→ Константин Нежберт – технический писатель в АО «Флант». Доклад: «Орфография в контейнере: CI/CD для проверки документации»

Тезисы докладов по ссылке: https://ul25.nastachku.ru/technical-documentation-ul25

Кому будет полезно: техническим писателям; специалистам из продуктовых команд: аналитикам, продактам, тестировщикам; сеньор-разработчикам.

💡Эксперт секции: Екатерина Ушакова – руководитель отдела технической документации и UX-редактуры в Ozon Tech. Лектор курса Technical Communication в Университете Иннополис.

Присоединяйтесь к «Стачке» 18-19 апреля (Ульяновск, УлГПУ). Билеты на сайте: nastachku.ru/buynow

📣 Одна горячая новость за другой

Вакансия в Крауд на мои проекты

Ищем двоих, технически грамотных, будем с вами делать доки для внутренних сервисов Райдтеха 🏠

Если откликаетесь — напишите мне в лс @ushkatia свои фио, чтобы я вас могла найти среди остальных откликов

Раньше я работала с людьми, которые знали наизусть всего Мильчина. Сейчас — с теми, кто просто пишет, как умеет. Это нормально. Но иногда ужас как хочется сначала исправить текст, а уже потом вчитываться в суть 🫠

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

#️⃣ How to write like a techwriter

🔴 Списки — единообразные и без пляшущего форматирования.

🔴 Скобки — по минимуму, чаще всего их можно просто выкинуть.
Ильяхов: Без скобок

🔴 Сокращения — без точек: техплатформа, архревью.

🔴 Абзацы — через пустую строку, особенно если пишете в Notion или вики.

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

🔴 Тире — длинное, а не дефис.
На маке: ⇧ + ⌥ + тире. На винде: Alt + 0151 на цифровой клавиатуре.


Следующий glow up — вычищать канцелярит:
➡️ bureau.ru

Вы тоже техпис, даже если это не прописано в должности

Техдока — это не только про API и релиз-ноты. Это про любые рабочие коммуникации: тикеты, вики, письма, описания фичей. Всё, что кто-то будет читать, чтобы понять, что делать.


А аккуратный текст — это не занудство, а уважение к читателю.
А оправдывание занудства — это не душнилово 🦆