#писалитирекомендует

Всем привет!
И в том числе привет всем новеньким подписчикам❤️

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

Итак, популярная тема на этой неделе — грейды техписателей.

У нас по этой теме:

1️⃣ Грейды технических писателей: примерная лестница для новичков и бесплатная основа для вашего ранжирования. Забирайте и подстраивайте под себя)

2️⃣ Чем сеньор отличается от джуна? Размышления у парадного подъезда)

3️⃣ Что делать джуну, если лид ушёл в отпуск? Наши рекомендации, или чего мы ждали от своих джунов

Учитесь вместе с нами❤️

Всем привет!

Сегодня, 14 ноября, в 19:00 по московскому времени пройдёт митап для технических писателей, организованный коллегами из Cloud․ru.

О чём пойдёт речь?

🔴 Юлия Служаева из Cloud․ru расскажет о редполитике: как написать правила и не устроить бои без правил.

🔵 Марина Смирнова и Екатерина Каляева из Cloud․ru поделятся, как они автоматизировали проверку документации: кейс с линтером Vale.

🟢 Антон Литвинов из SberDevices поговорит о системе метрик клиентской документации.

🟠 Теодора Малевинская из T-Bank расскажет о частых ошибках техписателей в поиске работы.

Ссылка на онлайн-трансляцию появится в канале TeamSnack TechWriters, не пропустите :)

#анонс

#какэтоработает
Всем привет! Сегодня поговорим о том, с чем техписатели чаще всего не работают, но что всё равно находится в их сфере влияния, и поделимся полезным шаблоном.

Постмортем. Что это и для чего

Как видно из названия, постмортем — это артефакт, который появляется после критической ситуации, инцидента.

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

❓ Мессенджер упал — это инцидент, потому что сервис недоступен.

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

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

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

*️⃣Кто пишет постмортемы

Постмортемы пишут инженеры, которые устраняют инцидент и его последствия.

*️⃣Как участвуют техписатели

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

❗️На прошлой неделе мы анонсировали подкаст о постмортемах. Техписалити! совместно с одним из участников подкаста - Кареном Товмасяном, Senior Engineer в Payments @ Uber и автором канала Человек и Машина, разработали шаблон постмортема на основе открытых данных. Этот шаблон можно забирать, адаптировать и использовать бесплатно.

#какэтоработает

- Заходит продакт в бар к техписателям и говорит: "У нас завтра релиз, нужна дока!"

Всем привет! Бывает ли у вас так, как в этой грустной непридуманной шутке? Вот у нас бывало( Как избежать подобных ситуаций?

Раннее документирование

Shift-left документирование или документирование со сдвигом влево — называть этот процесс можно по-разному. Суть в нём одна: технический писатель приступает к описанию продукта как можно раньше.

Когда возможно раннее документирование?

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

Когда приступать к работе?

При раннем документировании техписатель составляет черновик документации на основании технического задания. Сделать это можно, когда разработчик даже ещё не взял задачу в работу. В этот момент можно:
*️⃣ определить место этой фичи в общей структуре документации,
*️⃣ установить её связь с другими функциональностями,
*️⃣ составить последовательность действий при разных сценариях.

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

Какие плюсы и минусы?

➕ Документация готова до релиза.
➕ Техписатель может планировать и распределять свою нагрузку, если описывает несколько продуктов.
➖ Он должен быть погружён в продукт, то есть поддерживать постоянную связь с разработкой.
➖ Задача может не попасть в релиз. Но этого минуса нет, если используется docs-as-code и подход одна фича — одна ветка. Просто вольёте эту ветку в нужный релиз.

А вы пробовали такой подход? Какие минусы заметили ещё?

Всем привет!

Сегодня у нас снова интерактивная и предновогодняя #мемница

Собрали для вас техписательское бинго не без приколдесов конечно 😄
Забирайте и делитесь с коллегами! А в комментах можете показать, какие страйки вы выбили 😏

Всем привет в новом году!

Врываемся в рабочие будни сразу с серьёзного вопроса: как начать год продуктивно?

1. Вспомните всё: я — технический писатель, я делаю мир лучше 💪
2. Проверьте или составьте план на 2025. Если вы принципиально не составляете планы, то проверьте сроки задач, которые выполняете. Но начало года — время пробовать что-то новое, так что попробуйте хотя бы набросать план 🙂
3. Встретьтесь или созвонитесь с командой, чтобы вместе настроиться на работу 🤝

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

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

И личностные:
🟢 понять, как работают облачные сервисы;
🟢 сменить работу;
🟢 начать больше зарабатывать;
🟢 выступить на конференции.

Необязательно составлять пошаговый план, но для начала можно составить список хотелок, расставить приоритеты и наметить какие-то сроки. Например: хочу сделать грандиозный проект на работе за первый квартал, к середине года повысить грейд и зарплату, а осенью выступить спикером на митапе. Лучше всего даже такие наброски где-то записать и держать если не перед глазами, то в месте, в которое вы часто обращаетесь. Это важно, чтобы не забыть свои желания, потому что в веренице рутины и работы фокус внимания может сместиться. И к концу года вы обнаружите, что не сделали ничего, что хотели.

Но самое главное — соблюдайте work-life balance, иначе любые планы и желания станут уже не так важны. Потому что какой смысл быть лидом или больше зарабатывать, если ты выгорел или сошёл с ума 😏

А как вы начинаете свою работу в этом году?