Техписалити! – Telegram
Техписалити!
1.9K subscribers
174 photos
16 videos
89 links
Первая открытая школа технических писателей

Пишут Лида Туляганова, Маша Щеблякова и Катя Марченко
Download Telegram
Всем привет, на связи Маша 👋

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

Чтобы новичкам было легче жить, за ними закрепляют наставника, которым часто выступает руководитель. И вот вроде бы начало — самое время для «глупых вопросов», но новичок и так стрессует, так ещё и вопросы нужно задавать руководителю. В общем, стресс только растёт.

Как помочь новичку поскорее влиться в работу? Например, можно заранее собрать страницу с командными с процессами, инструментами и инструкциями по получению доступов. И давать ссылку на такую страницу всем новеньким! Звучит классно, но это же надо придумывать структуру, ничего не забыть...

Чтобы не задаваться лишними вопросами, мы с коллегами разработали шаблон для командных онбордингов! В целом, если вы техпис — вы можете и сами разработать, но если у вас на это нет времени, можете воспользоваться нашим 😉

Хочу представить свою статью (моя первая!) на хабре об онбординге для команд. Там я рассказываю, какая у нас была задача, как мы её решали и к чему пришли. Там же лежит и сам шаблон онбординга, который вы можете забрать. Ну и парочка мемов, куда же без них 😅

Мой любимый мем в статье — со Шреком, он с двойным смыслом! Кто не понял, тот поймёт, как говорится)

https://habr.com/ru/companies/ozontech/articles/830842/

P.S.: если вам понравилась статья или шаблон, поставьте 1️⃣ на Хабре 🙈

#колонкаредактора
Please open Telegram to view this post
VIEW IN TELEGRAM
29🔥13👍54
30🔥19💯8👍1
Привет!

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

Вы недавно устроились в компанию, а лид через месяц уходит в отпуск — сейчас как раз лето, так что очень вероятный сценарий. Время паниковать? Нет! Время показать себя с лучшей стороны 💃

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

Убедитесь, что вы:

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

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

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

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

Выбор, как всегда, за вами 😉

#Выпуск 14
Please open Telegram to view this post
VIEW IN TELEGRAM
👍33🔥4🤝2🥰1
Всем привет!

Сегодня у нас не обычная #мемница, а интерактивная!

Собрала для вас предсказатель недели из наших мемов. Предсказания трактуйте по своему усмотрению 😏

Поставьте реакты, если вам такой интерактив понравился, или пишите в комментариях! Это своего рода проверка мемного видеоформата и небольшого интерактива.

Если вам больше по душе картинки, не переживайте — они вернутся уже на следующей неделе 😊
Please open Telegram to view this post
VIEW IN TELEGRAM
29👍3🔥2😁2
#колонкаредактора
Всем привет!
Найти работу на старте карьеры не так просто: хотят сразу опытных и умелых.

Почему некоторым компаниям не нужны джуны, или Метод скользящей средней

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

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

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

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

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

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

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

- Как же попасть в эту волшебную команду без новичков? И если туда не берут новичков, значит они все так и состарятся одним составом?

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

Знаете такие компании?
Please open Telegram to view this post
VIEW IN TELEGRAM
👍20❤‍🔥1🔥1🤩1
😁42🤣14👍3🤨2💋2
Привет!

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

Бывает так, что вы работаете-работаете, а люди в компании всё равно не понимают, кто вы, что делаете и зачем пристаёте с вопросами (или не пристаёте, а просто где-то отсвечиваете). И главное — не понимают, как вы можете им помочь написать хорошую и понятную документацию!

Как себя «прорекламировать»? Можно напомнить о себе или мозолить глаза! 😏

📌Напишите небольшую страничку о том, кто вы, чем можете быть полезны, как к вам обратиться и поставить задачу
📌Пишите о своей работе в командные чаты. Готовите релиз ноты? Напишите об этом! Выпустили документацию? Похвастайтесь! Заведите еженедельный/ежемесячный/ежеквартальный дайджест о своей работе. Пусть видят, чем вы занимаетесь, может, каждый для себя найдет какую-то пользу.
📌Если пишете пользовательскую документацию — дайджесты тоже помогут, но уже не разработчикам, а техподдержке или даже самим пользователям. Сделайте страницу с ежемесячными обновлениями документации.
📌И способ «со звездочкой» — начните ходить на командные встречи.
Что хорошего: вы будете больше погружены в продукт, знать, что делает команда, можете сразу всем задать вопросы о проектах. А ещё будете маячить у них перед глазами, напоминая о себе и документации.
Что плохого: если вы один техпис на несколько продуктов или команд, есть вероятность, что вы будете только и делать, что ходить на встречи. Но это тоже решаемо: выбираете один приоритетный/проблемный продукт/команду и начинаете внедряться только к ним. И так начинаете кочевать от команды к команде.

И ещё несколько способов из комментариев к прошлому посту!
📌 Залетайте на демо, если они есть в вашей компании. Там можно рассказать, кто вы и чем полезны.
Кстати, как вариант: если у вас есть коллеги-друзья, можно попросить их на таких встречах попиарить вас и вашу документацию.
📌 Если работаете в офисе — проставьтесь по окончанию испытательного срока. На пиццу могут слететься разные люди, заодно познакомитесь и расскажете о себе.
📌 Участвуйте во внутренних митапах! Тоже повышает видимость вас, техписателей в целом и документации.

В итоге о вашей работе будут знать, возможно, кто-то даже скажет «спасибо», но это неточно 😁

Расскажите в комментариях, как вы популяризируете документацию или пытались это делать 🙂

#Выпуск 15
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥238
😁76💯15😭61👍1
4😁52💯28👍6🔥3
Привет! 👋

Если вы работаете свою лучшую работу, но иногда вас настигает чувство, что вы делаете что-то не так или плохо — этот пост для вас.

Поговорим про «рабочую самооценку» — не синдром самозванца, хотя, наверное, он тут тоже затесался. Что делать, если вы вдруг почувствовали неуверенность в своих силах? Это может случиться на сложном проекте, после отпуска, от отсутствия отпуска, или просто потому, что так сложились звезды.

Что может помочь поднять «рабочую самоуверенность»?

📌 Обратная связь от коллег
Это могут быть как коллеги по цеху, если вы работаете в команде, так и коллеги-заказчики, если вы работаете один. Не стесняйтесь спрашивать ОС! Так вы узнаете, правда ли вы так плохи, как успели себе надумать (спойлер: нет).

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

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

Но где же найти друзей-техписателей?
📎 в сообществе техписателей или во флудилке — инвайты туда периодически кидают в чате;
📎 в тематических чатах для техписов;
📎 в каналах, которые ведут техписы, например, Катя Ушакова из Ozon тщательно собрала такие каналы в отдельной папке;
📎 на митапах и конференциях;
📎на работе! Да-да, коллеги тоже могут стать отличными друзьями, знаем не понаслышке 😏

Но что делать, если я интроверт?

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

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

Поделитесь в комментариях своими методами, которые помогают поднять рабочую самооценку 🙈

#выпуск 16
Please open Telegram to view this post
VIEW IN TELEGRAM
34👏9👍2🔥2👌1
😁51👏16💯2👍1🤗1
#анонс
Всем привет!
Соскучились по полезным докладам и крутым спикерам? Несём вам классную новость:

Завтра, 5 сентября, стартует DevFest 2024, и доклады в треке Documentation можно посмотреть онлайн бесплатно!

🔥Кто спикеры:
*️⃣Екатерина Чинкова, Ozon
*️⃣Ольга Каныгина, X5 Tech
*️⃣Татьяна Цикунова, МойСклад
и
*️⃣Семён Факторович😎

Присоединяйтесь к чату конференции, ссылку на трансляцию сбросят туда)
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥3351
🤣38👏6🥱1
😁536👻5
#какэтоработает

Всем привет! Сегодня поговорим об одном из самых популярных терминов в речи техписателей – docs-as-code.

Что такое docs-as-code?

🔆 Это подход к созданию документации, когда техписатели используют инструменты и практики разработки. По мнению documentat.io, docs-as-code подразумевает, что технические писатели выполняют хотя бы часть из указанных процессов:
– Пишут документацию в редакторах кода вроде VS Code и подобных.
– Используют языки разметки, например, Markdown или reStructureText.
– Хранят исходники в гите и используют его для совместной работы с файлами.
– Используют программные решения для “компиляции” документации – преобразования исходников в html-страницы. Такие инструменты называются SSG (Static Site Generator), чаще используется термин “генератор” или “сборщик”.
– Разворачивают документацию как приложения – с помощью так называемой технологии непрерывной интеграции и развёртывания (CI/CD).

Почему команды выбирают такое решение?

Аргументов “за” docs-as-code много. Рассмотрим три основных.

1️⃣ Первый, но не самый очевидный, – единый мир с продуктовой командой. Технические писатели, которые обычно отвечают за буквы и считаются гуманитариями, в этой парадигме полностью интегрируются в команду. Они неизбежно начинают разбираться в процессах разработки, лучше понимают разработчиков, а разработчики лучше понимают их.

2️⃣ Второй аргумент, самый веский – подход docs-as-code помогает создавать актуальную и полную документации за счёт самого процесса. Документация развивается и обновляется одновременно с продуктами.


3️⃣ Третий аргумент – гибкость решений и разгрузка команды, если используются генераторы. SSG, как правило, — это опенсорсные продукты с хорошей документацией и обширным сообществом. Благодаря этому технические писатели могут освоить инструмент самостоятельно и наладить сборку документации.

Если с инструментами разработки всё понятно, то что же значит “использовать практики разработки”? Об этом мы поговорим в следующем посте.

А пока давайте вспомним, какие же ещё плюсы у docs-as-code и какие недостатки?
❤‍🔥3110🔥2
😁64😭7
#какэтоработает
Всем привет! В прошлом посте мы поговорили о том, что же такое docs-as-code и почему команды выбирают именно его для создания документации.

Как создавать документацию с docs-as-code?

Допустим, мы уже переняли инструменты разработчиков: пишем документацию в markdown, используя VS Code, храним в гите, собираем генератором и поставляем в виде веб-ресурса. Но как использовать практики разработки?

Работа с документацией организована по аналогии с разработкой: одна функциональность – одна ветка в гите.

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

Для всего релиза тоже существует отдельная, релизная ветка, в которую мы сливаем все ветки-задачи, не удаляя исходные.

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

❗️ Если по какой-то причине техписатель поспешил и залил в релизную ветку лишнюю задачу, некорректная релизная ветка удаляется и собирается новая из веток-задач, которые мы предусмотрительно не удаляем.

🔆 Готово. К релизу продукта мы получаем релизную ветку, в которой содержатся описания всех фичей и доработок.

Это только одна из возможных схем работы. Каждая команда выбирает удобный для себя путь.
Please open Telegram to view this post
VIEW IN TELEGRAM
👍185🔥5
😁27💯22🤷3
Всем привет!

В этот четверг, 3 октября, в 19:00 по московскому времени пройдёт митап для технических писателей, организованный коллегами из X5 Tech.

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

0️⃣ Лютикова Александра из X5 Tech расскажет, как выжить в режиме аврала.
0️⃣ Александр Мачулин из Gram.ax поделится опытом, как они пытались автоматизировать проверки по стайлгайдам.
0️⃣ Акимова Юлия из Яндекс Маркета расскажет, почему дизайнер, UX-редактор и исследователь — единый организм.

1️⃣ Круглый стол «UX-исследования справки и интерфейсов» с коллегами из X5, Cloud.ru, Авито, Яндекс Маркета и Ozon.

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

#анонс
Please open Telegram to view this post
VIEW IN TELEGRAM
👍185
#такбывает
Всем привет!
Иногда полезно делиться своими ошибками, даже самыми глупыми, чтобы больше никто их не совершал. А ещё такие истории помогают коллегам избавиться от синдрома самозванца — люди ошибаются, так бывает)

Самая полезная (нет) запись встречи

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

Поэтому я (Лида) и решила записать очередную встречу с разработчиком. Но по какой-то причине мой микрофон был программно отключен. И запись получилась такая:

Я: ...
Разработчик: Привет, давай.
Я: ...
Разработчик: Да, верно.
Я: ...
Разработчик: Да.
Я: ...
Разработчик: Да, сейчас это так работает.
Я: ...
Разработчик: Верно.
Я: ...
Разработчик: Хорошо, давай тогда договоримся - во вторник дедлайн.


*Конец записи*

Проверяйте настройки перед записью)
😁50😢24👏9👍7🤝3