Это организационный пост с навигацией по каналу, который теперь всегда будет в закрепе.

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

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

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

#давайте_практику — разные how to и разборы кейсов
#давайте_про_процессы — о взаимодействии в командах и с заказчиками
#давайте_про_заказчиков — целый сериал про разные типажи заказчиков и как с ними быть
#давайте_про_профессию — общие размышления о нашей профессии и ее границах
#давайте_лайфхак — приемчики по работе с текстом и выстраиванию рабочих процессов
#давайте_про_стайлгайд — создание и работа со стайлгайдом
#давайте_про_инструменты — всё об инструментах и стеке технического писателя
#давайте_анонс — мероприятия для техписов
#давайте_мем — смеемся надо всем, что происходит в нашей работе

Есть вопросы? Пишите в комментарии под этим постом. Комментарии и дискуссии мы, вообще, очень любим 😉

С 1 апреля :-)

Смешно или грустно?

#давайте_мем

Страдаете ли вы от того, что с клавиатуры невозможно написать некоторые очень нужные техпису символы? Например, длинное тире (—), стрелочки (→) или кавычки-ёлочки «». Мы да. И все решаем эту проблему по-разному... Некоторые, например, держат под рукой текстовый файл, откуда копируют эти символы.

Наш коллега и автор канала Parawriter Антон Гафаров сделал классную штуку! Специальную техписовскую раскладку для клавиатуры 🎉
Установите ее и вводите нужные символы удобным сочетанием клавиш.

Установочный пакет выложен на github. Там же в readme все инструкции.

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

А от нас — огромное спасибо :-)

#давайте_лайфхак

Страшный сон технического писателя

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

Какие ещё есть варианты не светить данными:
✅ Вообще их убрать со скринов. Но это не всегда возможно. Например, если нужно показать пример заполненной формы.
✅ Использовать специальный аккаунт. Наверняка же у вас есть аккаунт Иванова Ивана Ивановича? 😉
✅ Отказаться от скринов. Нам он нравится больше всего, но бывают, к сожалению, ситуации, где без них никак.

P. S. Очень интересный вариант с номером телефона придумали коллеги из билайн. Можете послушать в их докладе на митапе примерно с 1:50:00.

#давайте_практику

Давайте перепишем… под целевую аудиторию

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

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

Установите приложение
1. Скачайте и запустите установочный файл.
2. Выберите место и опции установки.
3. Примите лицензионное соглашение.
4. Нажмите Установить.

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

Установите приложение
1. Скачайте файл — он будет сохранен на вашем компьютере в папке загрузок по умолчанию.
2. Нажмите на файл правой кнопкой мыши и выберите Запустить.
3. Укажите папку, в которой будут храниться все данные приложения, и нажмите Далее.
4. Выберите язык приложения и нажмите Далее.
5. Прочитайте и примите лицензионное соглашение — нажмите Согласен.
6. Нажмите Установить — начнется установка приложения на ваш компьютер.
7. После окончания установки нажмите:
• Запустить, чтобы начать работу с приложением;
• Закрыть, чтобы закрыть программу установки.

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

Поделитесь, для кого чаще пишете? И для кого больше нравится?

#давайте_практику

Как общаться с заказчиками: метод «Приоткрытая дверь»

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

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

Такой метод хорошо с работает с типами заказчиков: неуловимый и перфекционист.

#давайте_про_заказчиков
#давайте_лайфхак

Поговорим о качестве?

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

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

Актуальность тоже можно проверить с позиции пользователя: сравните то, что написано, с тем, что вы видите. Если всё на местах и все действия можно выполнить, то можно двигаться дальше.

Чтобы проверить полноту инструкции, пройдите по пути пользователя и посмотрите по сторонам: что еще ему может понадобиться? Может, дать ссылки на ресурсы, добавить шаги, указать требования к файлам или более детально описать процесс? Сделайте всё, чтобы пользователь мог решить свою задачу здесь и сейчас.
Особое внимание уделите внешним процессам: если пользователю нужно что-то сделать вне продукта, облегчите его путь максимально. Нужно отправить документы? Расскажите, в каком формате, куда, как именно. Пользователь все равно задаст себе эти вопросы, так что лучше заранее дать на них ответы.

На сегодня, пожалуй, всё!
А как научиться предвидеть вопросы пользователя, расскажем в следующей серии рубрики #давайте_лайфхак )

Всё так? ;-)

#давайте_мем

Правила хорошего тона хорошей инструкции

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

✅ Одно действие — один шаг
Например, «Зайдите в раздел, потом нажмите кнопку Создать, после чего заполните форму» — это три последовательных шага, а не один. Разделите их на три пункта нумерованного списка.

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

✅ Шаги — про действия пользователя, а не системы
«Форма для заполнения откроется в новом окне» — это не шаг для пользователя, а результат выполнения его предыдущего действия. Не создавайте новый пункт списка, напишите про этот результат в конце предыдущего пункта: «Нажмите Создать. Откроется форма для заполнения». Каждый шаг инструкции должен описывать то, что может сделать сам пользователь.

✅ Для опциональных шагов — «если» в начале вместо пояснений в конце
«Если хотите добавить комментарий к заявке, откройте…» — так читатель сразу пропустит этот шаг, если он не хочет добавлять комментарий.

✅ Заголовок — про целевое действие
Какой результат получит пользователь, когда пройдет все шаги? Создаст заявку? Тогда назовите инструкцию конкретно «Как создать заявку», а не туманно «Работа с заявками».

#давайте_практику

Тестовое задание: как догадаться, чего от вас ждут

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

Самое правильное и очевидное решение — спросить. Обычно все общение ведется с HR-специалистом, через него можно задать вопросы нанимающему менеджеру.

Если HR молчит или пришел ответ, что требований нет:

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

✅ Проанализируйте тексты ближайших конкурентов.

✅ Изучите в описании вакансии раздел Требования к кандидату, в них обычно описан формат документов и подход, в котором работают в компании.

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

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

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

#давайте_практику

Всё так? ;-)

#давайте_мем

База знаний в порядке: еще одна роль техписа

Была ли у вас ситуация, когда ищешь информацию в базе знаний, а там дремучий лес?
И вроде создание и ведение базы знаний не прямая обязанность технического писателя, но иногда так хочется навести порядок и помочь сделать непонятное понятным… Так почему бы и нет? 🙂
Мы собрали несколько пунктов, чем технический писатель может помочь:

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

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

✅ Продумать процесс обновления. База знаний живой продукт, и она пополняется и меняется, как и любая документация. Поэтому продумать, как обновлять и поддерживать базу знаний, мы тоже можем.

✅ Создать шаблоны для оформления статей и написать словарь терминов. База знаний понятнее и проще, если она единообразна. Шаблоны помогают одинаково оформить статьи, а словарь терминов - использовать авторам одинаковые названия для одних и тех же сущностей.

✅ Написать инструкцию, как выпускать статьи в прод. Если авторов несколько, то инструкция точно выручит.

У вас есть идеи, чем ещё технический писатель может помочь? Пишите в комментариях.

#давайте_про_процессы