Включаем креатив — что произойдёт, если пользователь нажмет загадочную кнопку «20 мин»? 🤯😁
#давайте_фейл
#давайте_фейл
😁15🤯7👍2
Тайна за семью печатями:
заказчик-конспиратор
Иногда сбор информации по задаче похож на сложную шахматную партию. Особенно, если вам попался заказчик-конспиратор, который неохотно отвечает на вопросы и думает, что все и так очевидно. «Зачем что-то писать, все и так понятно», — знакомо? Мы сталкивались с такой ситуацией неоднократно и выработали свою стратегию взаимодействия.
Делимся советами:
✅ Заранее готовьте список вопросов. При этом используйте больше открытых вопросов, которые требуют развернутого ответа и на которые нельзя ответить односложно «да» или «нет».
✅ Общайтесь лично, так гораздо легче разговорить своего конспиратора и растопить лед молчания.
✅ Не ленитесь и объясняйте заказчику, зачем вам, а в конечном счете, и пользователю нужна эта информация.
✅ Ищите другие источники. Пройдите путь пользователя. Читайте все бизнес-требования, которые как-то касаются вашей задачи. Общайтесь со всеми, кто связан с ее реализацией: дизайнерами, аналитиками, разработчиками, тестировщиками.
Чего точно делать нельзя? Это ограничиваться своим таинственным заказчиком и той скудной информацией, которую удалось из него вытащить. А какие лайфхаки используете вы с заказчиками-конспираторами?
#давайте_лайфхак
#давайте_про_заказчиков
заказчик-конспиратор
Иногда сбор информации по задаче похож на сложную шахматную партию. Особенно, если вам попался заказчик-конспиратор, который неохотно отвечает на вопросы и думает, что все и так очевидно. «Зачем что-то писать, все и так понятно», — знакомо? Мы сталкивались с такой ситуацией неоднократно и выработали свою стратегию взаимодействия.
Делимся советами:
✅ Заранее готовьте список вопросов. При этом используйте больше открытых вопросов, которые требуют развернутого ответа и на которые нельзя ответить односложно «да» или «нет».
✅ Общайтесь лично, так гораздо легче разговорить своего конспиратора и растопить лед молчания.
✅ Не ленитесь и объясняйте заказчику, зачем вам, а в конечном счете, и пользователю нужна эта информация.
✅ Ищите другие источники. Пройдите путь пользователя. Читайте все бизнес-требования, которые как-то касаются вашей задачи. Общайтесь со всеми, кто связан с ее реализацией: дизайнерами, аналитиками, разработчиками, тестировщиками.
Чего точно делать нельзя? Это ограничиваться своим таинственным заказчиком и той скудной информацией, которую удалось из него вытащить. А какие лайфхаки используете вы с заказчиками-конспираторами?
#давайте_лайфхак
#давайте_про_заказчиков
✍9👍4🔥4
Сегодня двое наших авторов расскажут на конференции о том, как и зачем создавалась Школа технических писателей и почему учатся там вовсе не техписы.
🔥9✍2👍2
Forwarded from TechWriter Days Channel (ПК SQA AD TWD)
Анастасия Московкина, Екатерина Горбунова
Как улучшить тексты компании через внутреннюю школу технических писателей
Начало доклада 17:10
https://techwriterdays.ru/ru/talk/124431
Задайте вопросы спикерам в комментариях👇
И не забудьте оставить обратную связь по докладу в комментариях👇
#SectionD #Day1
Как улучшить тексты компании через внутреннюю школу технических писателей
Начало доклада 17:10
https://techwriterdays.ru/ru/talk/124431
Задайте вопросы спикерам в комментариях👇
И не забудьте оставить обратную связь по докладу в комментариях👇
#SectionD #Day1
🔥9✍5❤3👍1
А сегодня на Techwriter days выступают ещё два наших автора!
В 11:00 в секции B Катя Касаткина расскажет, как оценить, насколько хорош ваш текст. Примеры, чек-листы, лайфхаки — концентрация пользы!
А в 16:00 в секции C Женя Береснева расскажет про инструкции... Инструкции к нам самим, техническим писателям. Покажем, что внутри этого документа, и как он улучшил жизнь наших техписов и их заказчиков.
Приходите! За лучшие вопросы у нас тоже кое-что есть ;-)
В 11:00 в секции B Катя Касаткина расскажет, как оценить, насколько хорош ваш текст. Примеры, чек-листы, лайфхаки — концентрация пользы!
А в 16:00 в секции C Женя Береснева расскажет про инструкции... Инструкции к нам самим, техническим писателям. Покажем, что внутри этого документа, и как он улучшил жизнь наших техписов и их заказчиков.
Приходите! За лучшие вопросы у нас тоже кое-что есть ;-)
🔥22👍4✍3
Это организационный пост с навигацией по каналу, который теперь всегда будет в закрепе.
Наш канал о техническом писательстве, но мы думаем, что многие посты будут полезны и представителям других профессий, кто работает с текстами.
Познакомиться с авторами и рассказать о себе можно в посте-знакомстве. Не смотрите, что он вышел давно, расскажите о себе в нем — мы сами и новые читатели регулярно заглядывают в его комментарии!
Постов на канале набралось уже довольно много, но по ним легко ориентироваться по тегам. Нажмите на любой, чтобы посмотреть все посты по теме.
#давайте_практику — разные how to и разборы кейсов
#давайте_про_процессы — о взаимодействии в командах и с заказчиками
#давайте_про_заказчиков — целый сериал про разные типажи заказчиков и как с ними быть
#давайте_про_профессию — общие размышления о нашей профессии и ее границах
#давайте_лайфхак — приемчики по работе с текстом и выстраиванию рабочих процессов
#давайте_про_стайлгайд — создание и работа со стайлгайдом
#давайте_про_инструменты — всё об инструментах и стеке технического писателя
#давайте_анонс — мероприятия для техписов
#давайте_мем — смеемся надо всем, что происходит в нашей работе
Есть вопросы? Пишите в комментарии под этим постом. Комментарии и дискуссии мы, вообще, очень любим 😉
Наш канал о техническом писательстве, но мы думаем, что многие посты будут полезны и представителям других профессий, кто работает с текстами.
Познакомиться с авторами и рассказать о себе можно в посте-знакомстве. Не смотрите, что он вышел давно, расскажите о себе в нем — мы сами и новые читатели регулярно заглядывают в его комментарии!
Постов на канале набралось уже довольно много, но по ним легко ориентироваться по тегам. Нажмите на любой, чтобы посмотреть все посты по теме.
#давайте_практику — разные how to и разборы кейсов
#давайте_про_процессы — о взаимодействии в командах и с заказчиками
#давайте_про_заказчиков — целый сериал про разные типажи заказчиков и как с ними быть
#давайте_про_профессию — общие размышления о нашей профессии и ее границах
#давайте_лайфхак — приемчики по работе с текстом и выстраиванию рабочих процессов
#давайте_про_стайлгайд — создание и работа со стайлгайдом
#давайте_про_инструменты — всё об инструментах и стеке технического писателя
#давайте_анонс — мероприятия для техписов
#давайте_мем — смеемся надо всем, что происходит в нашей работе
Есть вопросы? Пишите в комментарии под этим постом. Комментарии и дискуссии мы, вообще, очень любим 😉
👍6🔥5🤝5❤1
Давайте перепишем! pinned «Это организационный пост с навигацией по каналу, который теперь всегда будет в закрепе. Наш канал о техническом писательстве, но мы думаем, что многие посты будут полезны и представителям других профессий, кто работает с текстами. Познакомиться с авторами…»
«Вы ошиблись дверью»
Приходит как-то к лиду техписов руководитель команды разработки и говорит: «Мы поняли, что нам в команду нужен технический писатель! У нас большая команда и через день мы проводим встречи, где распределяем задачи и принимаем другие решения. Кто-то должен оформлять итоги этих встреч в красивые и удобные протоколы!».
Реальная история из одной крупной IT-компании. Конечно, лид техписов ответил, что потенциальный заказчик ошибся дверью.
Чтобы такого не случалось, заранее договоритесь внутри команды, какие документы берутся писать техписы, а какие — не ваша зона ответственности.
Для каждой компании этот список будет разным, но мы рекомендуем разделить его на три части:
🟢«Зеленая зона»: эти документы мы не просто пишем, а пишем именно мы, никто лучше нас это не сделает. Например, инструкции пользователя.
🟡«Желтая зона»: документы, за которые мы можем взяться при определенных условиях. Если заказчику нужно что-то из этого списка, мы можем поговорить об этом и найти решение. Например, новостную рассылку для пользователей техпис писать может, если у него есть похожий опыт и он достаточно погружен в продукт, а внутренний нормативный документ возьмется писать только совместно с методологом.
🔴 «Красная зона»: эти документы — не наша сфера ответственности, даже не приходите к нам с такими запросами. Например, в компании, для которой мы составляли этот список, в этой зоне технические спецификации — техписы за них не берутся.
На картинке показали примеры документов, которые могут быть в каждой зоне. У вас будет другой список, но разделение на три зоны — удобная практика.
Опубликовать список можно где-то на внутренних ресурсах, и нерелевантных запросов станет сильно меньше.
#давайте_про_процессы
Приходит как-то к лиду техписов руководитель команды разработки и говорит: «Мы поняли, что нам в команду нужен технический писатель! У нас большая команда и через день мы проводим встречи, где распределяем задачи и принимаем другие решения. Кто-то должен оформлять итоги этих встреч в красивые и удобные протоколы!».
Реальная история из одной крупной IT-компании. Конечно, лид техписов ответил, что потенциальный заказчик ошибся дверью.
Чтобы такого не случалось, заранее договоритесь внутри команды, какие документы берутся писать техписы, а какие — не ваша зона ответственности.
Для каждой компании этот список будет разным, но мы рекомендуем разделить его на три части:
🟢«Зеленая зона»: эти документы мы не просто пишем, а пишем именно мы, никто лучше нас это не сделает. Например, инструкции пользователя.
🟡«Желтая зона»: документы, за которые мы можем взяться при определенных условиях. Если заказчику нужно что-то из этого списка, мы можем поговорить об этом и найти решение. Например, новостную рассылку для пользователей техпис писать может, если у него есть похожий опыт и он достаточно погружен в продукт, а внутренний нормативный документ возьмется писать только совместно с методологом.
На картинке показали примеры документов, которые могут быть в каждой зоне. У вас будет другой список, но разделение на три зоны — удобная практика.
Опубликовать список можно где-то на внутренних ресурсах, и нерелевантных запросов станет сильно меньше.
#давайте_про_процессы
Please open Telegram to view this post
VIEW IN TELEGRAM
👍27🔥9❤3✍2
Страдаете ли вы от того, что с клавиатуры невозможно написать некоторые очень нужные техпису символы? Например, длинное тире (—), стрелочки (→) или кавычки-ёлочки «». Мы да. И все решаем эту проблему по-разному... Некоторые, например, держат под рукой текстовый файл, откуда копируют эти символы.
Наш коллега и автор канала Parawriter Антон Гафаров сделал классную штуку! Специальную техписовскую раскладку для клавиатуры 🎉
Установите ее и вводите нужные символы удобным сочетанием клавиш.
Установочный пакет выложен на github. Там же в readme все инструкции.
Антон просит всех, кто использует его наработку, отписаться в посте, там же можно задать вопросы.
А от нас — огромное спасибо :-)
#давайте_лайфхак
Наш коллега и автор канала Parawriter Антон Гафаров сделал классную штуку! Специальную техписовскую раскладку для клавиатуры 🎉
Установите ее и вводите нужные символы удобным сочетанием клавиш.
Установочный пакет выложен на github. Там же в readme все инструкции.
Антон просит всех, кто использует его наработку, отписаться в посте, там же можно задать вопросы.
А от нас — огромное спасибо :-)
#давайте_лайфхак
❤20🔥12👍2
Страшный сон технического писателя
В одной из известных компаний был такой фейл: технический писатель проверял, как работает функционал для обращения в поддержку, и сделал скрин для инструкции.
Казалось бы, что может пойти не так?
А оказалось, что проверял он в собственном личном кабинете и не заметил, как на скрине остались его собственные персональные данные.
И спустя пару дней ему начали звонить как сотруднику поддержки. А сервис был на многомилионную аудиторию 🙈
Хорошо, что вовремя нашли источник бед и заблюрили данные.
Какие ещё есть варианты не светить данными:
✅ Вообще их убрать со скринов. Но это не всегда возможно. Например, если нужно показать пример заполненной формы.
✅ Использовать специальный аккаунт. Наверняка же у вас есть аккаунт Иванова Ивана Ивановича? 😉
✅ Отказаться от скринов. Нам он нравится больше всего, но бывают, к сожалению, ситуации, где без них никак.
P. S. Очень интересный вариант с номером телефона придумали коллеги из билайн. Можете послушать в их докладе на митапе примерно с 1:50:00.
#давайте_практику
В одной из известных компаний был такой фейл: технический писатель проверял, как работает функционал для обращения в поддержку, и сделал скрин для инструкции.
Казалось бы, что может пойти не так?
А оказалось, что проверял он в собственном личном кабинете и не заметил, как на скрине остались его собственные персональные данные.
И спустя пару дней ему начали звонить как сотруднику поддержки. А сервис был на многомилионную аудиторию 🙈
Хорошо, что вовремя нашли источник бед и заблюрили данные.
Какие ещё есть варианты не светить данными:
✅ Вообще их убрать со скринов. Но это не всегда возможно. Например, если нужно показать пример заполненной формы.
✅ Использовать специальный аккаунт. Наверняка же у вас есть аккаунт Иванова Ивана Ивановича? 😉
✅ Отказаться от скринов. Нам он нравится больше всего, но бывают, к сожалению, ситуации, где без них никак.
P. S. Очень интересный вариант с номером телефона придумали коллеги из билайн. Можете послушать в их докладе на митапе примерно с 1:50:00.
#давайте_практику
🔥11👍4🤣3
А как вы прячете персональные данные на скринах?
Anonymous Poll
68%
Закрываем/заблюриваем
12%
Обрезаем
40%
У нас есть специальный Иван Иваныч
4%
Другой вариант (расскажу в комментариях)
9%
Обходимся без скринов
Давайте перепишем… под целевую аудиторию
«Кому это нужно?» — спросите себя перед тем, как начать писать документ. Если пользователям, то каким? Что они уже знают и что нового вы хотите рассказать? Держите в голове ответы на эти вопросы — так вы сможете сделать документ полезнее и понятнее.
Предположим, у вас продвинутые пользователи, которые точно знакомы с установкой приложений. Тогда достаточно просто дать ссылку и обозначить основные шаги, не отвлекая на лишние детали. Например так:
Пусть вы потратите больше времени на документ, а пользователи — на чтение, зато в итоге у них всё получится без обращений в гугл и поддержку, без сомнений и недовольства. А это всегда хорошо для продукта и для компании.
Поделитесь, для кого чаще пишете? И для кого больше нравится?
#давайте_практику
«Кому это нужно?» — спросите себя перед тем, как начать писать документ. Если пользователям, то каким? Что они уже знают и что нового вы хотите рассказать? Держите в голове ответы на эти вопросы — так вы сможете сделать документ полезнее и понятнее.
Предположим, у вас продвинутые пользователи, которые точно знакомы с установкой приложений. Тогда достаточно просто дать ссылку и обозначить основные шаги, не отвлекая на лишние детали. Например так:
Установите приложениеА если пользователи неопытные, то уже на первом шаге возникнут вопросы. Как запустить файл, что за место установки и какие опции нужно выбрать? Таким пользователям нужна более подробная инструкция, например как эта:
1. Скачайте и запустите установочный файл.
2. Выберите место и опции установки.
3. Примите лицензионное соглашение.
4. Нажмите Установить.
Установите приложение
1. Скачайте файл — он будет сохранен на вашем компьютере в папке загрузок по умолчанию.
2. Нажмите на файл правой кнопкой мыши и выберите Запустить.
3. Укажите папку, в которой будут храниться все данные приложения, и нажмите Далее.
4. Выберите язык приложения и нажмите Далее.
5. Прочитайте и примите лицензионное соглашение — нажмите Согласен.
6. Нажмите Установить — начнется установка приложения на ваш компьютер.
7. После окончания установки нажмите:
• Запустить, чтобы начать работу с приложением;
• Закрыть, чтобы закрыть программу установки.
Пусть вы потратите больше времени на документ, а пользователи — на чтение, зато в итоге у них всё получится без обращений в гугл и поддержку, без сомнений и недовольства. А это всегда хорошо для продукта и для компании.
Поделитесь, для кого чаще пишете? И для кого больше нравится?
#давайте_практику
👍16✍5🔥4
Как общаться с заказчиками: метод «Приоткрытая дверь»
Продолжаем рубрику #давайте_про_заказчиков, но теперь посмотрим со стороны коммуникации с ними.
Общение с заказчиком, особенно на этапе согласования документа, похоже на ведение переговоров. Чтобы отстоять свою точку зрения, можно использовать методы и тактики ведения переговоров, немного адаптировав их под нашу специфику.
Используя в переговорах метод «Приоткрытая дверь», вы сначала просите людей выполнить незначительную просьбу, затем они охотнее соглашаются сделать для вас и нечто большее.
В случае общения с заказчиком можно сначала договориться о короткой встрече или попросить ответить на пару вопросов по почте или в чате, а затем уже назначить более длительную встречу.
Такой метод хорошо с работает с типами заказчиков: неуловимый и перфекционист.
#давайте_про_заказчиков
#давайте_лайфхак
Продолжаем рубрику #давайте_про_заказчиков, но теперь посмотрим со стороны коммуникации с ними.
Общение с заказчиком, особенно на этапе согласования документа, похоже на ведение переговоров. Чтобы отстоять свою точку зрения, можно использовать методы и тактики ведения переговоров, немного адаптировав их под нашу специфику.
Используя в переговорах метод «Приоткрытая дверь», вы сначала просите людей выполнить незначительную просьбу, затем они охотнее соглашаются сделать для вас и нечто большее.
В случае общения с заказчиком можно сначала договориться о короткой встрече или попросить ответить на пару вопросов по почте или в чате, а затем уже назначить более длительную встречу.
Такой метод хорошо с работает с типами заказчиков: неуловимый и перфекционист.
#давайте_про_заказчиков
#давайте_лайфхак
✍7👍5🔥3
Друзья, расскажите нам, что вам интересно, о чем писать больше. Можно выбирать несколько вариантов.
Anonymous Poll
40%
Текст: как писать понятно, коротко, грамотно
38%
Профессия: границы ответственности, специализации, скиллы
15%
Взаимодействие с заказчиками, переговоры
47%
Стайлгайды, шаблоны и другая методология
25%
Найм, собеседования, тестовые, онбординг
65%
Инструменты и стек техписа, автоматизация и ИИ
18%
Как войти в профессию, чему и где учиться
49%
Разбор кейсов из практики
36%
Мемчики о нашей работе
1%
Свой вариант (расскажу в комментариях)
👍3🔥2👌1
Поговорим о качестве?
Главные критерии качества текста — польза, актуальность и полнота. Если инструкция бесполезна, неактуальна или недостаточна, то не имеет значения, как вы ее оформите и как сформулируете, — все придется переделать. Работа над этими критериями занимает больше всего времени, и оценить их сложнее всего. Делимся с вами нашими лайфхаками!
Как понять, полезен ли читателю текст? Поставьте себя на его место и подумайте, как он будет пользоваться продуктом, какие задачи будет решать. И пишите только о том, что важно.
Пропускайте через сито пользы каждое слово: нужно ли это пользователю, будет ли он это применять? Всё, что можно убрать без потери смысла, нужно убрать, тогда в итоге останется чистая польза.
Например, пользователю не важно знать, как технически устроена отправка сообщений, но важно знать, как заполнить форму, чтобы сообщение точно отправилось.
Актуальность тоже можно проверить с позиции пользователя: сравните то, что написано, с тем, что вы видите. Если всё на местах и все действия можно выполнить, то можно двигаться дальше.
Чтобы проверить полноту инструкции, пройдите по пути пользователя и посмотрите по сторонам: что еще ему может понадобиться? Может, дать ссылки на ресурсы, добавить шаги, указать требования к файлам или более детально описать процесс? Сделайте всё, чтобы пользователь мог решить свою задачу здесь и сейчас.
Особое внимание уделите внешним процессам: если пользователю нужно что-то сделать вне продукта, облегчите его путь максимально. Нужно отправить документы? Расскажите, в каком формате, куда, как именно. Пользователь все равно задаст себе эти вопросы, так что лучше заранее дать на них ответы.
На сегодня, пожалуй, всё!
А как научиться предвидеть вопросы пользователя, расскажем в следующей серии рубрики #давайте_лайфхак )
Главные критерии качества текста — польза, актуальность и полнота. Если инструкция бесполезна, неактуальна или недостаточна, то не имеет значения, как вы ее оформите и как сформулируете, — все придется переделать. Работа над этими критериями занимает больше всего времени, и оценить их сложнее всего. Делимся с вами нашими лайфхаками!
Как понять, полезен ли читателю текст? Поставьте себя на его место и подумайте, как он будет пользоваться продуктом, какие задачи будет решать. И пишите только о том, что важно.
Пропускайте через сито пользы каждое слово: нужно ли это пользователю, будет ли он это применять? Всё, что можно убрать без потери смысла, нужно убрать, тогда в итоге останется чистая польза.
Например, пользователю не важно знать, как технически устроена отправка сообщений, но важно знать, как заполнить форму, чтобы сообщение точно отправилось.
Актуальность тоже можно проверить с позиции пользователя: сравните то, что написано, с тем, что вы видите. Если всё на местах и все действия можно выполнить, то можно двигаться дальше.
Чтобы проверить полноту инструкции, пройдите по пути пользователя и посмотрите по сторонам: что еще ему может понадобиться? Может, дать ссылки на ресурсы, добавить шаги, указать требования к файлам или более детально описать процесс? Сделайте всё, чтобы пользователь мог решить свою задачу здесь и сейчас.
Особое внимание уделите внешним процессам: если пользователю нужно что-то сделать вне продукта, облегчите его путь максимально. Нужно отправить документы? Расскажите, в каком формате, куда, как именно. Пользователь все равно задаст себе эти вопросы, так что лучше заранее дать на них ответы.
На сегодня, пожалуй, всё!
А как научиться предвидеть вопросы пользователя, расскажем в следующей серии рубрики #давайте_лайфхак )
❤15👍4✍3