Техниндзя | Дмитрий

Зашел в желтый чат и узрел, что давеча прошел толк про использование медиа-файлов в работе над технической документацией, который я, как всегда, благополучно пропустил 🙈 Посему, поделюсь своим скромным суждением на эту тему здесь, в своем тупичке. С ходу скажу откровенно, что в своей работе мне пока не приходилось снимать обучающие видосы для пользователей или зацикливать эти видосы и превращать их в гифки — моя техписательская работа требует только делать скриншоты интерфейса и вставлять в документацию. Для этих целей мне хватает следующего инструментария: 1. Программа «Скриншотер» — просто потому что бесплатно. 2. Paint — потому что не люблю Photoshop. Если говорить о том, почему стоит использовать картинки в документации, вот какое будет мое скромное суждение на этот счет: 🪼 Картинки визуализируют сложные технические процессы, что может значительно облегчить их понимание. 🪼 Иногда пользователям проще жевать, чем говорить смотреть на картинки, чем читать длинные абзацы текста. Но есть и обратная сторона (как, впрочем, и везде): 🪼 При изменениях программы (будь то новые баги фичи, обновленный интерфейс — не важно) картинки перестают быть актуальными. И хорошо, если так бывает условно «раз в пятилетку», но если такие изменения происходят довольно часто?.. 🪼 Картинки занимают немало места и раздувают размер файлов документации до межгалактических размеров, от чего могут возникнуть шоколадки неполадки при скачивании и хранении документации. Конечно, использовать или не использовать картинки в документации — зависит от ситуации, но, как говорил великий мудрый: «Все должно быть в меру» ☝️ То есть: документация должна быть сбалансированной — немного текста, немного скриншотов и много смысла. P.S: с другой стороны, инструкции по сборке мебели из Икеа (вспомнил — прослезился) мне всегда нравились своей лаконичностью — купил, посмотрел, собрал. И никакого суицида. P.S.S: однажды я заприметил на Ozon'е письменный стол от российской фирмы «Олмеко». Я решил, так сказать, поддержать отечественного производителя (по факту: повелся на позитивные отзывы под названием «инструкция предельно понятная, легко собирается») и оформил заказ. Реальность была куда суровее: на одностраничной инструкции был только общий визуальный план сборки стола. Из текста же там была только таблица комплектующих 🤯 Итог вполне тривиален: я долго-долго парился со сборкой стола, но в итоге плюнул и воспользовался подсказкой «Помощь человека с руками из нужного места» 🥲 Мораль сей басни изложил выше, но продублирую:

документация должна быть сбалансированной — немного текста, немного скриншотов и много смысла.

А что вы думаете на эту тему, коллеги? Как вы используете медиа-файлы в своей работе и какие трудности с ними возникают? 🙂

Уф, давно меня тут не было. А если быть точным — с самого начала лета. Новости у меня следующие: 1. Сначала я успел переболеть ОРВИ и, к счастью, болел не долго. Но едва я выздоровел, лазаретную эстафету перехватила жена. Иронично, что в данном контексте фраза «Муж и жена — одна сатана» приобретает несколько иной смысл... В любом случае, мораль тут только одна: ни в коем случае не болейте. Нет, ну правда. Любая болезнь — противная штука, 0/10, никому не советую. 2. Получил приглашение от Кати выступить на грядущем DevFest Omsk — приглашение принял, придумал тему и тезисы и подал заявку. 3. Получил сообщение от программного комитета Techwriter Days по поводу доклада в следующем марте — уже через неделю будет встреча, на которую начал готовить драфт презентации и тезисов. 4. В остальном — порядок: живу, выкладываюсь на полную катушку на работе, совершаю набеги на кондиционер и пытаюсь радоваться жизни. А теперь — торжественно клянусь, что скоро будут новые посты (будут-будут, чесслово), поэтому stay tuned!

Когда оформлял заказ лекарств и отвлекся буквально на полчаса...

Причины не болеть: 0. Когда болеешь, приходится ходить в аптеки и встречать вот такие исчадья МКАДа ада 1. Все остальное Тем временем, пока я вливаю в себя очередной литр живой воды, объявляется небольшое активити ☀️ Пишите в комментариях свои варианты того, как бы вы переписали сей «шедевр» ⤵️⤵️⤵️ Конь-текст: при этом выше на объявлении написано о льготной выдаче лекарств ветеранам, инвалидам, чернобыльцам и т.д. и т.п.

Штош, кворум набрался, поэтому голосование по рассказу о CodeFest считаем состоявшимся. Те, кто не хочет читать — пролистывайте этот пост со спокойной душой, а желающие почитать — устраивайтесь поудобнее, поехали :) Все началось с того, что я чисто случайно наткнулся на сообщение Тани Фокиной в желтом чате. Звучало оно примерно так: «Ищу техписателя, который в работе или вне работы балуется нейросетями и сможет прийти поболтать на квартирнике в Новосибирске». После тщательных размышлений и взвешивания всех «за» и «против», я написал Тане, согласовал свое участие и 27 мая доехал на бесплатном автобусе до Экспоцентра. Первое, что меня приятно удивило — это размах и масштаб конференции. И самое важное — проводится она не где-нибудь в условной Москве, а в городе, где я живу 😱 Правда, придя туда, я ощутил себя маленькой рыбкой-клоуном среди акул отечественного IT. Наверняка, это чувство связано с тем, что я в тот момент был новичком в новой профессии (хотя, как будто сейчас что-то изменилось, ага). Кроме того, я сильно нервничал. Прямо очень. В попытках снизить уровень нервозности я метался от докладов к спонсорским стендам, оттуда — в зону кофе-брейка, чтобы влить в себя очередные пол-литра кофе, не забывая пообщаться с другими участниками. Ситуацию немного улучшали призовые стикеры, носки и печеньки, которые я получал за участие в активностях, но полностью расслабиться, увы, не удавалось. Мой мозг забивала только одна мысль: «ЧТО ЖЕ ТАКОЕ ЭТОТ ВАШ КВАРТИРНИК, БЛИН, И О ЧЕМ МНЕ ТАМ ПРИДЕТСЯ ГОВОРИТЬ?» Как человек, который ранее не присутствовал на таких мероприятиях, мое понимание термина «квартирник» ограничивалось только этим: «НУ, ЭТО ГДЕ ПЕСНИ ПОД ГИТАРУ ПОЮТ, ЫЫЫ». Однако это суждение никак не коррелировало с форматом конференции, и я предположил, что «квартирник» — это некий эвфемизм к термину «круглый стол». Спойлер: я был прав. К слову, квартирник был посвящен до боли актуальному вопросу: «Заменят ли нас нейросети?» Если говорить о самом выступлении, то я его плохо помню и не особо люблю вспоминать. Собственное волнение мне только мешало — я путался, запинался, нелепо шутил и каламбурил, и у меня жутко кружилась голова. Как итог — что тогда, что год спустя я остался и остаюсь очень недоволен своим выступлением. Несмотря на то, что на тот момент я уже активно «баловался» нейросетями и понимал, о чем идет речь. Несмотря на лояльность публики и отсутствие троллинга. Зато, по крайней мере, я поучаствовал бесплатно в CodeFest-е, и этот опыт стал подспорьем для моего дальнейшего участия в TechWriters Days в этом году 💪 Видеозапись квартирника оставляю здесь, кринжуйте на здоровье :D Теперь — история про поедание торта с пола, или послесловие. Вышли мы с ребятами из зала и двинули на after party, предвкушая большой дастархан с тортом и алкоголем. Вдруг, под музыку из капитал-шоу «Поле чудес» и вопли Я(Мы)кубовича двое парней внесли в зал торт немаленьких размеров и… как бы невзначай уронили его на пол. В итоге: торт всмятку, парни в печали. Подоспевшие зеваки начали фотографировать то, что пару минут назад было тортом. Я и еще несколько отчаянных подошли к этой куче поближе. В мгновение ока я (как и другие собравшиеся) подумал: «А что, если…?» Я зачерпнул немного торта, который возвышался над полом, и попробовал. Поняв, что он вполне съедобный и даже вкусный, я дал понять остальным, что торт вполне съедобен и даже вкусен. И хорошо, что я успел набить им доверху свою термокружку, потому как в считанные минуты его раздербанили на атомы и молекулы :D Наверняка, со стороны я смотрелся еще кринжовее, чем на квартирнике, но я ни о чем не жалею)))

И я там тоже был – Торт с пола ел, настойку пил... 😅

У нас в Сибири уже утро и начинается CodeFest. Отдельно секции по UX writing или другим текстам нет, но есть по дизайну, аналитике, менеджменту — много годного. Советую от души, CodeFest я готова советовать всегда, особенно после того, как мы в прошлому году в офлайне ели торт с пола. Незабываемо! Онлайн-трансляция уже идёт, лайв шанель и квартирники бесплатные, присоединяйтесь:) Посмотреть программу бесплатной трансляции

Сегодня я как в песне «Дыхание» группы «Наутилус Помпилиус»: проснулся в холодном поту. Все потому, что мне приснилось, будто бы от меня разом отписалась вся аудитория… 😱 Я воспринял это как знак того, что надо сюда что-то написать, чтобы этот кошмарик не стал явью. Поэтому сегодня я хотел бы поговорить с вами о таком рабочем процессе, как вычитка текста. Хоть я, мягко скажем, не очень люблю вычитывать ни свои, ни чужие тексты, я не могу отрицать, что этот процесс играет ключевую роль в создании отборного технического (да и вообще любого) контента. Что такое вычитка текста? Вычитка текста — это процесс редактирования и корректировки написанного материала. Проводится для того, чтобы обнаружить и исправить ошибки в правописании, пунктуации, форматировании и стилистике. Все просто, как абрикос 🙌 Как построен процесс вычитки? Как показывает практика, у каждого техписателя своя методика вычитки. Я же поделюсь тем, как это делаю я: 1. «Машинная» (или, скорее, машинальная) проверка: вставляю написанный текст в Word и пробегаюсь по нему в поисках волнистых подчеркиваний. 2. Механическая проверка: глазоньками осматриваю текст на наличие очевидных ошибок в правописании, пунктуации и структуре предложений. 3. Глубокая проверка: пытаюсь представить себя на месте конечного пользователя, чтобы ответить на ключевой вопрос: «Если б я был султан заказчиком, был ли бы мне понятен этот текст?» 4. Повторная проверка: если позволяет время, жду 15-30 минут, снова перечитываю текст (обязательно вслух и не менее 3 раз!) и сверяю его с тем, что было в начале. 5. Проверка форматирования: проверяю текст на соответствие оформление и стилю, прописанным в стайлгайде. 6. Передача эстафеты: передаю вычитанный мною текст дальше (тимлиду, хранителям знаний и далее по списку). Почему я не очень люблю вычитку? Ладно, буду честен: еще будучи переводчиком, я никогда не любил вычитывать ни свои, ни чужие тексты. И вот почему: 1. Вычитывая чужой текст, я ощущаю двойную ответственность, потому как если я что-то не догляжу, либо меня по голове не погладят, либо я «сожру» себя со внутренностями. 2. Как известно, вычитка требует немало времени и концентрации. Но что, если этого времени совершенно не осталось, а заказчик лишает концентрации, дергая каждые 5 минут с вопросом «Ну че там»? 😡 Вот, то-то и оно. Как бы то ни было, важнее всего помнить, что подобно тому, как в споре рождается истина, без вычитки не получится качественная техническая документация. И тут уж ничего не попишешь, c’est la vie 🤷‍♂️ А что вы думаете насчет вычитки: любите ли вы вычитывать свои/чужие тексты? Есть ли у вас свои лайфхаки по улучшению этого процесса? Делитесь в комментариях 👇👇👇

Итак, план на вторую часть праздников: 0. Покушать шашлычок 🤪 1. Выбрать тему и набросать план будущего доклада 2. Подать доклад на рассмотрение 3. Начать активно работать над ним