Немного вброшу про ретроспективы 🌸

Ретро — регулярные встречи команды ради анализа проделанной работы

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

Ретро можно поделить на 4 этапа:

🐶 разогрев
📌 позитивное
📌 негативное
📌 план действий

Не буду разбирать подробно, хочу сейчас об одном моменте.

Позитивное-негативное можно обсуждать с вопроса "что было хорошо или плохо?". Но можно подойти с другого ракурса:

Что нам стоит продолжить и что надо прекратить делать?

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


💭 Как относитесь к ретро? Что можете порекомендовать из вашей практики?

Вытаскиваем знания из эксперта

Хороший вопрос был на Стачке про добычу информации из её держателей.

Если вам нужна индульгенция на иглы, утюги и паяльники — уточните у работодателя)

Но!

Да, бывают сложные коллеги, да, бывает сложное знание, да, бывают завалы и не до ответов на странные вопросы.

Мне кажется, это вопрос приоритетов. Иногда командных, иногда — конкретного человека.

Поэтому

1️⃣ Объясните человеку, зачем оно надо. Не “потому что мне задачу поставили”, а чуть дальше. “Чтобы тебе с такими вопросами больше не приходили”, например.

2️⃣ Договоритесь об удобном канале связи. Я обычно предлагаю такие форматы:
*️⃣ регулярная встреча на 15 минут и вопросы к ней за сутки;
*️⃣ отдельная страница или чат с вопросами от меня, куда человек будет заходить в комфортное для него время и письменно отвечать;
*️⃣ контакт кого-то из команды, кто может ответить на большинство вопросов или передать на обсуждение дальше, чтобы вернуться и ответить.

3️⃣ Обозначьте сроки и границы задачи, чтобы человек понимал как долго и по каким вопросам вы будете приходить.

Ну и выдерживайте гигиену коммуникаций

#monday_link

Роль текста в продукте от Академии Яндекса

Лекция на полтора часа в основном о редакторах, но с наглядными примерами по очень разным темам — и интерфейсы, и FAQ ✨

Там же о текстовых атрибутах, даже для соцсетей 🔥


🤨 Лекции и доклады оставляем или это как раз те ютубные ссылки, которые скипаются?)

Гигиена коммуникаций

Начинайте чат с представления.
Привет! Я из отдела технических писателей.

Указывайте источник обращения.
В чате ~helpdesk направили к тебе.

Насыпайте контекста.
У нас есть платформа документации docs.ozon.ru. Сейчас она вся доступна из внешней сети.

Описывайте запрос и ожидаемый результат.
Нам надо скрыть часть статей. Например, Способы оплаты. Так, чтобы если я пытаюсь перейти на эту страницу не из рабочей сети, то получала страницу 404. Список таких статей на скрытие есть в тикете.

Оставляйте пути отступления.
Подскажи, это к тебе? Или к кому лучше обратиться?)

Уважайте процессы других команд.
Куда занести задачу и какой процесс приоритизации?

Обозначьте риски и ограничения.
Задача не срочная, есть время до 1 ноября.


🍊 Пример грубый, поэтому бонусное правило.

Заботьтесь о коллегах
пишите это всё в одном сообщении

уже сегодня techdoc meetup 2 📥

поговорим о стайлгайдах и о профессии техписателя — подключайтесь к трансляции в 19:00 ▶️

📌 UPD Запись митапа

добыли енотов и классные вопросы 😍

Бывают периоды, когда команда начинает скучать. Монотонность и рутина могут снижать эффективность и влиять на мотивацию.

Но что делать, чтобы вернуть в команду живость и вдохновение?


🦔 разнообразьте задачи и процессы

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

🦌 организуйте командные мероприятия и встречи

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

🐻 поставьте перед командой новые вызовы и цели

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

🦝 поддерживайте позитивную атмосферу и командный дух

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

🦉 поощряйте творчество и инновации

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


Здесь есть нюансы и можно уйти в другую крайность, но это отдельная тема 🍁

#mngr

📣 Вопрос

В чём разница между Knowledge Manager и Техническими писателями?

Пока не могу понять где эта тонкая грань — помогите) ГОСТы уже посмотрела, но на реальные кейсы пока не осознала. Может, у вас в компании есть обе роли или наоборот только одна, а второй и не надо?

Поделитесь, пожалуйста, своим опытом и видением — где техпис, а где ноуледж менеджер? 🐸

Не надо ездить на конференции просто чтобы послушать доклады. Даже онлайн не стоит тратить своё время и силы спикера, если у вас нет конкретных вопросов или болей.

🛟 Если вам просто нравится какой-то спикер — считается.
На харизматичных докладах можно зарядиться и вдохновиться и за счёт этого улучшать свои карьерные показатели.


🛒 До покупки билета

1. Посмотрите программу.
2. Отметьте интересные доклады и спикеров.
3. Запишите почему они интересны и полезны именно вам.

🛟 Если билет покупает работодатель, поделитесь с ним описанием из третьего пункта.


☀️ Перед стартом докладов

4. Найдите спикеров из п.2, скажите им что ожидаете от доклада.
5. Запишите вопросы, которые хотели бы обсудить с экспертами.


🔉 Во время доклада

6. Отмечайте вопросы, на которые спикер ответил.
7. Записывайте вопросы, которые приходят вам в голову.


⭐ После доклада

8. Задайте свои вопросы по регламенту конференции.
9. Обменяйтесь контактами ради конкретного действия.


Большинство докладов можно будет посмотреть в записи на х2, основная ценность конференций — в нетворкинге и живом обсуждении 🦖

Хэлпы, FAQ, ЧаВо, печатные мануалы в коробке — это всё примеры пользовательских документаций. Давайте разбираться в нюансах 🐝

🌻 Справка — это набор инструкций к продукту рядом с продуктом. Например, у web-ресурсов Справка, скорее всего, будет тоже онлайн. Для вещей физического мира — будет вместе с ними в коробке пухленькой книжкой, о которой вы вспомните, когда что-то сломается.

🌼 База знаний — это контент разных форматов, размещённый на одной платформе. В Базе знаний может быть и Справка, и записи вебинаров, и форум для пользователей. Скорее всего, База Знаний будет онлайн из-за разнообразия форматов внутри неё.

🌼 Ещё можно встретить ссылки на Помощь — Справка и База знаний могут быть Помощью, если в них есть чат с поддержкой или форма обратной связи, предполагающая помощь пользователям по их обращениям.

🍒 Часто задаваемые вопросы (ЧаВо) — частный случай Справки, но не её полноценная замена. У ЧаВо весьма устоявшийся формат: вопрос → ответ. При этом ЧаВо может быть частью лендинга или отдельного экрана в продукте, а не отдельным ресурсом.


#techdoc

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

Пишите свои вопросы в комментарии ✨

Текст о том, как организовывать выход нового сотрудника на удалёнке, в один пост не влез, поэтому держите статью в Notion 🐈

Начинаем через 20 минуток

😉 Трансляция

Ещё раз про KPI
для техписов и в принципе

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

Если оценка сотрудников сводится только к количеству проделанной работы — теряется понимание а зачем всё это вообще надо. Поэтому можно использовать KPI как дополнительный показатель, но основывать на нём работу направления — бессмысленно.

Используйте SMART, обращайте внимание на то, какие продуктовые метрики надо улучшать, думайте вместе с коллегами над решением. Здесь могла быть интеграция курса по метрикам 🐹

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

Ваша задача, как сотрудника любого уровня, понимать глобальную цель. Как директора, кстати, тем более 🥺

🌟 #вопросы #techdoc

дисклеймер: для терминов выбираю адаптацию, которую считаю самой удачной, а не официально-принятую, потому что такая не всегда есть


🌟 По каким принципам можно формировать разделы в пользовательской документации?

Глобально есть два подхода: описательный и сценарный.

Некоторым пользователям действительно привычнее видеть исчерпывающее описание интерфейса, особенно если интерфейс никогда не оптимизировался, а только разрастался под все хотелки всех причастных.

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

Лично я — сторонник сценарных документаций, аргументы можно послушать в докладе Юры Никулина и у меня на митапе Cloud.ru. В таком подходе верхними уровнями будут ключевые точки взаимодействия пользователя с системой: получение доступа, настройка окружения, деплой, закрытие релиза; регистрация, поиск товара, заказ, возврат.

Но! 🌟

Если пользователь говорит, что ему что-то не нравится — стоит исследовать почему. Поэтому просто сказать «пишите от процессов и будет у вас счастливый читатель» — не правильно. Ваш читатель не всегда знает, как решить свою проблему и как ему будет действительно удобно. Но вы в силах пообщаться с ним и найти лучшее решение для вашей конкретной ситуации..


🌟 Как определить оптимальную длину статьи?

Если это веб-ресурс — около 2-2,5 экранов вашего читателя.

Но опять же, если информации на два абзаца и вашему читателю удобно именно так — может, так и надо оставить.

И, пожалуйста, не забывайте, что мы пишем документацию не ради количества знаков с пробелами, а чтобы помочь пользователю. Поэтому искусственно наращивать объёмы не стоит. Посмотреть, с чем можно объединить или на что можно разбить — да; запретить выкатку статьи меньше 2 экранов — нет.

Techdoc Meetup 3 😎

Это будет уже почти новогодняя встреча, поэтому и доклады спикеры готовят немного необычные, но всё ещё про документацию.


🏳️ Нужна ваша помощь

1. Ищем спикера — можно присылать мне в личные сообщения идею доклада на 20-25 минут. Необязательно что-то серьёзное об организации знаний или фреймворках документирования — если у вас есть пачка историй из жизни техписа, видение музыкальных паттернов при написании текста или что-то другое ненавязчиво-праздничное — приходите 🚀

2. Ищем вопросы для круглого стола — их можно в комментарии к посту. Если есть пожелания по участникам круглого стола — туда же, в комментарии ⚡️


Точную дату и место сообщим чуть позже, следите за анонсами в сообществах техписателей 🎤

#анонс


▶️ Записи прошлых Techdoc Meetup
0. Декабрь 2022
1. Июнь 2023
2. Сентябрь 2023

#вопросы #techdoc

🐸 В идеальном мире код документирует себя сам, а структура документации показывает CJM.

Но пока идеальный мир не наступил и иногда случаются инструкции к инструкциям. Это даже не всегда плохо.


Как познакомить сотрудников со структурой Базы знаний в Confluence?

1. Встроить это знакомство в онбординг — нарисовать схемку «это — здесь, то — там», добавить обязательный квест «найди X». Так сотрудники познакомятся с внутренней Базой и научатся пользоваться Confluence.

2. Только если База знаний достаточно статична, её структура не будет обновляться и в целом База уже пробивается на камне — можно записать видео. Иначе неактуальное видео будет путать сотрудников, либо его надо будет переснимать каждые 2-3 месяца. Ещё стоит учесть, что видео может стать камнем, тянущем пересмотр структуры ко дну — поэтому лучше сначала провести исследование, аудит и актуализацию, а потом уже записывать обучающий ролик 🐸