Техписалити!

#книги #интервью #розыгрыш Всем привет! Сегодня в гостях у Техписалити! — Екатерина Ушакова, автор канала Буквально Ушакова и автор книги 📗"Если ты — технический писатель" которая вышла этой весной. • Катя, ты не просто технический писатель, но и преподаватель университета Иннополис. В своих интервью ты делилась, что книга появилась ещё и как методическое пособие для твоих студентов. Расскажи, пожалуйста, какие дисциплины ты преподаёшь и какая литература используется в обучении. • Я преподаю дисциплину Technical Communication in IT. Мы учим студентов не столько писать документацию по шаблонам, сколько дизайнить коммуникации на разных этапах работы с продуктом. В основе лекций — цикл разработки ПО: мы смотрим, какие коммуникации и артефакты нужны на переходах между этапами, чтобы продукт разрабатывался лучшим образом. Курс более фундаментальный, он много объясняет про коммуникации между разными участниками разработки. Что касается литературы — на английском её много, мы даём студентам список рекомендаций из примерно 40 книг. А вот на русском языке такой литературы почти нет. Книга — это другая история: она про хорошую техписательскую практику. Я хотела, чтобы у нас было больше грамотных коллег, в том числе в плане процессов. Чтобы техписатели не боялись развиваться в смежных областях. Ну и конечно чтобы новички могли для себя понять, кем они будут, когда вырастут. Книга скорее для людей, которые хотят разобраться в профессии самостоятельно. • Чего не хватало тебе в начале карьеры? Какую книгу ты хотела бы прочитать, когда сама начинала и стала ли эта книга ею? • Когда я начинала, был Гипербатон, были какие-то видео, книги тоже были — но всё это далеко от продуктового подхода. На старте мне этого хватало. А вот когда я начала нанимать людей и развивать команду, остро не хватало адекватных материалов. Нечего было дать новичку и сказать: «Прочитай, и ты поймёшь, как у нас всё устроено». Так что да, эта книга — во многом та, которой мне самой не хватало. • Планируешь ли ты выпустить другие пособия, чтобы создать цельный образовательный курс по нашей профессии? • Есть мысли сделать книгу для старших техписателей и руководителей, но пока не готова назвать точную дату или даже год. Если будет достаточно материала и потребность — да, книги будут. А что касается образовательного курса — у меня есть отдельный проект «Буквально», это курсы для техписателей. Тестовый поток уже прошёл, скоро будут анонсы публичного запуска. • Можно ли считать, что все, кто прочитает книгу, практически прослушал университетский курс? • Отчасти. Материал всё-таки разный: в университете больше академичности, фундамента, а в книге больше про быстрый старт уже в компании. Можно прослушать курс и никогда не работать техписом, но нести культуру коммуникаций в своей работе. А можно прочитать книгу и никогда не задумываться о всём цикле разработки ПО. Это два разных пути в профессию, которые дополняют друг друга. Почти весь тираж разлетелся сразу, но у наших подписчиков есть возможность получить её бесплатно. Задайте вопрос Кате в комментариях. Катя выберет самый интересный вопрос и его автору отправит книгу. Участвовать может любой, но по традиции, если вы находитесь за пределами России, мы попросим контакты вашего друга или другого доверенного лица в нашей стране.

#какэтоработает #средаразработки Всем привет! Сегодня продолжим разговор о git, а точнее о двух способах объединения изменений, и посмотрим, для каких ситуаций подходит каждый из них. git merge VS git rebase Что делают эти команды? Git merge объединяет ветки и создаёт отдельный коммит слияния, сохраняя временну́ю последовательность коммитов. Git rebase делает историю линейной, но меняет при этом хэши (уникальные идентификаторы) коммитов.

Рассмотрим, как работает rebase из feature в main. Представим, что до объединения в ветках есть коммиты: feature: A — B — C (коммит 1 июня) main: A — B — D (коммит 2 июня) Что получается после rebase: feature: A — B — C main: A — B — C — D' (D' — новый хэш)

Почему смена хэша — это плохо Коммиты — это “записи”, по которым можно восстанавливать историю или отменять изменения, передвигаясь по ним назад. Rebase переписывает хэши коммитов, чем может сломать историю у других участников процесса. Чем плох merge? Если есть изменения, merge добавляет новый коммит с двумя родителями — коммит слияния. Более того, при слиянии сохраняется ветвление, и поэтому сложно визуально определить, какой коммит в одной ветке был сделан раньше, чем коммит в другой.

Что происходит при merge из feature в main? main: A (коммит, от которого создана ветка) — B — C (коммит 1 июня) feature: A — E — D (коммит 2 июня) Что получается после merge в ветке main: main: A — B — C — F (коммит \ E — D / слияния)

Когда какой путь выбрать? Merge или rebase — это выбор между полной историей и визуально чистой историей. Rebase можно использовать, чтобы обновить ветку перед слиянием с основной, сохраняя линейную историю. Merge лучше использовать, если ветка общая и в ней работают несколько разработчиков. ❗️Главное правило: не переписывайте историю, которую уже кто-то мог забрать. Вопрос к мидлам и сеньорам: а вы используете rebase или обходитесь merge?

#мемница

#мемница

#мемница

#какэтоработает  #вопросвлоб Всем привет! Сегодня мы рассмотрим ситуацию, с которой не так давно столкнулись. Разбор этой ситуации ещё полезен тем, что одной из наших коллег подобный кейс задали на собеседовании. Так что этот пост для рубрик и про практические решения, и про собеседования. Как выкатить документацию на другом языке, если у вас нет ни времени, ни ресурсов Представим, что у вас появилась производственная необходимость срочно выпустить документацию на другом языке. Сразу оговоримся, что подобный подход — это способ потушить пожар, а не выстроить систему правильно. Подготавливаемся 1️⃣ Узнайте, на сколько языков нужно перевести документацию. 2️⃣ Узнайте, в каких странах вы должны выйти, нужны ли вам домены в этой стране. 3️⃣ Изучите требования законодательства относительно данных в этих странах. Например, нужно ли разворачивать сервис документации на мощностях местных ЦОДов. 4️⃣ Запросите требования вашей службы информационной безопасности. 5️⃣ Уточните, все ли сервисы вашего продукта локализованы в нужных странах. От этого зависит, все ли функциональности будут доступны в этой стране. Если не все, готовьтесь скрывать часть документации. Заручаемся поддержкой 6️⃣ Возьмите у команды продукта переводы текстов интерфейса. 7️⃣ В условиях сжатых сроков и отсутствия ресурсов мы будем использовать искусственный перевод. Расскажите владельцу продукта о ваших планах, аргументируйте каждое решение. Владелец продукта и менеджер продукта должны быть вашими союзниками, используйте свой талант переговорщика. Работаем с текстами 8️⃣ Приготовьте на основе переводов словари значений русский — иностранный, столько пар, сколько языков. Эти словари вы сможете использовать в качестве контекста для искусственного перевода. (Помним, что у нас нет времени и ресурсов, поэтому ИИ — наш выход). 9️⃣ Если вам требуются нераспространённые языки, сформируйте словари английский — иностранный. Если у вас изначально есть английская документация, ИИ с английского на редкие языки порой переводит лучше, чем с русского. 1️⃣0️⃣ Подготовьте иноязычные исходники в нужной вам разметке. Загрузите в ИИ в качестве контекста наши словари и с помощью промпта запросите перевод. В идеале лучше настроить интеграцию с системами построчного перевода, но мы помним, что у нас нет времени и ресурсов. Вы можете использовать агенты и прописывать им правила — в этом случае перевод может быть лучше. Строим, собираем, разворачиваем, тестируем 1️⃣1️⃣ Проработайте архитектуру документации и процессы, которые позволят разворачивать документацию в нужных конфигурациях и на нужных адресах. Это может быть непростой работой и занять приличное количество времени. Если у вас есть помощники-девопсы, вам повезло. 1️⃣2️⃣ Если у вас в продукте есть нелокализованные сервисы, подготовьте скрипты, которые позволят скрывать описания конкретных функциональностей в конкретных странах (на конкретных доменах). Если вы не умеете это делать, вам могут это рассказать наши ИИшные друзья. Для них это несложно, и они в этом практически не ошибаются. 1️⃣3️⃣ Если вы поставляете публичную документацию, позаботьтесь о том, чтобы поисковые системы правильно проиндексировали её. Для этого снабдите страницы нужными метаданными. 1️⃣4️⃣ Протестируйте сборку и развёртывание документации в тестовых окружениях. Публикуем 1️⃣5️⃣ Получите согласование от владельца и менеджера продукта и опубликуйте документацию. И да поможет вам бог. Можно ли поддерживать такую документацию в актуальном состоянии? — Да, если реализовать непрерывную локализацию, о которой мы расскажем в других постах.

#мемница

#мемница

#колонкаредакторов #вопросвлоб Всем привет! На связи Лида. Сегодня у нас с вами серьёзный разговор. Как и намекает рубрика — о собеседованиях. Адвокат для соискателя Последнее время я меньше собеседую, а больше собираю информацию о собеседованиях в разных компаниях. Процесс знакомства с кандидатом заметно изменился в последнее время. Теперь чаще всего встречи записывают именно для того, чтобы проанализировать ИИ, а крупные компании и вовсе добавляют во встречу ИИ-агента. Если ведётся запись, то кандидата спрашивают: "Вы не против?" — этого требует закон. Записывать человека в непубличном месте без его согласия никто не имеет права. Но если на встрече присутствует участник вроде "HR-AI", у кандидата никто не спрашивает разрешения. А ведь это ещё одно техническое устройство, которое не просто транскрибирует видео, но и даёт анализ навыков и личности кандидата. Припоминаю, что на психологическое исследование человек тоже должен давать разрешение.

Кажется, будто трудовой кодекс серьёзно отстаёт от действительности. И по факту, ИИ-исследования, проводимые без согласия, нарушают права кандидата.

Ещё один момент. На собеседование кандидат приходит один. А на другой стороне — рекрутер, технический специалист, возможно, даже тимлид и ещё и ИИ-агент. Извините, но даже у обвиняемого в суде есть адвокат. А тут человек сидит, как перед экзаменационной комиссией. Хотя собеседование — это не экзамен, это переговоры равноправных сторон. Мне представляется, что кандидат может прийти со своим hr-агентом и ИИ-агентом. Это было бы справедливо. И по итогу провести анализ знаний, умений и особенностей личности всех собеседующих. Узнать степень их доброжелательности или, наоборот, токсичности. Сравнить сказанное ими о компании с информацией из открытых источников. Да, это всё розовые фантазии. Но ведь это было бы справедливо, не так ли?

#twd3 Всем привет! 27-28 марта в Москве прошла третья международная конференция технических писателей TechWriterDays, и мы по традиции делимся собственным взглядом на конференцию. *️⃣Самый объёмный сектор знаний: - Применение искусственного интеллекта. *️⃣Самая востребованная тема: - Уровни качества документирования и зрелость процессов. *️⃣"Волшебная таблетка": - Пакет шаблонов и матрица компетенций от Александры Базуткиной из RWB для управления коллективом из 100+ сотрудников. *️⃣Самая неожиданная тема: - Сертификация технических писателей и компаний. В обратной связи слушатели признают, что по содержанию и техническим темам эта конференция была на порядок выше предыдущей. Оставляем ссылки на доклады, которые официально получили наивысшие оценки от слушателей: 1️⃣ Наталья Борисенко "Документация как продукт: от текстов к стратегии и управлению опытом" 2️⃣ Камила Мазаева "Кому доверить ревью API — техпису или искусственному интеллекту" 3️⃣ Никита Авилов "Сам себе редактор: ИИ для вычитки текста и локализации" В течение года в официальном канале конференции будут публиковаться видеозаписи этих докладов. Рекомендуем посмотреть, и чтобы вы их не пропустили, обязательно опубликуем ссылки на записи.

#колонкаредакторов Всем привет! Возможно, вы заметили, что в нашем канале некоторое затишье. Современные события немного подкинули нам поводов подумать) Техписалити! начинался как школа для новичков, и мы продолжаем придерживаться этой концепции, хотя и разбавляем контент более “взрослыми” постами. Мы хотим, чтобы информация всегда была доступна всем, без каких-либо заморочек. Поэтому мы переходим в Макс. Мы изучили многие платформы и решили попробовать Дзен. Нет, мы не переходим туда, а просто дублируем информацию для тех, кто может только в белый список. Поскольку мы остаёмся в телеграме, предлагаем посмотреть залипательное – атлас телеграм-каналов, в котором есть и мы, и многие наши дружественные блоги. Давайте найдём их все! А начнём отсюда)

#мемница

Всем привет! Мы снова с новостями для студентов🧑‍🎓 Хотите прокачать скиллы технического писателя и научиться превращать сложные технологии в понятные тексты? Вперёд на стажировку в Kaspersky! Доступно для студентов невыпускного курса любых вузов в Москве и Московской области. В одной лодке с профессионалами Kaspersky можно научиться: • разрабатывать документацию для различных бизнес-процессов компании • делать сложные технологии понятными и доступными для разных аудиторий • грамотно собирать информацию у экспертов, анализировать ее и подготавливать для дальнейшей работы Вас ждут реальные проекты и практика в международной компании, удобный график от 20 часов в неделю, конкурентная зарплата, компенсация питания, спортзал, сауна и многое другое Переходите по ссылке https://kas.pr/c4x2 и подавайте заявку на направление Technical Writing🖥✍️

#мемница

Всем привет! Через несколько минут начинаем трансляцию розыгрыша билета на TWD#3! Подключиться можно по ссылке: https://telemost.yandex.ru/j/12968446731169

#twd3 Всем привет! Немного задержались, но всё же сформировали список участников розыгрыша. Список здесь. Каждому участнику мы присвоили номер — это номер его строки в таблице. Заносили в таблицу в порядке появления комментариев: вначале самые первые. Два претендента в список не попали. К сожалению или к счастью, правила есть правила, и комментарии, опубликованные позже 12:00 по Москве мы не учитываем. В этот четверг, 12 марта в 13-30 мы проведём трансляцию розыгрыша — по старинке с помощью генератора случайных чисел. Затем проверим, соблюдены ли у победителя условия конкурса, и свяжемся с ним. Если условия не соблюдены, сгенерируем новый номерок. (Самое время проверить свои подписки) Ссылку на трансляцию пришлём за пять минут до трансляции. До встречи в четверг!

#мемница

#мемница

#twd3 Всем привет! Этой весной, 27-28 марта в Москве пройдёт TechWriterDays — наша профессиональная конференция, третья по счёту. Время покупать билеты, бронировать гостиницы, поэтому мы решили не откладывать это событие в долгий ящик: ❗️Розыгрыш офлайн-билета на TechWriterDays #3! Что даёт участие в конференции офлайн: *️⃣ Возможность послушать интересные доклады, но главное — поговорить с их авторами, задать вопросы, которые важны именно вам. *️⃣ Пообщаться с коллегами, обменяться мнениями, услышать интересные идеи. *️⃣ Познакомиться с нанимающими менеджерами и обрасти связями в других компаниях. *️⃣ Найти и "захантить" ценного сотрудника. Итак, что же нужно, чтобы поучаствовать в розыгрыше? Условия просты, но они обязательны: - Подпишитесь на нас) - Подпишитесь на официальный канал конференции - В комментариях под этим постом оставьте сообщение "Хочу билет!" В пятницу, 20 февраля, в 12-00 по Москве мы завершим приём этих сообщений. Затем проверим, выполнены ли условия, присвоим номерки и с помощью генератора случайных чисел выберем победителя на онлайн-трансляции. Обратите внимание, билет не включает в себя оплату проезда и проживание. Это нужно будет приобрести самостоятельно.

#мемница