Всем привет!

#Вакансия #Москва #Технический_писатель #Удаленка #Офис #wanted_tw

Эвотор – это платформа для малого и среднего бизнеса - http://www.evotor.ru/

Мы производим онлайн-кассу, которая не просто бьёт чеки. Эвотор считает остатки товаров, управляет скидками, отмечает момент продажи на камере видеонаблюдения и много чего ещё — для всего есть приложение в нашем магазине (https://market.evotor.ru).

Ищем в команду Магазина приложений Технического писателя.

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

Чтобы работать у нас тебе нужно:
•  знать Markdown;
•  уметь читать код на JavaScript;
•  уметь работать с GitHub;
•  иметь общие представления об HTML и CSS;
•  писать просто и понятно;
•  владеть принципами дидактики.

Если чувствуешь в себе силы, давай к нам! Пишите в личку или откликайтесь https://hh.ru/vacancy/38869813

А мы предлагаем:
•  Полностью официальная заработная плата;
•  Гибкое начало и окончание рабочего дня;
•  Офис в шаговой доступности от м. Парк Культуры или удаленная работа;
•  ДМС после прохождения испытательного срока
•  3 доп. оплачиваемых дня к отпуску.

Как раз про "писать просто и понятно")

В редактуре меня напрягает одна штука: очень мало данных. Есть куча каких-то принципов и правил, которые фактически ничем не подкреплены.
Возьмем хотя бы tone and voice. От бесконечных «пишите коротко, понятно и человечно» у меня уже дергается глаз. А внятных исследований по теме почти нет.

Поделюсь своей находкой: диссертацией Николь Лоорбах из нидерландского университета Твенте. Николь исследовала, как стиль текста влияет на пользователей. Сама диссертация гигантская, я выбрала основное.

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

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

Результаты
🔸 Мотивирующий текст не повлиял на число ошибок и скорость работы.
Пользователей попросили выполнить 11 операций. Обе группы сделали одинаковое количество ошибок и потратили на задания одно и то же время.

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

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

🔸 Многие пользователи предпочли стандартную инструкцию.
В финале двум группам показали тексты друг друга. Из 20 участников, которые читали мотивирующую инструкцию, 14 сказали, что предпочли бы обычный текст.

Вот вам и «пишите просто о сложном» 😬

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

Это не значит, конечно, что строгие сжатые инструкции можно писать плохим языком

> От бесконечных «пишите коротко, понятно и человечно» у меня уже дергается глаз.
вот, кстати, да

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

Навеяло воспоминание из далёкого прошлого. В одной оооочень крупной конторе сидим, работаем, и вдруг прибегает весь искрящийся наш молодой ИТшник (это времена 486DX2 и сетей по коаксиалу) и садится за клавиатуру компа играть что-то из Ференца Листа. Мы немного ждём, а потом скромно интересуемся: "Лёша, Лёша, тормозни! Что случилось, Лёша?!!" Лёша отрывает горящий взгляд от экрана и пафосно информирует: "Коммерческий директор велел написать инструкцию - как пользоваться Вордом, чтобы стикер на ноутбуке сбоку экрана приклеить!"

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

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

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

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

Если это высокоразумная стиральная машинка с тремя кнопками "Стирать-Сушить-Провериться", то можно и живо, и интересно, и комиксы нарисовать. А если программируемый инженерный калькулятор - тоже можно, но зачем?

Тут вопрос о смешении тёплого с мягким. Можно писать сухо, но с канцеляритом и путанно. Можно сухо, но с хорошей структурой и без канцелярита. Можно писать сухо, но оживить инструкцию иконками, картонками, скриншотами (что ещё и прагматику текста может улучшить). Можно писать живо, но понятно и структурно. Можно писать живо, но с канцеляритом и путанно.

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

Ибо уровень технических знаний разный.

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

Патчноуты тоже бывают с юмором :) у кого-то видел:

- исправлено несколько старых багов
- добавлено несколько новых

А, там чуть ниже уже стикером про это пошутили, ок

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

Я одна такая?)