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

Пишут Лида Туляганова, Маша Щеблякова и Катя Марченко
Download Telegram
#анонс
Всем привет!

Конец лета — время, когда новые знания, кажется, так и витают в воздухе... Постарайтесь не упустить возможность прокачать профессиональные навыки и обменяться опытом с коллегами из других компаний) Да-да, речь о WriteConf — конференции по созданию контента в IT!

На мероприятии будут:

🔘 Доклады по внутренним и внешним текстам
🔘 Мастер-классы
🔘 Круглый стол
🔥 И даже «прожарка» кейсов!

Конференция будет проходить офлайн и онлайн. Подробности, программу и билеты ищите на сайте мероприятия.
❤‍🔥7
#циталити

Екатерина Ушакова
Канал Ушакова — директор буковок @ringova
1🔥43👍136
🤣59😁81
😭47🤣23💯16😁9😈2
#выпуск 20 #практика

Всем привет! Сегодня несём новичкам (и не только!) два отличных курса от наших коллег.

1️⃣ Docs as code для самых маленьких

Автор канала Parawriter Антон Гафаров рассказывает о парадигме docs as code и объясняет, как с нуля развернуть свою документацию.

2️⃣ Курс по проектированию и документированию API для технических писателей

Техписатель Денис Ребенок (канал @pro_techwriting) разъясняет, как описывать API и как затем опубликовывать API-документацию.

Давайте качать харды вместе! 😎
👍45🔥29122
😁53💯15🤣9😭32🔥1
44😁7
#анонс

Всем привет!
Нас попросили рассказать об одной конференции, и мы с радостью это делаем. И вот почему:

1. Это содержательная и полезная конференция для техписателей.
2. Много технины — то, по чему соскучились опытные коллеги. Ух, давно такое не анонсировали!
3. Это бесплатно. И можно подключиться онлайн — отличная возможность для техписателей из регионов. Если вы из Москвы или можете приехать в столицу, отлично — побываете в офисе СберТеха и позадаёте вопросы лично. Нетворкинг — наше всё)

А теперь конкретика (цитируем):

Doc Config 2025: как ИИ, скрипты и автоматизация меняют документацию

🗓26 сентября СберТех зовет на Doc Config 2025 — конференцию по технологичному документированию для разработчиков и технических писателей.

➡️О чем поговорим:

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

Вас ждут очно и онлайн!

🔗Посмотреть программу и зарегистрироваться
👍2610🔥6👏1
This media is not supported in your browser
VIEW IN TELEGRAM
#мемница

То самое ощущение, когда что-то делаешь, но результата (пока что) нет…
😁41💯22🔥9
#мемница
POV: когда окнули статью после тысячи этапов ревью
🤣87💯13🔥10
#писалитирекомендует
Всем привет!
Как найти работу, если нет опыта?

Да, намекаем на стажировки)

Мы уже рассказывали о стажировках в Озоне и Лаборатории Касперского. А теперь знакомим новичков с PTЛабс — это те самые Госуслуги)

Почитать о всей программе стажировок можно вот здесь. В этом году РТЛабс открыл набор и стажёров-техписателей.

С вопросами и резюме можно приходить к лиду техписателей в РТЛабс Марии Киселёвой @fintiplushka.
🔥106🌚2
#какэтоработает
Всем привет! Сегодня у нас маленькая, но очень важная тема:

Три правила хороших Release Notes

Release Notes — это описание изменений в продукте, которые появились после выпуска новой версии. Его называют релизнотами, а по-русски — описание релиза или список изменений (и ещё пара десятков названий на любой вкус).

Собирать релизноты — это целое искусство, но поделимся только 3 правилами, которых мы рекомендуем придерживаться.

1️⃣ Структурируйте информацию. Вы можете разделить текст на три условных части:
- Что нового
- Что доработано
- Что исправлено/удалено.

2️⃣ Пишите в мире пользователя: поясняйте, что для него изменится в продукте. Не рассказывайте, что сделала команда — говорите, что теперь сможет сделать пользователь. Например, вместо "доработали механизм группировки задач" поясните, что пользователь теперь может группировать задачи по важному для него признаку.

3️⃣ Не перегружайте release notes информацией. Оставьте только самое важное. Пользователю не обязательно знать, на сколько градусов изменилось закругление рамки вокруг блока.

И, конечно, публиковать Release Notes нужно вовремя, вместе с обновлением продукта. Но это уже совсем другая история)

Эти правила взгляд админов Техписалити! и касаются только пользовательской документации. Не соглашайтесь и делитесь своим опытом в комментариях)
👍4222🔥4
#мемница

В нашей профессии важно обучаться без пауз и быть внимательным на всех встречах с носителями знаний)

Поскольку сегодня День учителя, предлагаем в комментариях поделиться, у кого и какие знания вы перенимали)
😁7815👍3💯3🤗1
🤣60💯14😁10
#личныйОпыт

Статьи, которые мы не прочитаем

Всем привет!
Сейчас всё больше и больше опытных техписателей запускают собственные каналы. Один пост интереснее другого, одна статья полезнее другой. Пост — в Избранное, статью — в закладки. И так формируется целый "бэклог" публикаций, которые мы... скорее всего не прочитаем.

По крайней мере, с нами всё происходило именно так. И даже список статей мы назвали ровно так, как и этот пост.

Хватит это терпеть!

Давайте вместе найдём способ читать чуть больше и с пользой!

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

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

Например, вы описываете API в Confluence. Статьи о способах авторизации будут в зелёном спектре. А посты об описании API в парадигме docs as code — в синем.

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

А вы как решаете проблему бэклога статей? Поделитесь вашим подходом. А мы пока подольём масла в огонь и напомним об открытой базе знаний для техписателей, в том числе с книгами по профессии.
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥4013❤‍🔥5
1😁103💯36🤣235
😁54💯14🤣12😢6