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

Техписалити! Спасибо Мы подумали — а почему у нас до сих пор нет своей, техписательской, награды? Так много людей делают крутые вещи! Пора это исправить) (в этом посте много длинного тире, но это не генерация)) Представляем вам Техписалити! Спасибо — награду, которую будем вместе с вами присуждать каждый год в разных номинациях. Этот случай — особенный, без номинаций. Мы хотим отметить заслуги не только за прошедший год, но и сказать спасибо тем, кто уже давно помогает профессии расти. Техписалити! Спасибо — это и есть наше общее большое спасибо) Итак, благодарность получает: ⭐️ Семён Факторович — за курс Техническая документация в IT-проектах на YouTube. ⭐️ Кира Калимулина — за курс Ozon Tech по UX-редактуре. ⭐️ Ник Волынкин — за создание DocOps-сообщества и продвижение подхода docs as code. ⭐️ Антон Гафаров — за курс Docs as code для самых маленьких. ⭐️ Денис Ребенок — за курс по документированию API. ⭐️ Елена Шляга — за квиз-канал QFE и за то, что прокачивает наши технические навыки. Отдельно хотим поблагодарить целые команды, которые делают наше сообщество сильнее. Команды, которые мы хотим отметить: ⭐️ Админов жёлтого чата и лично Арину Балерину и Александра Яковлева — за то, что создали и поддерживают систему хранения знаний. ⭐️ Команду technicalwriters.ru и лично Анну Костягину — за сайт, который стал настоящей базой знаний для всех технических писателей. ⭐️ Команды технических писателей Ozon Tech и X5 Tech — за организацию бесплатных митапов, где мы можем встречаться и учиться. Вы делаете наше сообщество лучше! Прикрепили персональные и командные Техписалити! Спасибо, оформление которых разработала наш дизайнер Светлана. 🧡 Это только начало. В следующем году будем выбирать победителей уже по итогам года. Дорогие подписчики, предлагайте номинантов, подавайтесь сами и следите за новостями. Спасибо, что были с нами. С Наступающим и до встречи в новом году! 🎄 #ТехписалитиСпасибо

Техписалити! Спасибо Мы подумали — а почему у нас до сих пор нет своей, техписательской, награды? Так много людей делают крутые вещи! Пора это исправить) (в этом посте много длинного тире, но это не генерация)) Представляем вам Техписалити! Спасибо — награду, которую будем вместе с вами присуждать каждый год в разных номинациях. Этот случай — особенный, без номинаций. Мы хотим отметить заслуги не только за прошедший год, но и сказать спасибо тем, кто уже давно помогает профессии расти. Техписалити! Спасибо — это и есть наше общее большое спасибо) Итак, благодарность получает: ⭐️ Семён Факторович — за курс Техническая документация в IT-проектах на YouTube. ⭐️ Кира Калимулина — за Курс Ozon Tech по UX-редактуре на YouTube. ⭐️ Ник Волынкин — за создание DocOps-сообщества и продвижение подхода docs as code. ⭐️ Антон Гафаров — за курс Docs as code для самых маленьких. ⭐️ Денис Ребенок — за курс по документированию API. ⭐️ Елена Шляга — за квиз-канал QFE и за то, что прокачивает наши технические навыки. Отдельно хотим поблагодарить целые команды, которые делают наше сообщество сильнее. Команды, которые мы хотим отметить: ⭐️ Админов жёлтого чата и лично Арину Балерину и Александра Яковлева — за то, что создали и поддерживают систему хранения знаний. ⭐️ Команду technicalwriters.ru и лично Анну Костягину — за сайт, который стал настоящей базой знаний для всех технических писателей. ⭐️ Команды технических писателей Ozon Tech и X5 Tech — за организацию бесплатных митапов, где мы можем встречаться и учиться. Вы делаете наше сообщество лучше! Прикрепили персональные и командные Техписалити! Спасибо, оформление которых разработала наш дизайнер Светлана. 🧡 Это только начало. В следующем году будем выбирать победителей уже по итогам года. Дорогие подписчики! предлагайте номинантов, подавайтесь сами и следите за новостями. Спасибо, что были с нами. С Наступающим и до встречи в новом году! 🎄 #ТехписалитиСпасибо

Техписалити! Спасибо Мы подумали — а почему у нас до сих пор нет своей, техписательской, награды? Так много людей делают крутые вещи! Пора это исправить) (в этом посте много длинного тире, но это не генерация)) Представляем вам Техписалити! Спасибо — награду, которую будем вместе с вами присуждать каждый год в разных номинациях. Этот случай — особенный, без номинаций. Мы хотим отметить заслуги не только за прошедший год, но и сказать спасибо тем, кто уже давно помогает профессии расти. Техписалити! Спасибо — это и есть наше общее большое спасибо) Итак, благодарность получает: ⭐️ Семён Факторович — за курс Техническая документация в IT-проектах на YouTube. ⭐️ Кира Калимулина — за Курс Ozon Tech по UX-редактуре на YouTube. ⭐️ Ник Волынкин — за создание DocOps-сообщества и продвижение подхода docs as code. ⭐️ Антон Гафаров — за курс Docs as code для самых маленьких. ⭐️ Денис Ребенок — за курс по документированию API. ⭐️ Елена Шляга — за квиз-канал QFE и за то, что прокачивает наши технические навыки. Отдельно хотим поблагодарить целые команды, которые делают наше сообщество сильнее. Команды, которые мы хотим отметить: ⭐️ Админов жёлтого чата и лично Арину Балерину и Александра Яковлева — за то, что создали и поддерживают систему хранения знаний. ⭐️ Команду technicalwriters.ru и лично Анну Костягину — за сайт, который стал настоящей базой знаний для всех технических писателей. ⭐️ Команды технических писателей Ozon Tech и X5 Tech — за организацию бесплатных митапов, где мы можем встречаться и учиться. Вы делаете наше сообщество лучше! Мы прикрепили персональные и командные Техписалити! Спасибо, оформление которых разработала наш дизайнер Светлана. 🧡 Это только начало. В следующем году будем выбирать победителей уже по итогам года. Дорогие подписчики, предлагайте номинантов, подавайтесь сами и следите за новостями. Спасибо, что были с нами. С Наступающим и до встречи в новом году! 🎄 #ТехписалитиСпасибо

Всем привет! Сегодня у нас интерактивная и предновогодняя #мемница В этом году мы решили вернуться к нашему новогоднему техписательскому бинго. Если вы с нами давно — вы его можете вспомнить, закрасить квадратики и сравнить результаты с прошлогодними. Мы внесли незначительные правки, но они не должны сильно повлиять на результат. Если вы с нами недавно — просто наслаждайтесь этим бинго 😊 Забирайте и делитесь с коллегами! А в комментах можете показать, какие страйки вы выбили 🙂 PS: а кое-что новенькое мы оставили на понедельник, так что не переключайтесь!

#вопросвлоб Всем привет! В рубрике "Вопрос в лоб" мы обычно разбираем частые вопросы на собеседованиях, но на этот раз поговорим немного о другом, не отходя от темы. Как изменился наём техписателей за последние годы? Сразу оговоримся, что здесь мы обобщаем собственный опыт и не говорим о найме ГОСТ-техписателей, поскольку его не ведём. Если у вас есть информация об этом сегменте рынка труда, поделитесь, пожалуйста, в комментариях. 📌 Легко вкатиться в IT — всё Техническая документация — это больше не та сфера, куда можно попасть верхом на одной лишь мотивации и стремлении помогать людям, как было 3-4 года назад. Требуются технические навыки. 📌 Техписатель — известная сущность По-прежнему встречаются компании, для которых техписатель — это диковинка. Но гораздо больше стало тех команд, где точно знают, кто такой технический писатель и для чего он нужен в этой конкретной команде. 📌 Без джунов Компании ищут не специалиста, а решение проблем. Поэтому чаще нужны самостоятельные единицы, которые готовы предложить своё решение, внедрить новые процессы. А это грейд middle и выше. Место джунов чаще всего замещают стажёры: они дешевле обходятся компании, и после стажировки работодатель получает самостоятельных junior plus или pre-middle, которые стоят дешевле обычных мидлов со стороны и уже могут приносить пользу бизнесу. 📌 Управленческие скиллы От техписателей ожидают не только ведение процесса, но и на будущее или настоящее — управление командой, организация коммуникаций с участниками различных команд. А это: планирование работы, искусство обратной связи, развитие компетенций коллег. С этим на рынке как будто сложновато. 📌 Смещение компетенций Общий тренд на пресловутый ИИ привёл к изменению ландшафта компетенций (ух, как мы завернули!). Сейчас мало писать текст, важно уметь использовать все доступные инструменты для достижения цели. А какие вы наблюдаете изменения?

#мемница

#выпуск 21 Всем привет! Когда мы тонем в рутине, хочется найти способ ускорить свою работу. Поэтому предлагаем обсудить: Как писать документацию быстрее 1️⃣ Пишите для себя в будущем Казалось бы, на первом месте должны стоять генерация или автоматизация, но мы предлагаем отталкиваться от лайфхака по поиску цели. Если вам сложно определить целевую аудиторию, пишите для себя: представьте, что вам через год или больше придется снова вернуться к этой теме. Какую бы вы информацию оставили самому себе? Это позволит вам понять, что и как писать, и как лучше составить промпт, если вы используете генерацию. 2️⃣ Используйте шаблоны Разработайте шаблоны, подходящие именно для вашей документации. С ними вы сможете писать быстрее, преодолевая проблему чистого листа, а ваши читатели — искать нужную информацию в определённых разделах или блоках. Чтобы ускорить создание шаблонов, используйте ИИ, но обязательно проверьте сгенерированные тексты и схемы. 3️⃣ Ускорьте создание текста В инструкциях используйте пирамиду Минто: изложите сначала главную мысль или цель, для чего нужны последующие действия, а затем излагайте их. Такой метод подходит для большинства типов документации. Придерживайтесь его, и вы потратите гораздо меньше времени на раздумья. А для написания текста настройте инструменты ускоренного ввода, например сниппеты для VS Code, и используйте горячие клавиши. 4️⃣ Автоматизируйте всё, что можно автоматизировать Изучите, как генерировать документацию API из openapi-спецификации или release notes из коммитов в гите. Настройте нейрогенерацию текста из исходников, собранных "автоматом". Обязательно проверяйте результат генерации. Да, этот пункт не простой. Взвесьте все за и против, прежде чем браться за него. (Мы взялись не за всё) 5️⃣ Настройте проверки Используйте спеллчекеры для проверки текста на ошибки и опечатки. Просматривайте логи, если используете генераторы сайтов. Это поможет исправить ошибки сразу и не тратить время на хотфиксы. А как вы ускоряете создание документации?

#мемница Всем привет! У нас тут назрел вопрос вселенского масштаба... О врачах, юристах, детективах, космонавтах сняты сотни культовых фильмов. И о программистах, и об учителях, и о переводчиках! Но где фильм про технических писателей? Мы, между прочим, живём тоже вполне насыщенной (а порой и весьма драматичной) жизнью: ⚡️спасаем релизы, когда важную фичу добавили в самый последний момент ⚡️достаём информацию, когда, казалось бы, она безвозвратно утрачена ⚡️выживаем во время созвонов, когда фраза «Это всё нужно будет задокументировать» звучит как угроза жизни ⚡️порой находим баги раньше QA (не гордимся, но и не отрицаем это) Так что материала для сценария более чем достаточно... Но пока вместо фильма у нас есть лишь небольшая подборка мемов с актёрами, которые могли бы сыграть в этом фильме🎥 Давайте посмотрим (не забудьте заглянуть в комментарии к посту!) и будем вместе продолжать мечтать о том дне, когда на большом экране кто-то наконец скажет: «Они спасли релиз. Никто не заметил, но это важно.»🦸

#мемница

#twd3 Всем привет! Мы с новостями об одной из крупнейших конференций для техписателей — TechWriterDays#3, которая пройдёт 27-28 марта следующего года в Москве. На днях программу конференции обновили, она почти готова. Ещё будет дополняться секция С второго дня. Напомним, что канал Техписалити! снова стал информационным партнёром конференции. На этот раз накануне мы разыграем среди наших подписчиков один офлайн-билет.🤗

#мемница

#мемница

#анонс Всем привет! Друзья, мы впервые анонсируем новый митап - Tech Writing Winter Jam, который пройдёт 3 декабря в башне ОКО в Москва-сити. На наши вопросы ответил организатор митапа, devrel компании ИнфоТеКС Стас Доброхотов. - Стас, ты продвигаешь бренд в области аналитики, почему появилась идея организовать митап для техписателей? - Это в первую очередь личный челлендж. Наши технические писатели помогают не только ребятам из разработки, в том числе аналитикам, но и вычитывают статьи для HR-бренда. Я много общался с ними в процессе работы и понял, что им не меньше других направлений хочется встречаться, общаться, делиться рабочими практиками, но чаще всего у компаний нет на это фокуса. Захотелось это изменить. Отсюда цель: создать площадку для общения, разгрузки и обмена опытом. Наём мы сейчас не ведём, так что никаких скрытых замыслов) - Этот митап - начало чего-то нового? - Сейчас трудно сказать, но я бы хотел проводить его дважды в год. - Главный вопрос, который обычно задают организаторам митапов, - запись будет? - Есть пока технические моменты на площадке, которые мы думаем, как победить 🙂 Не обещаю, но будем стараться решить этот вопрос. _______________ А теперь о самом митапе: Yandex.Cloud, Avito.Tech и ИнфоТеКС собирают технических писателей на новогодний митап на 47 этаже башни ОКО (Москва-сити). Вход бесплатный, но нужно обязательно зарегистрироваться заранее. Организаторы просят: берите друзей, хорошее настроение и приходите заряжаться — будет полезно, весело и точно не банально! В программе: - Как избегать типичных ошибок и делать тексты понятнее. - Автолинтер на YandexGPT: экономим время на правках. - Работа с продуктовыми командами: как договориться и не перегореть. Вас ждут в башне ОКО 3 декабря в 19-00. Ссылка на регистрацию

#мемница

Привет! Недавно мы говорили о том, как собирать релиз ноты и кто решает, на какие задачи их стоит писать. А сегодня поговорим про внутренние релиз ноты и о том, для кого их пишут. Да, кажется, что ответ лежит на поверхности — релизы обычно пишут для пользователей, менеджеров, смежных команд, но… задумывались ли вы, что в ЦА релиз нотов могут входить и технические писатели? 😑 Три причины, почему техпису стоит следить за релиз нотами: 📌Синхронизация с продуктом Релиз ноты помогают проверить, что документация по новым фичам написана, а по старым — обновлена. Если релиз есть, а доки или задачи на такую доку нет — повод насторожиться и задуматься над процессами. 📌Помощь в написании статей Релиз ноты — это готовые абзацы для документации. А если в работе документация по большой фиче, информацию о ней также можно черпать из внутренних мелких релиз нотов. 📌Более глубокое понимание продукта Чем больше техпис знает об устройстве продукта, тем более полные и точные документы он может публиковать. Также, он может обнаружить несостыковки и задавать точечные вопросы, которые могут помочь не только в написании понятной доки, но и обнаружить баги. Поэтому не стоит забывать, что релиз ноты есть не только «внешние», но и внутренние, которые как раз помогают прокачать свои знания о продукте. А вы следите за релиз нотами, которые не пишете самостоятельно?

#мемница

#предложка Всем привет! У нас новая рубрика, в которой мы отвечаем на ваши вопросы в чат канала. И у нас уже есть первый вопрос 😎 Кто решает, какие задачи попадают в Release Notes?

— Кто должен решать, какие задачи попадают в релизноты? Продакты или техписатели? На мой взгляд, продакт решает что включить, техписатель решает как подать. Интересно узнать, как оно у других.

Документация — это часть продукта, поэтому за неё тоже отвечает менеджер продукта. Именно он чаще всего определяет, что должно попасть в релиз. Даже в тех случаях, когда в список изменений входят абсолютно все задачи, менеджер продукта определяет, что нужно указать первым. Но бывают случаи, когда техписатели обладают большей экспертизой в общении с целевой аудиторией и могут самостоятельно определять приоритетность задач и то, что нужно рассказать, а что не следует. В вопросе как подать чаще всего руководствуются редполитикой и tone of voice (голосом продукта). А это уже артефакты технических писателей. Если никаких стандартов нет, стиль предлагает технический писатель. В больших продуктах, которые состоят из множества связанных между собой сервисов со своими менеджерами, за состав релизнота могут отвечать другие специалисты. Рассказывает лид UX-редакторов приложения Wildberries Валерия Железова: — Мы накидываем идеи вместе с релизными менеджерами. Очень часто релизы состоят из улучшений, про которые на всех не расскажешь: это либо очень технические вещи, либо то, что раскатывается не на всю аудиторию. Поэтому многие, даже почти все используют отписки в духе «улучшили производительность, ускорили приложение, пофиксили баги». Ну а мы стараемся это разнообразить, чтобы те, кто такие штуки читает, хотя бы улыбнулись. Для примера один из Release Notes приложения Wildberries для Google Play Market:

Что общего между Wildberries и аптекой? Во-первых, после них становится как-то полегче. Во-вторых, и там, и там продают лекарства. В каталоге появился раздел «Еаптека»: там можно заказать всё для здоровья с доставкой в ближайшую аптеку, курьером или в отделение Почты России. Мы вот уже закупились гематогенками, а заодно исправили ошибки, улучшили производительность и вообще сделали всё, чтобы приложение не болело.

А как организован процесс создания Release Notes у вас?

#мемница

#мемница