Давайте перепишем! – Telegram
Давайте перепишем!
811 subscribers
64 photos
3 videos
32 links
Пиши как техпис.
Рассказываем о буднях технических писателей, наших лайфхаках, болях и инсайтах.

Заглядывайте в закреплённые сообщения :-)
Download Telegram
Знаем, что многие очень ждут фотографии с Techdoc митапа 🙃
Наконец, можем поделиться ими. Заходите по ссылке, вспоминайте самые позитивные и интересные моменты и ищите себя 😊
🍾97👍4
Где искать вопросы для FAQ

Вот несколько очевидных и не очень источников вопросов для раздела «Вопросы и ответы».

Пройдите все сценарии как пользователь. В процессе фиксируйте возникающие вопросы и сомнения.

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

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

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

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

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

Есть еще идеи? Делитесь в комментариях.

#давайте_практику
👍1231🔥1
Как писать вопросы и ответы в FAQ. Вредные советы

Создаём раздел вопросов и ответов по вашему продукту, продолжаем тему.

Если вы хотите, чтобы читатель точно убежал со странички вопрос-ответов, сделайте вот что:

Пишите вопросы и ответы на маркетинговом языке. Конечно, ведь любой нормальный пользователь так и спрашивает — «Какие уникальные преимущества есть у вашего сервиса?»

Спрашивайте не как пользователь, а как адвокат на суде — «В какие сроки осуществляется возврат денежных средств по отмененным заказам?».

Пишите про пользователя в третьем лице, ему же будет приятно читать формулировки вроде «Пользователю нужно отправить заявку».

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

Задавайте закрытые вопросы, а отвечайте как на открытые, это же так логично. «Можно ли оплачивать заказ картой?» — «В нашем сервисе можно оплачивать заказы наличными, СБП, улыбкой, по QR-коду, стикером, картой, чеками и бонусами».

#давайте_практику
😁8👍5🔥1
Нам очень интересно узнать, кто наши подписчики :-) Расскажете в опросе и комментариях?
Anonymous Poll
79%
Я технический писатель
5%
Работаю в IT, но не техпис
11%
Работаю с текстами, но не техпис
5%
Другое
👍3
Давайте перепишем! pinned «Нам очень интересно узнать, кто наши подписчики :-) Расскажете в опросе и комментариях?»
Как понять, что скриншоты в инструкции не нужны?

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

Сложность интерфейса. Если он простой и неперегруженный, скрины скорее всего вообще не нужны.

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

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

А сколько скринов в ваших инструкциях?

#давайте_практику
👍91👌1
Ура! Питерские техписы теперь тоже могут попасть на профессиональное мероприятие. Если вы из Санкт-Петербурга, регистрируйтесь скорее) мы уверены, будет очень интересно😉

#давайте_анонс
🔥4👍1
Forwarded from Positive Writer's Day
⚡️Митап для редакторов и техписов в питерском офисе Positive Technologies!⚡️

Расскажем:
🔸Как начинающему лингвисту адаптироваться к работе в ИТ, ИБ и прочих аббревиатурах.
🔸Можно ли делать хорошие интерфейсные тексты без специальных UX-писателей и UX-редакторов.
🔸Как «сушить» многословные инструкции без потери качества и смысла.
🔸Что поможет редактору поправить текст достаточно хорошо при самом жестком дедлайне.

Покажем офис, познакомимся и поговорим. Напитки и угощения — будут!

Новости, обновления, задать вопрос — в канале митапа.

🎙 Хотите выступить, есть интересная тема?
Напишите в канале митапа, мы свяжемся с вами и все обсудим.

6 декабря, 15:00
Итальянская ул., д. 17


🔗 Регистрируйтесь заранее и приходите на встречу!

Количество мест ограничено, поэтому ❗️обязательно❗️ дождитесь подтверждения после регистрации.
С собой нужно будет взять ПАСПОРТ!

Будем вас ждать! ♥️

#куда_сходить_редактору
👍432
Удивительный мир заказчиков: заказчик неуловимый

Начинаем увлекательную рубрику #давайте_про_заказчиков. Был ли у вас заказчик, который всегда занят и долго не отвечает? Уверены, с таким заказчиком сталкивался хоть раз каждый, а если не сталкивался, обязательно столкнется.
Делимся своими лайфхаками взаимодействия с неуловимыми заказчиками и рассказываем, что может помочь до них достучаться:

Напоминайте о себе по разным каналам связям. Необязательно звонить в 2 часа ночи, достаточно написать в нескольких меcсенджерах.

Указывайте дедлайн для ответа. Заказчик будет знать, сколько у него есть времени на обратную связь. Да и дедлайн — отличная мотивация с ней не затягивать.

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

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

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

А что делаете вы, если ваш заказчик долго не отвечает?

#давайте_про_заказчиков
#давайте_лайфхак
5👍4🔥2
Не успели мы анонсировать один митап, как узнали еще про один, на этот раз в Москве и онлайн. Не можем не поделиться!

#давайте_анонс
7🔥1
Forwarded from Sergey Kulakov
#мероприятие #анонс #митап #знания #практики #инструменты

Всем привет 👋

Приглашаем на TechWriters Meetup №2 для технических писателей!

Дата: 14 ноября, 19:00 (сбор офлайн-участников с 18:30)
Формат: офлайн в доме Cloud․ru в Москве и трансляция онлайн

Программа:

🎤 Юлия Служаева, Старший технический писатель, Cloud․ru
Редполитика: как написать правила и не устроить бои без правил

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

🎤 Антон Литвинов, Ведущий технический писатель в редакции клиентской документации, SberDevices
Система метрик клиентской документации

🎤 Теодора Малевинская, Лид профессии «технический писатель», T-Bank
Частые ошибки техписателей в поиске работы

Для офлайн-участия зарегистрируйтесь по ссылке (обязательно укажите компанию и должность для заказа пропуска!)
Онлайн-трансляция будет в сообществе TeamSnack TechWriters, регистрироваться на онлайн не нужно.

До встречи!
11
💯

Кидайте свои мемчики о работе в комментарии 🙂

#давайте_мем
💯12🤣11🔥2
Когда таблица становится монстром

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

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

Вот несколько рекомендаций, чтобы таблица не превратилась в монстра:

Проверьте, что таблица помещается на странице по ширине — все столбцы видны.
Постарайтесь, чтобы столбцов было как можно меньше, так легче воспринимается информация. Например, в нашем примере можно объединить столбцы «Дни работы» и «Время работы» в один — «График работы».
Понятно назовите каждый столбец. Общее «Название» можно уточнить и сделать «Название склада».
Используйте в ячейках таблицы разные блоки, чтобы упростить и структурировать: абзацы, примечания, списки, каты и табы.
Если вы видите, что в ячейках повторяется одна и та же информация, попробуйте вынести ее из таблицы. Таблица станет «воздушнее».

В комментах покажем, как мы упростили таблицу, чтобы читателю она стала понятнее.

А встречали ли вы табличных монстров? Как боролись с ними? Расскажите о вашей практике!

#давайте_практику
👍14👏31
Дедлайн — вчера. Как выжить в режиме аврала

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

Хотите узнать про наш сценарий спасения?

1. Очистите календарь от лишних встреч, чтобы освободить время на работу.

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

3. Посчитайте, сколько примерно времени займет каждая задача.

4. Составьте план работы на каждый день недели.

5. Забронируйте время в своем календаре для работы над определенной задачей.

6. Оставляйте в графике свободные слоты на внезапные задачи.

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

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

Умейте говорить «нет». Если вы и так еле успеваете, а к вам приходят с просьбой сделать что-то еще, лучше откажитесь, объяснив причину своего отказа.

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

И, наконец, cнизьте градус перфекционизма. Пытаться объять необъятное и успеть вообще всё — прямой путь к неврозу и антидепрессантам. Неотложных дел в нашей жизни не так уж много. Весь мир может подождать, пока вы выдохнете, соберетесь с силами и выстроите свой план работы.

А что помогает вам в режиме аврала?

#давайте_лайфхак
👍12👏5🔥2
Обратиться в техписа

Насколько нам известно, в дипломе ни у одного из технических писателей не написано «Разработка технической документации». А что написано? Люди каких специальностей становятся техписами?

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

Впрочем в современном мире люди не всегда работают по специальности и часто по несколько раз меняют профессии на протяжении жизни. Из каких же профессий чаще приходят в техписы?

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

Отсюда и два направления; откуда перебраться в техписы проще всего:

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

🖌 Условные гуманитарии, имеющие опыт работы с текстами в другой сфере, — журналисты, копирайтеры, редакторы, методисты. Частый путь — переход из IT-журналиста или научного журналиста: у тебя уже есть навык разбираться в очень сложных темах и описывать их понятным языком для обычных людей. Но мы знаем и очень профессиональных техписов, которые раньше писали совсем другое — статьи о детском развитии или рекламные тексты.

Может, разделение на гуманитариев и технарей давно устарело? Или наша профессия — это место для тех людей, кто с детства не мог определиться, как в анекдоте, «к умным он или к красивым»?

А что написано у вас в дипломе и из какой профессии вы перешли в техписы? Было ли это сложно? Чему пришлось доучиться?

#давайте_про_профессию
👍10🔥53🤔1
Кат или не кат? Вот в чем вопрос

Кат? Спойлер? Или все-таки аккордеон? Блок текста, который раскрывается только по клику. В разных компаниях их называют по-разному. Сегодня хотим обсудить не название, а кейсы, когда этот способ отображения информации подходит.

Когда каты — хорошая идея

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

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

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

Для дополнительных скринов. Подробно разбирали это в посте ранее.

Когда нужно показать образец. Например, хотим показать как заполнить какой-то документ.

Но у катов есть достаточно серьезные недостатки, о которых точно нужно знать:

— В некоторых сервисах поиск по странице может не найти то, что спрятано под катом.

— Есть риск, что под катом окажется важная информация, а пользователь его не откроет и не прочитает.

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

А вы используете каты? По каким правилам решаете, прятать ли информацию под кат?

#давайте_практику
👍9🔥21
Все ещё считаете, что наша профессия — для интровертов? ;-)

#давайте_мем
😁22💯7👍5👎1