Техписалити! @techpisality Channel on Telegram

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

@techpisality


Первая открытая школа технических писателей

Пишут Лида Туляганова, Маша Щеблякова и Катя Марченко

Техписалити! (Russian)

Добро пожаловать в Telegram-канал "Техписалити!" - первую открытую школу технических писателей. Здесь вы найдете самые актуальные и интересные статьи о техническом писательстве, написанные профессионалами Лидой Тулягановой, Машей Щебляковой и Катей Марченко. Этот канал призван помочь всем желающим развить свои навыки в области технического писательства, узнать о последних трендах и технологиях в этой сфере. Если вы хотите стать успешным техническим писателем, то "Техписалити!" - ваш идеальный партнер и наставник. Присоединяйтесь к нам прямо сейчас и откройте для себя мир профессионального писательства!

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

28 Dec, 09:00


#мемница
С наступающим Новым годом, друзья!🎄

Спасибо, что были с нами — учились, писали, дискутировали, смеялись, а некоторые даже коллаборировались)

Пусть в новом году правок будет меньше!

А в этом году контент для вас готовили:

⚪️ фея-крёстная техписов Лида
⚪️ повелительница мемов Маша
⚪️ мастер над запятыми Катя

а также создательницы визуального контента:

⚪️ хранительница джедайских дизайнерских приемов Света
(особенно благодарим за оформление #циталити и #средаразработки)
⚪️ юный падаван в сфере иллюстраторских искусств Камила
(наш маскот — именно её творение!)

До встречи в 2025!🩵

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

27 Dec, 07:00


Всем привет!

Сегодня у нас снова интерактивная и предновогодняя #мемница

Собрали для вас техписательское бинго не без приколдесов конечно 😄
Забирайте и делитесь с коллегами! А в комментах можете показать, какие страйки вы выбили 😏

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

20 Dec, 09:00


#мемница

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

19 Dec, 15:00


#twd2

Всем привет! Как и обещали, анонсируем розыгрыш онлайн-билетов от организаторов конференции TechWriter Days.

Напоминаем, что Вторая международная конференция технических писателей TechWriterDays пройдет 28-29 марта 2025 года в Санкт-Петербурге в офлайн и онлайн формате. Вас ждут 50+ докладов и мастер классов, 2 дня профессионального общения с 400+ участниками из компаний СНГ и новые знания)

❗️ А теперь о розыгрыше

Организаторы разыгрывают 3 офлайн-билета на конференцию TechWriter Days #2.

Как принять участие? Всё просто:
🔹Пройдите опрос «О чём хочешь доклад»
🔹Вступите в телеграм-группу конференции.

⚡️Итоги подведут 27 декабря в группе TechWriter Days❤️

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

18 Dec, 13:01


#какэтоработает

- Заходит продакт в бар к техписателям и говорит: "У нас завтра релиз, нужна дока!"

Всем привет! Бывает ли у вас так, как в этой грустной непридуманной шутке? Вот у нас бывало( Как избежать подобных ситуаций?

Раннее документирование

Shift-left документирование или документирование со сдвигом влево — называть этот процесс можно по-разному. Суть в нём одна: технический писатель приступает к описанию продукта как можно раньше.

Когда возможно раннее документирование?

1. Технический писатель интегрирован в команду: он знает продукт, представляет темпы работы команды, примерно понимает, к чему движется команда и у него есть доступ к доске с задачами.
2. В команде выстроены процессы: к задаче с фичёй или к эпику пишется чёткое, полное и протестированное задание. Как мы однажды выстроили процесс с докой, расскажем в одном из следующих постов.

Когда приступать к работе?

При раннем документировании техписатель составляет черновик документации на основании технического задания. Сделать это можно, когда разработчик даже ещё не взял задачу в работу. В этот момент можно:
*️⃣ определить место этой фичи в общей структуре документации,
*️⃣ установить её связь с другими функциональностями,
*️⃣ составить последовательность действий при разных сценариях.

После подготовки черновика нужно дождаться, когда задача перейдёт в стадию ручного тестирования, и тогда убедиться в корректности своих текстов и добавить недостающие скрины.

Какие плюсы и минусы?

Документация готова до релиза.
Техписатель может планировать и распределять свою нагрузку, если описывает несколько продуктов.
Он должен быть погружён в продукт, то есть поддерживать постоянную связь с разработкой.
Задача может не попасть в релиз. Но этого минуса нет, если используется docs-as-code и подход одна фича — одна ветка. Просто вольёте эту ветку в нужный релиз.

А вы пробовали такой подход? Какие минусы заметили ещё?

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

16 Dec, 09:00


#twd2

Всем привет!

Делимся новостью: канал Техписалити! стал информационным партнёром предстоящей конференции технических писателей TechWriterDays#2.

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

🧐 - А как это отразится на канале?

Раз в две недели будут выходить специальные посты с тегом #twd2. В них мы будем рассказывать о том, как найти тему для доклада, как повысить шансы попасть в программу, о том, с какими докладами выступят на конференции наши коллеги и как они готовятся к выступлению — в общем, инсайды и инсайты, и всё то, что интересно и вам, и нам самим.

В комментариях или в личку задавайте любые вопросы о конференции, мы обязательно вернёмся с ответами.

А чуть позже анонсируем розыгрыш онлайн-билета от оргкомитета конференции.❤️

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

13 Dec, 09:01


#мемница

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

10 Dec, 09:00


#колонкаредактора #twd2

Техписатель и ИИ

Всем привет!
Полночи — и, хоть и с недочётами, попытку оживить маскота Техписалити! можно считать успешной) Позвольте немного "бумерского" восторга: возможности современных нейросетей удивляют.

Но как они влияют на работу техписателя? Какой он — AI/ML-техписатель? Разумеется, речь не о том, как писать тексты с помощью нейросети.

На конференции TechWriterDays#2, которая пройдёт весной, ожидается ключевой доклад Семёна Факторовича "Техписатель—2025". Внутри — подкреплённые результатами большого социологического опроса размышления о том, кто мы, какие мы сейчас и какие будем, в том числе, какое влияние на нашу профессию окажет эта новая предметная область.

Секции с докладами об ИИ уже стали привычным делом: в программе конференции доклады о нейромоделях, нейролинтерах.

Если вы не можете ждать весны и хотите послушать про ИИ уже сейчас, приходите на митап в Ozon сегодня, 10 декабря, в 19-00. Мест оффлайн не осталось, но можно подключиться к трансляции.

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

06 Dec, 09:02


#мемница

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

04 Dec, 09:01


#какэтоработает
Всем привет! Сегодня поговорим о том, с чем техписатели чаще всего не работают, но что всё равно находится в их сфере влияния, и поделимся полезным шаблоном.

Постмортем. Что это и для чего

Как видно из названия, постмортем — это артефакт, который появляется после критической ситуации, инцидента.

Инцидентами называют событие, при котором сервис частично или полностью недоступен или работает, но совсем некорректно.

Мессенджер упал — это инцидент, потому что сервис недоступен.

В одном из маркетплейсов покупательница смогла заказать товаров на 17 миллионов и получить их без оплаты — это инцидент, потому что сервис работает, но совсем не так, как должен.

Постмортемы позволяют выявлять причины инцидента и делать так, чтобы в будущем он не возникал или чтобы был не настолько сложным.

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

*️⃣Кто пишет постмортемы

Постмортемы пишут инженеры, которые устраняют инцидент и его последствия.

*️⃣Как участвуют техписатели

Техписатели могут предлагать шаблоны в помощь инженерам, структуру хранения постмортемов и, если это требуется, участвовать в их создании во время и после инцидента.

❗️На прошлой неделе мы анонсировали подкаст о постмортемах. Техписалити! совместно с одним из участников подкаста - Кареном Товмасяном, Senior Engineer в Payments @ Uber и автором канала Человек и Машина, разработали шаблон постмортема на основе открытых данных. Этот шаблон можно забирать, адаптировать и использовать бесплатно.

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

04 Dec, 09:01


#средаразработки

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

29 Nov, 12:01


#анонс

Всем привет!

Всего через несколько часов у ITRadio в гостях будет Карен Товмасян (Senior Engineer в Payments @ Uber и автор канала Человек и Машина). Говорить будут о том:

🔹 как писать слово «инцидент»
🔹 чем отличается инцидент от аварии, алёрта или бага
🔹 что происходит в процессе починки, чем postmortem отличается от обычного отчёта об аварии.

Ещё и офигительных историй на десерт обещают!

Трансляция будет здесь и тут сегодня, 29.11.2024, в 17:00 по московскому времени.

Подробнее о подкасте читайте на сайте и канале ITRadio.
(А ещё там можно вопросы задавать!)

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

29 Nov, 09:01


#мемница

Я — техпис, во мне сто лиц!

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

27 Nov, 09:01


#анонс

Всем привет!

Несём вам отличную новость:

Почти через две недели, 10 декабря, в 19:00 по московскому времени пройдёт митап для технических и UX-писателей — уже шестой Techdoc Meetup, в этот раз организованный коллегами из Ozon!

О чём пойдёт речь?

🟡 Анастасия Писнова из Ozon поделится опытом работы с текстом как с проектом.
🟡 Светлана Каюшина из СберТех расскажет, какую пользу ИИ может принести техписателям.
🟡 Павел Костромитин из Т-Банка расскажет о росте команды UX-редакторов и их роли в ренейминге.

🟢 А на круглом столе можно будет обсудить компетенции продуктовых техписателей вместе с коллегами из Ozon, Т-Банка, X5 Tech и VK.

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

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

22 Nov, 09:01


#мемница

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

20 Nov, 09:00


#вопросвлоб

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

Что такое синхрофазотрон?

Нет-нет, мы не будем говорить о синхрофазотроне)

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

Так вот в вопросе "Что такое...?" вместо синхрофазотрона может оказаться любой термин из вашей документации. Например, что такое динамическая маршрутизация?

Конечно, вы не обязаны владеть предметной областью на 100%, но лучше продемонстрировать хотя бы общее понимание термина. Выжтехписатель, и выбор слов для документации должен быть осознанным.

Действующие техписатели, ставьте 👍, если знакомы со всеми терминами в вашей доке😉

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

15 Nov, 09:01


#мемница

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

14 Nov, 09:01


Всем привет!

Сегодня, 14 ноября, в 19:00 по московскому времени пройдёт митап для технических писателей, организованный коллегами из Cloud․ru.

О чём пойдёт речь?

🔴 Юлия Служаева из Cloud․ru расскажет о редполитике: как написать правила и не устроить бои без правил.

🔵 Марина Смирнова и Екатерина Каляева из Cloud․ru поделятся, как они автоматизировали проверку документации: кейс с линтером Vale.

🟢 Антон Литвинов из SberDevices поговорит о системе метрик клиентской документации.

🟠 Теодора Малевинская из T-Bank расскажет о частых ошибках техписателей в поиске работы.

Ссылка на онлайн-трансляцию появится в канале TeamSnack TechWriters, не пропустите :)

#анонс

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

13 Nov, 09:00


#писалитирекомендует

Всем привет!
И в том числе привет всем новеньким подписчикам❤️

Мы решили помочь вам выжать максимум из нашего канала. Будем публиковать дайджесты с ранними постами, которые могут быть интересны в свете обсуждений в сообществе, например, в жёлтом чате.

Итак, популярная тема на этой неделе — грейды техписателей.

У нас по этой теме:

1️⃣ Грейды технических писателей: примерная лестница для новичков и бесплатная основа для вашего ранжирования. Забирайте и подстраивайте под себя)

2️⃣ Чем сеньор отличается от джуна? Размышления у парадного подъезда)

3️⃣ Что делать джуну, если лид ушёл в отпуск? Наши рекомендации, или чего мы ждали от своих джунов

Учитесь вместе с нами❤️

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

08 Nov, 08:59


#мемница

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

05 Nov, 15:00


#циталити

Николай Волынкин, автор канала @docops

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

01 Nov, 09:01


лже-#мемница

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

25 Oct, 09:01


#мемница

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

23 Oct, 09:00


#колонкаредактора
Всем привет! "Где учиться на техписателя?" — самый частый вопрос от новичков. Это важный вопрос, но мы предлагаем начать с другого: как учиться на техписателя?

Самообразование, курсы, менторы — три уровня образования

Почему мы рекомендуем выстроить обучение именно так? Рассказываем.

1️⃣ Самообразование

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

Поэтому, прежде чем искать курсы, мы советуем поучиться самостоятельно. Это позволит вам точно понимать, что искать дальше.

Всем новичкам мы предлагаем:
*️⃣Посмотреть курс на ютуб от Документата,
*️⃣Почитать редполитики, например, редполитику Госуслуг,
*️⃣Почитать книгу Кагарлицкого (ссылку дали как пример, что-то цена там неконкурентная),
*️⃣Подписаться на нас и почитать посты с начала 😊

2️⃣ Курсы

Курсы, которые испытаны нами лично, посоветовать не получится, потому что они не вынесли испытание временем, хотя были очень хороши.

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

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

3️⃣ Менторы

Кто такие менторы? Это опытные технические писатели, которые за деньги (от 2 000 рублей за час) помогут вам решить конкретные задачи в обучении. Например, они могут выстроить индивидуальный план обучения, исходя их ваших знаний, либо поделиться знаниями в конкретной области.

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

И тут мы снова возвращаемся к пункту 1 😉
Самообразование — основа всего обучения.

🔆 Если вы уже прошли какой-то хороший курс или нашли хорошую публикацию, поделитесь, пожалуйста, ссылкой на них в комментариях.

Также вы можете оставить ссылку на свой канал или курс, если они посвящены технической документации.

Давайте соберем для новичков полезную информацию
.

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

18 Oct, 09:00


#мемница

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

11 Oct, 09:02


#мемница

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

09 Oct, 09:01


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

Трамплин в IT или профессия?

Да, действительно, очень часто профессия технического писателя преподносится именно как лёгкий способ присоединиться к IT-сообществу. К техписателю не предъявляются такие требования, как, например, к разработчику или тестировщику: просто пиши и пиши себе текст.

И отчасти это так: знания языков программирования от техписателей требуют не везде.

😎 - Вот освою техписательство и уйду в разработчики!

Но есть ли границы у навыков технического писателя? Можно ли в какой-то момент времени сказать, что "освоил техписательство"?

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

1️⃣ Язык

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

Вашим пользователям всё понятно? Документация помогает использовать продукт? Все процессы доступно зафиксированы? Отлично!

2️⃣ Инструменты

Документация не витает в воздухе — команды передают её заказчику в каком-то виде. Например, в виде страниц в корпоративной вики или в виде распечатанных страниц Word.

Можете ли вы одним махом форматировать все таблицы на 300 страницах текста? Сами создаёте макросы? А может ещё и схемы чертите? Супер!

3️⃣ Управление

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

Вы можете выстроить стратегию документации, рассчитать трудозатраты на её реализацию и разработать подробный план? Великолепно!

🧐 - Уже всё? Уже можно уходить в разработчики?

Мы ответим, что уйти можно в любой момент, и вы уйдёте, так и не узнав... Что это ещё не всё)

4️⃣ DocOps

Целый пласт навыков на стыке техписательства, фронтенд-, бэкенд-разработки и DevOps.

5️⃣ Локализация и интернационализация

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

😏 — Оу, здесь уже и платят неплохо, и код писать могу, и зачем мне тогда в разработчики?

Техписатель — не просто трамплин в IT, а самая настоящая профессия. И, если для вас это важно, у неё есть свой госстандарт. Оставайтесь с нами❤️

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

04 Oct, 09:02


#мемница

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

01 Oct, 09:02


#такбывает
Всем привет!
Иногда полезно делиться своими ошибками, даже самыми глупыми, чтобы больше никто их не совершал. А ещё такие истории помогают коллегам избавиться от синдрома самозванца — люди ошибаются, так бывает)

Самая полезная (нет) запись встречи

Для техписателя важно записывать все встречи. Какой бы ни была надёжной память, но в самый ответственный момент и она может подвести. Запись же позволяет сохранить информацию и лишний раз не беспокоить носителя знаний.

Поэтому я (Лида) и решила записать очередную встречу с разработчиком. Но по какой-то причине мой микрофон был программно отключен. И запись получилась такая:

Я: ...
Разработчик: Привет, давай.
Я: ...
Разработчик: Да, верно.
Я: ...
Разработчик: Да.
Я: ...
Разработчик: Да, сейчас это так работает.
Я: ...
Разработчик: Верно.
Я: ...
Разработчик: Хорошо, давай тогда договоримся - во вторник дедлайн.


*Конец записи*

Проверяйте настройки перед записью)

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

30 Sep, 09:01


Всем привет!

В этот четверг, 3 октября, в 19:00 по московскому времени пройдёт митап для технических писателей, организованный коллегами из X5 Tech.

О чём пойдёт речь?

0️⃣ Лютикова Александра из X5 Tech расскажет, как выжить в режиме аврала.
0️⃣ Александр Мачулин из Gram.ax поделится опытом, как они пытались автоматизировать проверки по стайлгайдам.
0️⃣ Акимова Юлия из Яндекс Маркета расскажет, почему дизайнер, UX-редактор и исследователь — единый организм.

1️⃣ Круглый стол «UX-исследования справки и интерфейсов» с коллегами из X5, Cloud.ru, Авито, Яндекс Маркета и Ozon.

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

#анонс

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

27 Sep, 09:02


#мемница

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

23 Sep, 09:01


#какэтоработает
Всем привет! В прошлом посте мы поговорили о том, что же такое docs-as-code и почему команды выбирают именно его для создания документации.

Как создавать документацию с docs-as-code?

Допустим, мы уже переняли инструменты разработчиков: пишем документацию в markdown, используя VS Code, храним в гите, собираем генератором и поставляем в виде веб-ресурса. Но как использовать практики разработки?

Работа с документацией организована по аналогии с разработкой: одна функциональность – одна ветка в гите.

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

Для всего релиза тоже существует отдельная, релизная ветка, в которую мы сливаем все ветки-задачи, не удаляя исходные.

Как только релиз сформирован у разработчиков, технический писатель уточняет, все ли задачи попали в релизную ветку документации. Если всё корректно, сливает ветку в основную.

❗️ Если по какой-то причине техписатель поспешил и залил в релизную ветку лишнюю задачу, некорректная релизная ветка удаляется и собирается новая из веток-задач, которые мы предусмотрительно не удаляем.

🔆 Готово. К релизу продукта мы получаем релизную ветку, в которой содержатся описания всех фичей и доработок.

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

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

20 Sep, 09:01


#мемница

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

16 Sep, 09:02


#какэтоработает

Всем привет! Сегодня поговорим об одном из самых популярных терминов в речи техписателей – docs-as-code.

Что такое docs-as-code?

🔆 Это подход к созданию документации, когда техписатели используют инструменты и практики разработки. По мнению documentat.io, docs-as-code подразумевает, что технические писатели выполняют хотя бы часть из указанных процессов:
– Пишут документацию в редакторах кода вроде VS Code и подобных.
– Используют языки разметки, например, Markdown или reStructureText.
– Хранят исходники в гите и используют его для совместной работы с файлами.
– Используют программные решения для “компиляции” документации – преобразования исходников в html-страницы. Такие инструменты называются SSG (Static Site Generator), чаще используется термин “генератор” или “сборщик”.
– Разворачивают документацию как приложения – с помощью так называемой технологии непрерывной интеграции и развёртывания (CI/CD).

Почему команды выбирают такое решение?

Аргументов “за” docs-as-code много. Рассмотрим три основных.

1️⃣ Первый, но не самый очевидный, – единый мир с продуктовой командой. Технические писатели, которые обычно отвечают за буквы и считаются гуманитариями, в этой парадигме полностью интегрируются в команду. Они неизбежно начинают разбираться в процессах разработки, лучше понимают разработчиков, а разработчики лучше понимают их.

2️⃣ Второй аргумент, самый веский – подход docs-as-code помогает создавать актуальную и полную документации за счёт самого процесса. Документация развивается и обновляется одновременно с продуктами.


3️⃣ Третий аргумент – гибкость решений и разгрузка команды, если используются генераторы. SSG, как правило, — это опенсорсные продукты с хорошей документацией и обширным сообществом. Благодаря этому технические писатели могут освоить инструмент самостоятельно и наладить сборку документации.

Если с инструментами разработки всё понятно, то что же значит “использовать практики разработки”? Об этом мы поговорим в следующем посте.

А пока давайте вспомним, какие же ещё плюсы у docs-as-code и какие недостатки?

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

13 Sep, 09:04


#мемница

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

06 Sep, 09:04


#мемница

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

04 Sep, 11:00


#анонс
Всем привет!
Соскучились по полезным докладам и крутым спикерам? Несём вам классную новость:

Завтра, 5 сентября, стартует DevFest 2024, и доклады в треке Documentation можно посмотреть онлайн бесплатно!

🔥Кто спикеры:
*️⃣Екатерина Чинкова, Ozon
*️⃣Ольга Каныгина, X5 Tech
*️⃣Татьяна Цикунова, МойСклад
и
*️⃣Семён Факторович😎

Присоединяйтесь к чату конференции, ссылку на трансляцию сбросят туда)

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

30 Aug, 09:05


#мемница

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

28 Aug, 11:03


Привет! 👋

Если вы работаете свою лучшую работу, но иногда вас настигает чувство, что вы делаете что-то не так или плохо — этот пост для вас.

Поговорим про «рабочую самооценку» — не синдром самозванца, хотя, наверное, он тут тоже затесался. Что делать, если вы вдруг почувствовали неуверенность в своих силах? Это может случиться на сложном проекте, после отпуска, от отсутствия отпуска, или просто потому, что так сложились звезды.

Что может помочь поднять «рабочую самоуверенность»?

📌 Обратная связь от коллег
Это могут быть как коллеги по цеху, если вы работаете в команде, так и коллеги-заказчики, если вы работаете один. Не стесняйтесь спрашивать ОС! Так вы узнаете, правда ли вы так плохи, как успели себе надумать (спойлер: нет).

📌 Попробовать взглянуть на свою работу глазами других
Практика «посмотреть на свою работу другими глазами» иногда неплохо помогает. Например, если представить, что ты — руководитель или техпис, который тебе очень нравится, и посмотреть на свои статьи.. Можно вдохновиться, сделать текст лучше и повысить уверенность в себе и самооценку.

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

Но где же найти друзей-техписателей?
📎 в сообществе техписателей или во флудилке — инвайты туда периодически кидают в чате;
📎 в тематических чатах для техписов;
📎 в каналах, которые ведут техписы, например, Катя Ушакова из Ozon тщательно собрала такие каналы в отдельной папке;
📎 на митапах и конференциях;
📎на работе! Да-да, коллеги тоже могут стать отличными друзьями, знаем не понаслышке 😏

Но что делать, если я интроверт?

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

Если такой возможности нет, походите по публичным базам знаний компаний, которые вы знаете и которые вам нравятся. В этих доках вы можете обнаружить ошибки, которые покажут, что все не идеальны. Или наоборот, вдохновитесь текстами и поймете, что делать с вашими задачами, и поднимете самооценку.

Поделитесь в комментариях своими методами, которые помогают поднять рабочую самооценку 🙈

#выпуск 16

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

23 Aug, 09:05


#мемница

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

16 Aug, 09:04


#мемница

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

13 Aug, 11:03


Привет!

Продолжим тему «популяризации» технических писателей в компании. В прошлый раз мы говорили о том, как попиарить себя, когда вы только-только пришли в компанию. Сегодня поразмышляем о способах напомнить о себе, когда вы уже не новичок.

Бывает так, что вы работаете-работаете, а люди в компании всё равно не понимают, кто вы, что делаете и зачем пристаёте с вопросами (или не пристаёте, а просто где-то отсвечиваете). И главное — не понимают, как вы можете им помочь написать хорошую и понятную документацию!

Как себя «прорекламировать»? Можно напомнить о себе или мозолить глаза! 😏

📌Напишите небольшую страничку о том, кто вы, чем можете быть полезны, как к вам обратиться и поставить задачу
📌Пишите о своей работе в командные чаты. Готовите релиз ноты? Напишите об этом! Выпустили документацию? Похвастайтесь! Заведите еженедельный/ежемесячный/ежеквартальный дайджест о своей работе. Пусть видят, чем вы занимаетесь, может, каждый для себя найдет какую-то пользу.
📌Если пишете пользовательскую документацию — дайджесты тоже помогут, но уже не разработчикам, а техподдержке или даже самим пользователям. Сделайте страницу с ежемесячными обновлениями документации.
📌И способ «со звездочкой» — начните ходить на командные встречи.
Что хорошего: вы будете больше погружены в продукт, знать, что делает команда, можете сразу всем задать вопросы о проектах. А ещё будете маячить у них перед глазами, напоминая о себе и документации.
Что плохого: если вы один техпис на несколько продуктов или команд, есть вероятность, что вы будете только и делать, что ходить на встречи. Но это тоже решаемо: выбираете один приоритетный/проблемный продукт/команду и начинаете внедряться только к ним. И так начинаете кочевать от команды к команде.

И ещё несколько способов из комментариев к прошлому посту!
📌 Залетайте на демо, если они есть в вашей компании. Там можно рассказать, кто вы и чем полезны.
Кстати, как вариант: если у вас есть коллеги-друзья, можно попросить их на таких встречах попиарить вас и вашу документацию.
📌 Если работаете в офисе — проставьтесь по окончанию испытательного срока. На пиццу могут слететься разные люди, заодно познакомитесь и расскажете о себе.
📌 Участвуйте во внутренних митапах! Тоже повышает видимость вас, техписателей в целом и документации.

В итоге о вашей работе будут знать, возможно, кто-то даже скажет «спасибо», но это неточно 😁

Расскажите в комментариях, как вы популяризируете документацию или пытались это делать 🙂

#Выпуск 15

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

09 Aug, 09:05


#мемница