Мишка в курсе: Технический писатель
СтатистикаМеня зовут Михаил, здесь я рассказываю про техническое писательство, свой путь, и иногда кидаю мемасы) Для связи: @el_miguel
- Последний пост
- 11 авг.
- Последнее чтение
- 12:45
- Постов за неделю
- 2
- Всего постов
- 20
- Тип
- открытый
- Язык
- русский
- Категория
- Технологии (по похожим)
- В каталоге с
- 12 авг.
- 1/24сутки в ленте
- 246
- 1/48двое суток
- 281
- 1/72трое суток
- 304
Оценка по просмотрам недавних постов: пост набирает почти всё за первые сутки.
Посты
Внедрение AI в теории: вау Внедрение AI на практике: ай
Можно ли доверить AI фактчекинг документации? Сейчас экспериментируем с еще одним сценарием использования Claude - делаем Skill для проверки актуальности статей в базе знаний. И довольно быстро столкнулись с проблемой, которая находится вообще не на стороне AI. Допустим, в статье написано, что после нажатия кнопки открывается определённое окно. Claude идет в Jira, ищет изменения, связанные с этой функциональностью, и пытается понять, актуально ли описание. Но что делать, если в тикете условно написано: “Updated settings behavior” А что именно updated, как теперь работает функция и что изменилось для пользователя остается где-то между разработчиком, аналитиком и тестировщиком. Та же проблема, кстати, возникает при подготовке release notes. AI может обработать хоть тысячу тикетов, но если исходные данные плохо описаны, из них невозможно достоверно восстановить пользовательское изменение. Поэтому сейчас думаем над тем, чтобы фактчекинг работал не по принципу: Статья → Jira → вердикт а скорее: Статья → несколько независимых источников → сопоставление → confidence level → вердикт Кроме описание в Jira, источниками могут быть: — acceptance criteria и комментарии внутри тикетов — связанные PR/MR и описания изменений — дизайн-макеты и UI-спеки — API/OpenAPI-спецификации — тест-кейсы QA — release notes предыдущих версий — внутренняя документация и расшифрованные записи обсуждений с knowledge owners Важный момент: Skill не должен пытаться «догадаться», если данных недостаточно. Гораздо полезнее получить: Unable to verify — insufficient source data чем очень убедительное, но выдуманное подтверждение актуальности статьи. В идеале хочется прийти к системе, где Claude не просто говорит «актуально / неактуально», а показывает, какое утверждение проверял, по каким источникам, что нашел и насколько уверен в результате. Получается, что задача постепенно превращается из «сделать AI-фактчекера» в более интересную инженерную задачу - построить для него нормальную систему источников истины.
Ребята, хочу вам показать бесплатный курс от альпины, в формате писем, приходящим вам на почту: 7 писем. 7 навыков. 15 минут в неделю. Бесплатно. Курс «Сила истории» от «Альпины» научит вас: ✅Питчить идеи за минуту ✅Писать живые сценарии ✅Шутить в тексте осознанно ✅Создавать диалоги, которые звучат ✅И многому другому Каждое письмо — один приём, который можно применить сразу. Без менеджеров, без звонков, без анкет. Подписывайтесь: http://special.alpinabook.ru/scene
Технических 😁
Какую модель Claude выбрать для работы с документацией? После появления новых моделей и настройки Effort сам какое-то время пытался понять, в каких случаях что лучше использовать. Делюсь выводами, к которым пока пришел. Sonnet 5 Для большинства задач технического писателя сейчас практически всегда выбираю Sonnet 5. По ощущениям, она лучше удерживает контекст, аккуратнее работает с большими объемами информации и реже теряет детали. Особенно хорошо показывает себя при: - анализе нескольких документов; - подготовке overview и how-to; - работе с глоссариями; - поиске несоответствий и повторений в документации. Что означает Effort? Для себя использую такую схему: Low - быстрые правки, саммари, рерайт. Medium - большинство повседневных задач. High - сложный анализ, несколько документов, продумывание структуры. Max - пока вообще не юзал😃 Когда тогда нужен Opus? Здесь разница уже не настолько очевидна. Представим, что нужно подготовить документацию для нового сервиса. Есть около 150 Jira-тикетов, API-спецификация, диаграммы, комментарии аналитиков и старая документация в конфлюенсе. Sonnet 5 High вполне сможет проанализировать все материалы, выделить ключевые изменения, предложить структуру и подготовить хороший первый драфт. Opus, скорее всего, пойдёт ещё глубже. Он чаще замечает противоречия между источниками, обращает внимание на отсутствующие сценарии и задает вопросы вроде: «А что произойдет, если пользователь пропустит этот шаг?» или «Почему здесь описан только happy path?» То есть разница уже не столько в генерации текста, сколько в качестве анализа и редакторской работе. А что насчет Fable? Fable ориентирована на более естественное повествование и творческие задачи. Для художественных текстов или сторителлинга это может быть преимуществом. Но если речь идет о пользовательской документации, инструкциях или reference-статьях, я пока все равно чаще выбираю Sonnet, а жрущий неимоверное количество токенов Fable пусть пока останется до лучших времен😼
У вас есть текст, идея книги или уже готовая рукопись? Давайте вместе сделаем так, чтобы о ней узнали читатели! 🟣25 августа стартует курс «Бренд автора» — для писателей художки и нон-фикшн, которые хотят, чтобы их книги читали, а издатели — звали. На курсе вы разберёте, как определить свою аудиторию, сформулировать авторское позиционирование, подготовить заявку в издательство, выстроить контент вокруг книги и поддерживать интерес читателей до и после релиза. ⭕️Отдельный блок посвящён ИИ: как использовать его для анализа, поиска идей, контент-плана и продвижения. ➖Формат — онлайн (потребуется выделить всего 30 минут в день!) ➖Длительность — 1,5 месяца. Для самых быстрых до 30 июня действует промокод brand на скидку 25%. Подробности на сайте.
Всем привет! Не так часто рекомендую что-то в канале, но здесь, как мне кажется, действительно есть на что обратить внимание. Несмотря на то, что курс ориентирован на авторов книг, многие темы будут полезны и техническим писателям: работа с текстом, структурирование информации, понимание своей аудитории и, что особенно интересно, отдельный блок по использованию AI в работе. Сейчас умение грамотно взаимодействовать с AI становится таким же рабочим навыком, как когда-то стали Git, Figma или Markdown. Поэтому думаю, что каждый сможет почерпнуть для себя что-то полезное. Смотрите пост ниже👇
Недавно столкнулись с интересной задачей. С декабря мы фактически не выпускали релиз-ноутсы. Не потому что про них забыли - просто планировалось пересмотреть формат, а потом, как это часто бывает, появились более приоритетные задачи. И вот спустя примерно полгода бизнес снова вернулся с запросом: релиз-ноутсы все же нужны 🫠 Проблема была в том, что нужно было быстро восстановить историю изменений за несколько месяцев. Вручную просматривать сотни тикетов и собирать ключевые доработки - удовольствие сомнительное. В итоге решили попробовать использовать Claude AI. В Jira есть раздел Releases, где можно посмотреть список релизов и связанных с ними задач. Через коннектор загрузили эту ссылки на релизы в Claude и попросили его выделить наиболее значимые изменения по каждому релизу. Например баг фиксы сразу отметаем - изменения слишком мелкие и технические. Конечно, результат нельзя публиковать без проверки. Но в качестве первого прохода инструмент оказался очень полезным: вместо просмотра большого количества тикетов мы получили уже предварительно структурированный список изменений. Дальше оставалось сгруппировать информацию по месяцам, проверить формулировки и собрать всё в презентационный формат (в принципе клод и презентацию может сделать, но все же не всегда получается так как надо). Для меня это ещё один хороший пример того, как AI помогает не заменить работу техписателя, а убрать самую рутинную и неприятную её часть. Так что, вместо того чтобы тратить часы на поиск информации, можно быстрее перейти к анализу, структурированию и подготовке контента для пользователей 😊
У вас есть опыт, который достоин книги❤️ Бизнес-решения, рабочие методики, управленческие находки. Всё это может стать нон-фикшн текстом, который читают, цитируют и используют на практике. Курс-практикум «Мастерская писателя» поможет написать не художественный роман, а текст, который доказывает вашу экспертность и усиливает вас в профессии. ⭐️Набор уже идет, начинаем 18 мая! Вопрос только один: хотите, чтобы опыт остался в головах тысяч читателей или только в черновиках? 📎Все подробности о курсе собрали по ссылке. До встречи!
Всем привет! Наткнулся вот такой курс по тому, как правильно описать свой опыт и обернуть его в интересную книгу для широкого круга читателей)
Когда документация превращается в свалку Обычно это происходит не сразу, а постепенно. Разные по смыслу статьи оказываются рядом и начинают дублировать или подменять друг друга. Вроде бы это overview — но внутри уже есть куски инструкции. Или это описание интерфейса — но внезапно появляются шаги «что нажать». 🤪 В итоге на уровне UI получается набор статей с размытыми границами: не до конца понятно, куда идти за ответом и чего ожидать от конкретной страницы. Недавно разбирал нашу базу знаний после внешнего ревью. Фидбек был довольно точный: тексты местами звучат так, будто они написаны «в целом про продукт», а не для человека, который хочет быстро решить конкретную задачу. Одно из решений, которое заметно упростило жизнь — жестко разделить типы статей: - Overview — что это вообще такое. Одна статья на сервис, коротко, без деталей. - Reference — как устроен конкретный экран или раздел. Что здесь есть и зачем. - How-to — как выполнить конкретную задачу. Чёткие шаги, без лишнего контекста, то есть те самые приесловутые happy paths 🤩 Звучит вроде как очевидно, но без явного разделения всё это быстро смешивается — и пользователь либо не находит нужное, либо читает в три раза больше, чем нужно. Параллельно собрали небольшой стоп-лист из ~12 фраз, которые не нужно юзать в статьях, и с помощью Claude AI выработали скилл для пруфридинга: прогоняешь текст — получаешь структурированный фидбек с конкретными замечаниями. И, пожалуй, главный вывод: проблема чаще не в том, что люди плохо пишут. А в том, что нет договорённости — что именно мы пишем и для кого. 🌚
Техрайтер-интроверт, когда написал сообщение держателю знаний, мол "подскажи, а вот тут у кнопочки такой туллтип, напиши плиз, что имелось в виду", но вместо короткого ответа буковками в слаке он пишет "давай созвонимся на пару минут, объясню" 😩
🚀 Техписатель: старт и прокачка. Эксклюзивный митап для своих! Мечтаете навести порядок в документации или только присматриваетесь к профессии? 22 апреля собираемся, чтобы разобрать карьерный трек, портфолио, работу с ИИ, а также простые принципы составления эффективной документации. В программе 4 эксперта-практика: 🔹 Арина Балерина (Ментор техписателей, ex-руководитель разработки техдокументации ВКонтакте) “Кто такие техписатели. Как понять, что это ваше. Как стать одним из них” 🔹 Екатерина Павлова (CPO Gramax, спикер конференций - WriteConf, TechWriter Days, Techdoc Meetup) “Мастер-класс: создаем сайт-визитку и портфолио в Gramax” 🔹 Дмитрий Развозжаев (Технический писатель в Ximi Data, автор тг-канала Техниндзя) “ИИ в работе техписателя (тема уточняется)” 🔹 Константин Макушев (Старший технический писатель, Т-Банк) “Паттерны и антипаттерны текста документации” Когда: 22 апреля в 16:00 (МСК) Где: Online Стоимость: Бесплатно Важно: Группа ограничена - всего 30 мест, чтобы сохранить формат живого общения. Успейте занять место: https://clck.ru/3SsJF5
Коннекторы в Claude AI: небольшой, но полезный инсайт Не знаю, как у вас, но я сам про это узнал относительно недавно — и немного удивился, насколько это упрощает работу. Речь про коннекторы в Claude AI. С их помощью можно дать Claude доступ к рабочим источникам (например, Confluence и Jira), и он уже не просто будет отвечать в вакууме, а работать с реальными данными. Например, можно: — подтянуть содержимое тикетов из Jira — проанализировать упоминания фичи в Confluence (главное не увлечься и не перетумачить токены!!! 😁) — собрать структурированный документ: overview, how-to или черновик гайдлайна. Дальше становится ещё интереснее, если использовать это вместе с Claude Skills. Это файл с инструкциями, который обучает Claude AI выполнять определенную задачу по имеющимся у вас в команде правилам. В этом случае результат будет не просто «как получилось», а уже ближе к вашему формату — с нужной структурой, тоном и логикой подачи. По сути, получается такой рабочий процесс: собрал данные через коннектор → получил черновик по правилам из скилла → проверил → добавил скриншоты → готово. Понятно, что это не замена полноценной проработки, но как способ ускорить подготовку первого драфта — Not bad 😎 Если вы уже используете, расскажите как именно 😉 Если нет — возможно, стоит попробовать на каком-нибудь не самом критичном сценарии.
Внедрение AI В компании начинается более системное внедрение инструментов AI в повседневную работу. В частности, активно осваиваем Claude AI - как для повседневных задач, так и для более сложных сценариев. На первом этапе многие используют его как помощника: — для работы с текстами, — для анализа информации, — для быстрых черновиков и структурирования идей. Но дальше планируется двигаться ещё глубже — постепенно вводить суб-агентов Claude, которые смогут автоматизировать часть потоковых процессов, например сборку release notes. По сути, это маленькие специализированные AI-помощники, которые берут на себя повторяющиеся задачи и экономят время. Чтобы быстрее освоиться с инструментом, можно посмотреть бесплатные курсы от Anthropic. Там разбирают основы работы с Claude, принципы эффективных промптов и разные практические сценарии использования: https://anthropic.skilljar.com/ Даже если вы уже используете AI в работе, там можно найти несколько полезных идей и приемов. Иногда небольшая корректировка подхода к промптам заметно меняет результат 😉
Стажировка для Technical Writing в Kaspersky — курс на мастерство! Как прокачать скиллы технического писателя и научиться превращать сложные технологии в понятные тексты? Пойти на стажировку в Kaspersky! Доступно для студентов невыпускного курса любых вузов в Москве и МО 🧑🎓 В одной лодке с профессионалами Kaspersky ты научишься: • разрабатывать документацию для различных бизнес-процессов компании • описывать сложные технологии понятным и доступным языком для разных аудиторий • грамотно собирать информацию у экспертов, анализировать ее и подготавливать для дальнейшей работы Тебя ждут реальные проекты и практика в международной компании, удобный график от 20 часов в неделю, конкурентная зарплата, компенсация питания, спортзал, сауна и многое другое ⚓️ Держи курс на мастерство и подавай заявку: https://kas.pr/c53f
How-to и квизы Мы продолжаем развивать нашу базу знаний. Если раньше мы в основном делали описательные статьи, т.е., что это за сервис, какие есть функции, где что находится. А сейчас постепенно переключаемся на формат how-to. После консультаций с бизнес-аналитиками мы выработали конкретные сценарии: что сделать, в какой последовательности, на что обратить внимание. Еще полезно было поговорить с командой саппорта, потому что они в курсе основных "болей" пользователей, т.е., того, что они чаще всего спрашивают и репортят. В целом, такие статьи требуют больше времени - нужно обсудить реальные процессы, задать уточняющие вопросы, иногда переиначить структуру под конкретный how-to. Но результат получается гораздо ближе к реальному использованию продукта. Параллельно появилась ещё одна идея - добавить в базу знаний небольшие квизы по темам 🎯 Не как обязательный экзамен, а как опциональный инструмент: прочитал статью, и при желании можешь проверить себя. Это помогает: - закрепить материал - увидеть, что осталось непонятным - чуть глубже вовлечься в тему По сути, база знаний перестаёт быть просто «справочником» и начинает работать как элемент обучения. Век живи век учись 😁
🚀 27-28 марта 2026г. в Москве пройдет TechWriter Days 3 — международная конференция для технических писателей. Для вас подготовлена интересная программа, где вас ждут 48 докладов и мастер-классов, 2 дня профессионального общения с 400+ участниками из сотен компаний СНГ, полезные инсайты и новые знания! ⚡️программа ⚡️ билеты ⚡️ афиша ⚡️ скидки ⚡️ видео
Как мы готовим базу знаний к демо для руководства Когда база знаний начинает выходить за рамки внутреннего эксперимента и готовится к демо для более высокого уровня, важно не просто «дописать ещё пару статей», а выстроить понятную последовательность действий. Сейчас мы для себя видим такой подход: Первый шаг - привести в порядок то, что уже есть. Проапдейтить тексты, заменить устаревшие скриншоты, пересобрать визуалы по новому воркфлоу обработки скриншотов - в фигме (можете почитать про нашу работу в фигме здесь и здесь). Документация должна выглядеть цельно и, оф корс, быть актуальной 😀 Следующий шаг - закрывать базовый уровень документации. Речь про overview-страницы по ключевым сервисам, которые потенциально могут попасть в демо. Не все компоненты одинаково важны на этом этапе: сугубо технические или второстепенные вещи можно сознательно отложить, чтобы не распыляться и не жертвовать качеством в более важном 😼 Параллельно с этим - начать описание реальных сценариев использования. Чтобы база знаний выглядела живой и убедительной, важно показать не только «что это за продукт», но и как им реально пользуются юзеры. Для этого нужны совместные сессии с бизнесом и описание ключевых воркфлоу, хотя бы для самых важных направлений. Это смещает фокус документации от абстрактных описаний к практическим кейсам. И важный момент 🫵: Не стоит ждать, пока будут идеально закрыты все overview-страницы, прежде чем идти в сценарии. Работать над ними стоит параллельно, потому что рано или поздно за базу знаний спросят, и показывать ее без реальных юзкейсов ну как-то не катит.
Всех с наступающим новым годом! Помимо стандартных щастья-здоровья желаю всем вам душевного спокойствия, уверенности в себе и своих силах, и неотступного следования своим целям и иделам, будь то работа, личная жизнь, хобби и тд. До встречи в следующем году! 🎄🎄🎄