Medium опять заблокировали

Сколько не пыталась на что-то другое перейти ради лонгридов — он всё же оставался самым привычным и приятным. Иех.


Всё равно планировала делиться статьёй с Хабра 🐈

D&D как инструмент тимлида: решаем проблемы команды с помощью разговорных ролевых игр

Всегда очень скептически отношусь к таким методам, потому что часто найдётся один ворчун и всё испортит и часто этот ворчун — я 🐈

#monday_link

Напоминаю, что у нас сегодня митап 😎

запись будет доступна по ссылке, которую вам пришлют после регистрации на мероприятие, поэтому жамк 😭

Стайлгайд и как его делать

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

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

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

Как составить стайлгайд

🐻 Определите свою целевую аудиторию и то, что она хочет получать от вашей компании в текстах.

⭐️ Определите ваш бренд и то, что вы хотите передать через него.

👩‍🎨 Составьте документ с описанием всех правил оформления текстов, шрифтов, цветов, логотипов и других элементов дизайна.

🔄 Удостоверьтесь, что документ выполняется вашей командой и ваши действительно подходят на случай изменений в будущем.

#sponsored_by_AI

Подборка лучших книг по техписательству на 2023 год

Но все на английском и ни одной по ГОСТам)
Многие проповедуют продуктовый подход к доке, часть именно о языке [английском], поэтому не всё актуально для наших реалий, но всё равно стоит ознакомиться, если вы пишете документацию 🧑‍🎓

*все очень базовые, поэтому особенно рекомендую, если только вкатываетесь в техписательство

#monday_link

С международным днём йоги 😑

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

Если вы уже потренили — держите лапу кота и продолжайте в том же духе 🐾

5 шагов для публикации доки

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

Шаг 1: Спланируйте свою документацию

Перед тем, как начать писать, ответьте на вопросы:
• кто ваш читатель?
• что вы хотите до него донести?
Помните, что не у всех пользователей одинаковый уровень знаний — не следует предполагать, что читатель всегда знает, о чём вы говорите.

Шаг 2: Структурируйте свой материал

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

Шаг 3: Напишите текст

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

Шаг 4: Просмотрите и исправьте ошибки

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

Шаг 5: Опубликуйте документацию

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

🐈🐈🐈
#sponsored_by_AI

«Правильные JIRA issues». Как правильно разбивать задачи на тикеты

Статья на habr о личном опыте автора с тикетами в Jira

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

#monday_link

Что такое #sponsored_by_AI ?

Вообще это немного трёхэтажный процесс постинга всяких текстов 😥

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

Не всегда до «хорошего текста», стараюсь убить в себе перфекциониста из-за которого в принципе ничего не пишется 😐

Вот и получается, что AI как бы даёт основу текста => спонсирует мои полезные лонгриды 🐱

«Давай скрины добавим, ещё и стрелочками-циферками украсим всякими, чтобы пользователю понятнее было. О, и напишем инструкцию сразу на скрине»

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

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

А если вы переводите доку на несколько языков — умножайте стоимость одного скрина на количество локалей. И ещё на полтора.

Вместо скриншотов лучше рисовать схемы или делать гифки. Но тоже только для своих сервисов!

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

Если вы все же решили использовать скриншоты

😮 убедитесь, что они соответствуют версии приложения или сайта, которую _используют_ пользователи.
😮 помните о том, что разные устройства могут выглядеть по-разному.
😮 сразу заложите в свои процессы аудит скриншотов через какой-то период времени.
😮 зафиксируйте правила оформления скринов: цвет и толщина выделения; допускаются ли надписи/стрелочки/циферки вообще; в каких сценариях нужны скрины, а где — категорическое нет.

Внимательно оцените все риски и преимущества использования скриншотов. Помните, что ваша главная цель — помочь пользователям, а не запутать их еще больше 😤

#sponsored_by_AI

На прошлой неделе ездили с коллегами на STL Conf — двухдневную конференцию для тимлидов. Хотя доклады там на совсем разные темы)

Посмотреть прошлые выступления на YouTube

Из моих любимых спикеров:

💻 Кирилл Анастасин о публичных выступлениях и личном бренде
💻 Анастасия Абрашитова о специфике работы лидом во внутренней разработке
💻 Юлия Белозерова о выгорании и его проживании

и там ещё миллион всего — смотрите записи и приезжайте на следующие конференции ✨

🐤 База, которую надо знать перед тем, как задуматься о становлении лидом

1. Цель. Процесс непрерывного совершенствования

2. Платформы и экосистемы

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

4. Настольная книга project-менеджера. Что нужно знать, чтобы управлять IT, digital и другими проектами с учетом российских реалий

⭐️ В начале лидского пути, скорее всего до формального повышения

5. Мама, я тимлид

6. Как пасти котов. Наставление для программистов, руководящих другими программистами

7. 45 татуировок менеджера. Правила российского руководителя

8. Без обид! Как эмоциональный интеллект помогает общаться с коллегами и руководством

🔔 Для прокачки лидских навыков, когда 1-1 с командой проходит уже без потных ладошек

9. Радикальная прямота. Как управлять людьми, не теряя человечности

10. Сложные подчиненные. Практика российских руководителей

11. Все начальники делают это. Пошаговое руководство по решению (почти) всех проблем менеджера

12. Секреты фасилитации. SMART-руководство по работе с группами


//все ссылки — на litres.ru с дополнительной скидкой 10%

Целевая аудитория и цель статьи

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

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

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

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

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

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

👑 И вдогонку — практическая статья о персонах в документации

#sponsored_by_AI

☕️ О чем писать на сайте, если хочешь нормальный текст, а не «Мы молодая динамично развивающаяся компания»

Статья на vc.ru от руководителя агентства «Сделаем» — ребята делают классные тексты так и ещё и объясняют, почему какой-то текст классный, а какой-то — не очень.

В статье хорошо прошлись по базовым принципам. Касается не только текста о компании, но и в целом текстов хоть статьи, хоть блога 📝

#monday_link

Управление конфликтами

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

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

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

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

📞 Ключевой аспект управления конфликтами — коммуникация. Важно создать открытую атмосферу, в которой каждый участник команды может выразить своё мнение и почувствовать, что его точка зрения принимается во внимание. Умение слушать, выражать свои мысли чётко и конструктивная критика помогают снять напряжение и найти взаимоприемлемое решение.

😊 Не забывайте о значимости эмпатии. Умение поставить себя на место других участников команды поможет лучше понять их потребности и причины их действий. Эмпатия способствует снижению конфликтов и повышению взаимопонимания в команде.

#sponsored_by_AI

🔉 need your opinion 🔉

Ссылки на что вы бы хотели видеть по понедельникам? Думаю переключиться со статей на какие-то видео: на какие? Стоит ли?
Что вообще смотрите вне телеги? Какие ресурсы, какие темы?

Очередное продуктивное приложение с одной стороны

С другой — нетривиальная идея и статья о продуктовом процессе за этим приложением

Что понравилось

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

#monday_link

Пока подаю заявки на конференции и жду в себе смелости анонсировать те, куда меня уже приняли, держите инструкцию по подготовке докладов 🐈‍⬛


1. Прикинуть аудиторию и основной посыл своего доклада: что хотелось бы донести и до кого.

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

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

🐈‍⬛ 4. Пойти и об кого-то подумать пункты 1 и 3. Внести правки, вывести окончательную тему и структуру.

5. Наполнить презентацию "мясом" — текстом, графиками, мемасиками etc. Это всё ещё черновой этап, не пытайтесь сделать всё.

6. Рассказать сами себе, можно записать на видео. Например, как сделал Кирилл Анастасин. Пересматривать необязательно, все проплешины всплывут в процессе.

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

🐈‍⬛ 8. Внести финальные доработки, отрепетировать ещё пару раз перед зеркалом.

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


🐈‍⬛ Лайфхак: можно отдельные куски доклада прогонять на командных созвонах. И коллегам что-то полезное расскажете, и мнения услышите.

🐈‍⬛ Варнинг: слишком много мнений тоже вредно, ищите свою золотую середину в каждом пункте

Привет! Довольно много людей подписалось в последние недели, поэтому

Привет, я Катя 🐸

Скорее всего мы познакомились на обучении ЦЕХ или вы слушали подкаст в Техпис Говорит 🐸

Или же мы увидимся на Стачке 15-16 сентября и поговорим о документации лично 🐸

В любом случае — если есть что-то, чем я могу быть полезна — может, вы давно хотели узнать больше о техписателях, управлении командами, яхтинге, корейском языке, поездках или чём угодно другом — пишите в комментарии или в личные сообщения 🐸



🐸 Самые популярные посты so far 🐸

Подборка книг для тимлидов

Почему со скринами в доке надо осторожно

Как стать хорошим техписателем

Подборка базовых материалов для текстоделов

Насмотренность

Одно из важнейших качеств хорошего писателя — насмотренность на тексты

😵‍💫Насмотренность — это способность внимательно и с интересом изучать разнообразные тексты. Это может быть всё что угодно: книги, статьи, блоги, рекламные листовки — главное, чтобы мы могли увидеть, что в них хорошо, а что — не очень.

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

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

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

🤤 Поэтому, если вы хотите стать более эффективным в письме, не забывайте тренировать свою насмотренность:

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

#sponsored_by_AI