Техписалити! – Telegram
Техписалити!
1.91K subscribers
174 photos
16 videos
89 links
Первая открытая школа технических писателей

Пишут Лида Туляганова, Маша Щеблякова и Катя Марченко
Download Telegram
😁39💯10👍4
#вопросвлоб

Всем привет!
Под этим тегом продолжаем разговор о том, как проходит отбор кандидатов. И сегодня наша тема


Всратые собеседования

Да-да, некоторые собесы действительно могут такими показаться. Обычно вопросы у нас нормальные, но когда есть сомнения, мы переходим в режим турбо😎

Внимание, вопрос:

Вы сидите на кухне и хотите поесть, но самостоятельно приготовить не можете. Заходит инопланетянин. Ваша задача — объяснить ему, как приготовить бутерброд и подать его на стол.


🤯 - ЭЭ, чё за инопланетяне, вы чё за контора вообще?

Инопланетянин нам очень помогает. Это олицетворение пользователя, совершенно не погруженного в продукт. Он не знает, что такое хлеб, колбаса, не знает что такое бутерброд. Но ваша задача сделать так, чтобы у него всё получилось.

Итак, какие умения помогает выявить этот вопрос:

1. Работать в стрессовой ситуации и не сдаваться перед непонятной задачей.
2. Определять цели.
3. Определять целевую аудиторию, степень её погруженности.
4. Выстраивать структуру документации и определять содержание.
5. Выбирать стиль изложения, исходя из особенностей целевой аудитории.

Вот такой полезный инопланетянин😆

А какие странные вопросы задавали вам?
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥21👍3😁3
#писалитирекомендует

Всем привет!
Совсем скоро пройдёт Первая Международная конференция технических писателей TechWriter Days — 5-6 апреля 2024 в Москве. Мероприятие состоится в гибридном формате - офлайн + онлайн-трансляция.

2 дня, 3 параллельные секции, 50+ докладов и мастер-классов — участники обсудят актуальные темы, тенденции и лучшие практики в области создания технической документации и коммуни️кации в технических сферах.

Доклады ориентированы на разный уровень подготовленности участников.

✏️ Например, начинающим расскажут, как новостные дайджесты могут сделать работу технических писателей более видимой, а опытным — как быстро развернуть документацию в Sphinx и почему технический писатель - это лучший друг QA-инженера и руководителя проектов.

Подробнее об этих и других выступлениях - на сайте конференции.

💥 Бонус для подписчиков — скидка 15% на билеты по промокоду PISALITY.

Для удобства ссылки даём отдельно:
• билеты
• программа
• контакты организаторов.

P.S. На этой конференции Семён Факторович представит результаты большого исследования, которое его команда проводила с начала года.
Обращайте внимание на уровень аудитории доклада.
P.P.S. Школа Техписалити! в лице одного из админов участвовала в программном комитете конференции.
🔥23👍6🤝3🍓1
😁58🔥10
#практика

UPD: задание улетело, как горячий пирожок😉
Ну, не унывайте, ещё найдется)


Прошу минутку внимания!)

Начинающие техписы, которые бы хотели сконтрибьютить в опенсорс, отзовитесь)
Есть автор одной утилиты, который бы не отказался от помощи в написании небольшой инструкции) но сроки чуть поджимают)
Писать мне (Лиде) в личку @litulyagan
13
#писалитирекомендует

Всем привет!

18 апреля в 19:00 X5 Tech проведёт в Москве четвёртый Techdoc Meetup! В программе доклады на актуальные темы: использование ИИ, выстраивание процессов и даже... личных границ! А завершится всё ставшим уже традиционным круглым столом.

Мероприятие будет проведено очно. Подробности, билеты и программу митапа ищите тут ✍️

А для тех, кто не сможет присутствовать лично, будет трансляция на YouTube 🎥
🔥1543
😁49
😁48💯7😭4
Техписалити!
#практика UPD: задание улетело, как горячий пирожок😉 Ну, не унывайте, ещё найдется) Прошу минутку внимания!) Начинающие техписы, которые бы хотели сконтрибьютить в опенсорс, отзовитесь) Есть автор одной утилиты, который бы не отказался от помощи в написании…
#такбывает
Всем привет!

Зафиксирован случай контрибуции техписателя в документацию опенсорсного продукта!

Недавно мы искали желающего, кто может срочно помочь разработчику. Техписатель-джун Полина Клименко согласилась помочь и написала инструкцию для утилиты mdis, которая позволяет "вытаскивать" актуальные примеры из кода.

Мы побеседовали с Полиной о её работе и попросили поделиться, на что стоит обратить внимание при работе над документацией в опенсорс.

Ответ был так хорош, что мы решили разместить беседу полностью. Приятного чтения!

А ещё это наша первая публикация в телетайп. Ставьте реакции, если формат зашёл!
🔥379👏6🏆2👍1
😁3412💯9
Всем привет!
Мы публикуем всякие полезности разного уровня, но всё-таки Техписалити! — это открытая школа техписов, и здесь мы погружаем в профессию ещё и начинающих с нуля.

Именно для таких подписчиков мы запускаем новую рубрику — #средаразработки, в которой знакомим новичков с IT-лексиконом и рассказываем, когда техписатель может с ним столкнуться.

И особое очарование в том, что #средаразработки будет выходить по средам! 😉
Please open Telegram to view this post
VIEW IN TELEGRAM
👍226🥰4🔥2👌1
Если онбординг хранится в виде документации, технический писатель может помочь составить и поддерживать его актуальность.

В онбординговых статьях обычно собирают:
📌 Первые действия, которые должен сделать новичок.
📌 Ссылки на полезные материалы — например, регламент релизов.
📌 Описание и ссылки на тестовые стенды, репозитории, метрики, чаты, а также информация, как получить к ним доступ.

Но на самом деле все онбординги вариативны и зависят от команд и их потребностей.

#средаразработки
👍12🤝76🔥3
😁45💯6🔥3
Сказ о том, как три филологические девы стали техножрицами... или who is who)🧐

Всем привет!

За последнее время у нас в канале появилось много новеньких, и мы решили сделать то, что обычно делают в таких случаях - опубликовать пост-знакомство. Просим любить... ну или хотя бы не жаловаться)

Лида - технический писатель Wildberries (между прочим, первый представитель этого редкого вида в корпорации!), амбассадор WB в белгородских вузах, а также идейный вдохновитель этого канала! У нее за плечами 20 лет опыта работы с текстами, из которых 9 - в журналистике. А теперь Лида знает не только как в одиночку развернуть документацию с нуля (на минуточку, используя docs-as-code!), но и как собеседовать и нанимать техписателей. Прочитать о том, как Лида пришла в техписательство, можно здесь.

Маша - технический писатель Ozon (да-да, работа в соперничающих корпорациях дружбе не помеха!). Профессиональный редактор, мечтавший когда-то стать программистом. Под её руководством одно из крупнейших издательств страны выпускало детские книги, среди которых - крутой сборник головоломок! А сейчас Маша не только пишет внутреннюю документацию для разработчиков, но ещё придумывает новые рубрики и виртуозно создаёт большинство мемов для этого канала. О том, как Маша стала техписателем, читайте тут.

Катя - технический и UX-писатель Лаборатории Касперского. В прошлом переводчик в нефтегазовой отрасли, теперь создает пользовательскую документацию для b2c и b2b продуктов, а также работает с текстами интерфейсов (аж на целых двух языках!). В этом канале отвечает за языковое разнообразие. О карьерном пути Кати читайте здесь.

Все трое начали карьеру техписателей в одном из подразделений VK. С тех пор наши профессиональные пути немного разошлись... но мы по-прежнему вместе и пытаемся быть полезными для сообщества технических писателей и для тех, кто только собирается к нему присоединиться)

В комментариях расскажите о себе... а может даже о том, как тут оказались!✍️

P.S. А ещё нашему каналу недавно исполнился целый один год! Спасибо, что вы с нами! 🩵
68👍19🎉11🍓7👏1
😁68🔥7💯7
💯71😁36🤣12👍84
Если в компании используют подход Docs-as-Code, скорее всего, документация пишется и хранится в гите. Чем этот инструмент привлёк технических писателей?

📌С документами или проектом может работать сразу несколько человек.
📌Система хранит всю историю изменений и позволяет видеть, кто и когда их внёс, а также вернуться к любой из версий.
📌Перед итоговой публикацией нужно получить аппрув — это могут быть как вычитывающие коллеги, так и заказчики документации.
📌Систему можно настроить так, что править документацию сможет кто угодно, но без аппрува технического писателя на проде эти изменения не появятся.
📌Можно создавать отдельные версии документации. Удобно, если у продукта несколько версий, но хранить статьи только новейшей версии по каким-то причинам нельзя.

Когда первый раз видишь гит, может показаться, что это что-то сложное и непонятное. Но на самом деле это только кажется. Когда немного с ним поработаешь, понимаешь, насколько это удобный и простой инструмент! Но главное — не перепутать команды 😏

P.S. Мы максимально упростили описание и взяли только самые распространенные причины. Пишите в комментариях, за что вы любите или не любите гит

#средаразработки
Please open Telegram to view this post
VIEW IN TELEGRAM
👍234🔥32🤔2❤‍🔥1
#практика
Целевая аудитория: начинающие

Всем привет! Ну что, новички, соскучились по домашке?
Сегодня мы познакомимся с важным инструментом — системой контроля версий на примере GitHub.


😉 Git для самых маленьких

Для чего нужен гит? Если коротко, то в гите вся команда может работать над проектом одновременно, отслеживать все изменения и возвращаться к любой его версии.

Самая крупная сущность в гите — это репозиторий. Выглядит как главная, корневая папка со множеством папок и файлов внутри. Например, как наш крохотный учебный репозиторий.

Но это не простая папка, а золотая. Для того, чтобы работать в гите, начинающему техписателю нужно немного переформатировать сознание. Как — расскажем в следующих занятиях.😊

А пока предлагаем выполнить простое задание — зарегистрироваться на GitHub, кто ещё не)
Как это сделать? А вот тут примените навыки техписателя: умение находить информацию в свободном доступе и разбираться в чём-то самостоятельно.

Потом мы вместе отправимся знакомиться с гитом, шаг за шагом.

Как вам наша идея? Накидайте реакций или оставьте комментарии
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥45👍13💘622
Всем привет, на связи Маша 👋

Сегодня ещё один особенный день для канала — без двух дней год, как мы запустили рубрику #мемница. Рубрика выходила каждую пятницу, не считая праздничных, поэтому мы чуть-чуть не дотянули до 50 мемов 🙂

Как вы знаете (или не знаете), все наши мемы — авторские, а большую их часть сочиняю я. Как истинный творец, делаю это по ночам и кидаю коллегам-по-каналу на оценку. Лида любит называть эти ночи как «Город засыпает, просыпается Маша».

Иногда у меня случаются «творческие кризисы» и я готова сообщать, что рубрика закрывается. Но потом какой-нибудь неожиданный мем вызывает у вас сильный отклик, и это очень вдохновляет! Например, прошлый мем очень неожиданно для меня набрал больше ста реакций, я до сих не понимаю, как так вышло... Но после такого думаю и надеюсь, что всё не зря.

Спасибо вам за ваши реакты и комментарии! 💖
Please open Telegram to view this post
VIEW IN TELEGRAM
❤‍🔥25🔥105🏆3
❤‍🔥59😁21😘12😇5
🤣65😁16🥰6🔥4😨1