кто успел — тот посмотрел)

кто не успел — ждём пока статью немного поправят и вернут 🤔

Понедельник! 👨‍💻

И у меня есть для вас видео:

Is Success Luck or Hard Work?

тема из подборки моих любимых на поспорить 😈

Как считаете — существует ли удача в принципе?

#monday_link

#анонс

Techdoc Meetup 2
28 сентября онлайн и офлайн

Расскажем о стайлгайдах, поговорим о роли техписателя в продуктовых компаниях 🐸

Регистрируйтесь, присылайте вопросы в тред, приходите в Москве 🐸

Моё мнение, что доля неопределённости в мире определённо существует. И что в какой-то момент какие-то обстоятельства могут "удачно сложиться".

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

Ещё я уверена, что если человек не готов, то никакие случайности ему не помогут в долгой перспективе.

И ещё факт, что люди склонны возводить воздушные замки и не замечать слона в комнате.

Поэтому и ценны те, кто научился адаптировать свой опыт под новые обстоятельства и разворачивать ситуацию "удачной" стороной 🍀

🎩 Архетипы Таро в технической документации

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

😋 Архетипы карт Таро помогают уловить эмоциональную составляющую информации и создать связь с читателем

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

😋 Использование символов и образов из мира карт Таро может сделать документацию более запоминающейся

😋 Архетипы карт Таро могут помочь структурировать информацию и упростить её восприятие

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


✋ Сделайте документацию эмоционально привлекательной

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

😍 Аркан Маг

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


✋ Используйте примеры, основанные на архетипах

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

🃏 Аркан Башня

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


✋ Сделайте документацию запоминающейся

Добавление изображений с символами и образами из мира карт Таро может помочь читателю запомнить информацию и лучше усвоить её.

🃏 Иллюстрации с картами Таро

Добавьте в документацию иллюстрации карт Таро, которые иллюстрируют ключевые концепции или шаги. Это поможет читателю лучше усвоить информацию и в последующем легче вспомнить её.


#sponsored_by_AI


Как вам идея?) уже ставите тикет на своего техписателя? 🧿

сам пост полезной нагрузки не несёт смело скипайте

Больше полезного о документации — сегодня на Стачке и 28 сентября на Techdoc Meetup 2


Сегодня рассказываю очень базовые вещи о документации — что такое, какая бывает, как пишется 🍄

На техдоке Арина расскажет об атрибутах: стайлгайдах, глоссариях, ToV и шаблонах 🍄

Да и в целом сезон конференций открыт, следите за анонсами, задавайте свои вопросы в тредах 🍄

#monday_link

дождливый Lofi с лягушкой 🐸

хорошей недели 🐸

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

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

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

Ретро можно поделить на 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