О техписательстве
В чат техписателей сыпется много всякого интересного, иногда я даже успеваю это читать. Ниже то, что мне хотелось бы сохранить и перечитать на свежую голову, когда удастся отвлечься от невыносимой рабочей гонки.
Что помогает в профессии
Общие навыки работы с информацией - понимать незнакомое, упорядочивать, выделять связи, объяснять текстом.
Софт скиллы - учиться принимать обратную связь, в том числе негативную. Давать обратную связь, тоже в том числе негативную. Организовывать свой труд. Расставлять приоритеты. Писать понятные письма. Задавать вопросы - понятые, полные, открытые вопросы, это очень редко кто умеет. Рефлексировать. Отдыхать. Печатать десятью пальцами и вслепую. Договариваться с людьми, передоговариваться. Давать обещания, держать обещания, требовать по обещаниям тебе. Благодарить и принимать благодарность. Ошибаться и идти дальше, извлекать опыт из ошибок, своих и чужих. Давать задачи, брать задачи, руководить и быть руководимой. Сообщать заранее, когда не успеваешь сделать задачу в срок. Обращаться за помощью. Понимать других людей, их эмоции, цели, доступные им знания.
Опять же, предметной области тебя любая компания научит, а вот софт-скиллы придется нарабатывать самостоятельно.
Мотивация при работе техписателем - связать экспертов и общество, доносить и распространяется знания, важную информацию. Нельзя уметь всё, но можно знать у кого спросить, получить информацию и перенаправить ее тем, кому она нужна.
Чем хороши технические тексты - не надо продвигать те или иные политические силы со страниц своего издания, не надо впаривать какую-то ненужную дичь или писать hate speech. Стиль того, как пишутся технические тексты предполагает, что ты будешь на кого-то в меньшей степени воздействовать эмоциональными эпитетами.
Как говорили аналитические философы, лучше не использовать слова "скоро", "тепло" и прочие вещи, которые вызывают разночтения, споры и простор для манипуляций. Вместо «скоро» -конкретный временной интервал, вместо «тепло» - конкретный температурный режим. Есть устройство или ПО, есть вот такие-то характеристики.
Будучи техписателем, хочется примкнуть к тем, кто делает более существенный вклад в развитие продукта и к продуктам, которые тебе близки по духу - для меня это геймдев - как можно идти работать туда, где делают то, что тебе неинтересно?
Как измерить, что документация хороша?
Из DocOps: это не просто собрать сырые данные вроде количества просмотров, а о составлении метрик, привязанных к реальной пользе для бизнеса.
Бизнес-метрики:
- Доля того, что клиенты сделали/настроили своими силами, не напрягая техподдержку.
- Уменьшение затрат на техническую поддержку, когда сотрудник поддержки находит готовое решение в доке.
Внутренние метрики, показатели «здоровья доки»:
- Посещаемость по типу аудитории (b2b, b2c), языку и продукту. Просто суммарная посещаемость не имеет смысла, важны разрезы.
- Средняя скорость загрузки страниц. Это влияет сразу на UX и SEO.
- Индекс удовлетворённости пользователей.
- Качество документации, измеренное по нескольким показателям.
- Юзабилити документации - по анализу тепловых карт и записей сессий.
Аналитика в документации: как увидеть реальную пользу и понять, что улучшать | by Ekaterina Noskova | Xsolla Tech Blog | Nov, 2020 | Medium
medium.com
Подводные камни профессии
Что меня подбешивает на работе, так это когда техподдержка не знает в кого кидать задачи и сыплет все на меня без разбору, а я потом как дурак хожу, пинаю продактов, пинаю админов, слежу за выполнением этой большой задачи из кучи мелких.
Часто говорят - переделай инструкцию, а проблема по факту в криво реализованным функционале или, например, приходит какой-нибудь продакт и такой: «Ой, давай порядок статей поменяем, а то у нас услуга криво продается» - а там просто услуга капец сложная и на костылях. Ну или продукт криво продается потому что его не пиарят нормально.
У нас иногда из пресс-релиза ведет ссылка в хелп и вчера команда коммуникаций попыталась влезть в стиле: «Извините, что вмешиваюсь, но в инструкции все так прямо написано, это может расстроить клиента, может сохраним общий позитивный тон?». LOL! Если наша функциональность может расстроить клиента, когда описана так, как она реально работает, как есть - кажется что-то у нас не так с проектированием функциональности, а не с подачей.
Карьерный рост техписателя
Давно настыкала на вот такое разделение - и по-моему оно прям ок!
Часто в выгорании техписов винят специфику бизнеса в России - мол, всем нужен гост и ворд. Да и отношение к документации крайне печальное - большинство убирается в стол, так как она нужна только для сдачи проекта, то есть документация не нацелена на конечного пользователя, а для галочки.
Бизнес куда охотнее вложит $ в разраба, чем в документатора. В результате имеем, что продукты этих компаний имеют крайне плохую документацию, написанную крайне древним, скучным и формализированным языком.
Например, недавно один наш коллега написал, что если вы хотите, чтобы документация вас развлекала, то идите к клоунам. Наверное, Head of SUSE documentation представляющий себя на всех конференциях как мастер джедай - клоун.
===
Русский бизнес не рассматривает техписа как обязательный элемент команды, а документацию как элемент продажи продукта. Зачастую, документация пишется на коленке за день до релиза и ввод практик docs-as-code не приветствуется, так как требует дополнительных затрат человеко-часов.
===
Убедить бизнес, что документация это лицо продукта и первичное средство ознакомления пользователя с продуктом практически невозможно у нас. Инициация такого процесса со стороны техписателя очень часто упирается и в неадекватный менеджмент и в отсутствие свободного времени.
Но не нужно экстраполировать. Цель любого бизнеса - зарабатывать деньги. Если у бизнеса получается зарабатывать деньги с паршивой документацией или вообще без неё - это его право. Возможно, что в реалиях этого бизнеса документация действительно не нужна, или нужна для отчетности.
Как выбрать компанию, в которой явно забивают на документацию:
- Продуктовое направление (не проектное).
- Продукт сложный, направленный на узкую аудиторию.
- Компания клиентоориентированная, работает с каждым клиентом, а не бьёт маркетингом по площадям.
- Компания готова вкладываться в обучение своих клиентов, пользователей её продукта.
Позиция «в России есть только ГОСТ» и «документация не нужна бизнесу» довольно токсична и вредит всему профсообществу техписателей.
У Джерома в «Трое в лодке» был эпизод, когда герои испачкались в керосине, заправляя горелку, и им потом несколько дней казалось, что всё вокруг пахнет керосином - и еда, и лес, и речка, и сад. Это ровно такое же когнитивное искажение - в некоем профессиональном опыте и ближайшей окрестности бизнесу нужен только ГОСТ, а техписатели не ценятся, и от этого техписатель (что вполне резонно) страдает.
Есть бизнесы, видящие ценность хорошей документации, которые строят метрики ее эффективности, формируют документационные команды и процессы в них. На конференциях, семинарах и курсах для технических писателей в подавляющем большинстве присутствуют мотивированные люди, искренне любящие свою профессию, желающие наносить пользу своему бизнесу и успешно ее наносящие.
Я вижу одной из своих личных миссий - повышение культуры документирования в российских IT-компаниях. Важной частью этой миссии является повышение престижа и популярности профессии техписателя: без сильного и насыщенного рынка труда техписателей ничего не получится. Профессиональные сообщества типа нашего теписателького чата - очевидный инструмент формирования образа нашей професии и пополнения наших рядов.