PRO_техписательство
556 subscribers
92 photos
1 file
45 links
Канал техписа с дипломами программиста и аналитика. Пишу про техписательство и всё, что около него.
Адепт Docs as code.
До этого 9 лет работал IT-копирайтером и редактором на фрилансе. Так что про фриланс знаю всё. А еще пишу стихи, в т.ч. на заказ.
加入频道
Forwarded from Техпис говорит | Подкасты (Anna Kostyagina)
С Днем технического писателя, друзья и коллеги!
Ведь сегодня 2 февраля - 33-й день года ✨️

#праздник #деньтехписателя
🥰12
Говорят, сегодня день технического писателя. Ну что же, ловите несколько строк, посвященных нам с вами:

Одни по ГОСТу пишут доку.
Другие пишут доку на «АПИшки».
Одни всё собирают «Диплодоком».
Другие «Вордом» мучают нервишки.

Одни читают код и парсеры ваяют.
Другие из стейкхолдеров достанут что угодно.
Одни в большущих «Госах» обитают.
Другим в стартапах просто превосходно.

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

Все это про техписов, без которых
Хороших доков быть не может просто.
Про новичков совсем и про матёрых.
Про «докс эс кодников» и про адептов ГОСТа.

Сегодня их поздравить не забудьте.
Ведь это же совсем несложно.
Техписы, вы всегда такими будьте.
Такими, без которых невозможно!
122🔥12👏3👎1
А как вы проводите выходные?

Эти у меня получились довольно продуктивными.
Добил курс на «Степике», который купил еще в прошлом сентябре, и получил сертификат.

Курс, кстати, очень рекомендую. Будет полезен новичкам и опытным.
🔥14🎉5
🚀 Друзья, 2-ая международная конференция технических писателей TechWriter Days пройдет 28-29 марта 2025 года в Санкт-Петербурге в офлайн и онлайн формате.

‼️Разыгрываем‼️
🎫1 офлайн и 1 онлайн билеты
🎫скидка 50% на 2 офлайн и 2 онлайн билета
🎫скидка 30% на 3 офлайн и 3 онлайн билета

Наш информационный партнер — компания documentat.io и их документационный опрос😉

Как принять участие? Всё просто:
🔹Пройди опрос от нашего партнера, сделай свой вклад в изучение техписательского сообщества!
🔹Вступи в телеграм-группу конференции

⚡️Итоги подведём 25 февраля в этой же группе TechWriter Days!

Станьте частью этого долгожданного события! Ждём вас на Конференции❤️
5👍32
Все знают, что такое Kubernetes. Правда же?
Но если хотите узнать больше, приходите 27 марта на Deckhouse Conf.
👍1
This media is not supported in the widget
VIEW IN TELEGRAM
🔥4👏3😁3
Дорогие женщины! Хочу поздравить вас с 8 марта.
Позравление предлагаю получить самостоятельно.

Для этого просто «дерните ручку» API (c HTTP-глаголом GET) через Postman или другим удобным способом:

https://virtserver.swaggerhub.com/denmaloyreb/8_march/1.0.0/greeting/NUMBER

Вместо NUMBER подставьте число от 1 до 20.

А самые смелые могут, не побоюсь этого слова, курлануть:

curl --location '
https://virtserver.swaggerhub.com/denmaloyreb/8_march/1.0.0/greeting/NUMBER'

Здесь тоже вместо NUMBER подставьте число от 1 до 20.

Полученными поздравлениями предлагаю делиться в комментариях к посту. Хотя, просто реакции от вас будет тоже достаточно.
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥8❤‍🔥4👏2😍2😁1
Жизненно
Лампочка сломана — что делать?
😁15💯4
Меня в другом канале показывают. Красивое.
Как документировать GraphQL API, чтобы разработчики были в восторге?

За ответом приходите на доклад нашего технического писателя Дениса Ребенка на TechWriter Days 28 марта.

Денис расскажет про отличительные особенности и нюансы GraphQL API, способы и формы документирования. А после доклада вы уже сами сможете развернуть GraphQL API. И потренироваться работать с собственным интерфейсом.
🔥14👍3🆒2
Вторая Международная конференция технических писателей TechWriter Days / 2 старутет только послезавтра. Но подписчики моего канала уже сегодня могут воспользоваться полезнотой, которой я поделюсь во время своего доклада про документирование GraphQL API.
Ловите ссылку на репозиторий, который позволит вам потренироваться в документировании GraphQL API. Пользуйтесь и прокачивайте свои скиллы.
А все подробности, фишки и нюансы, касающиеся документирования GraphQL API — во время доклада. Буду рад видеть всех.
👍7🔥4💔2👎1👏1
Коротко о TW Days 2

Техрайтерс дэйс — огонь конфа.
Здесь только нужная инфа.
Нетворкинг здесь удачно прёт.
Попал сюда — тебе везёт.

Здесь темы под любой запрос.
Мне заскучать здесь не пришлось.
Организация здесь — высший класс.
На афтепати — расколбас.

Спасибо оргам за конфу.
А спикерам — за их инфу.
Участникам — за позитив.
Здесь позитива просто взрыв.

Конфа, уверен, удалась.
Жаль, только, быстро пронеслась.
Нам всем пора на поезд иль на рейс…
До встречи на Техрайтерс дэйс.
🔥2212👍5
Forwarded from TechWriter Days Channel
Доклады с первой конференции Techwriter Days уже доступны!

Отличные новости для всех, кто не смог посетить конференцию лично или хочет освежить в памяти выступления спикеров. Мы выложили записи всех докладов с первой конференции Techwriter Days на нашем канале ВКонтакте

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

Скорее переходите в наш канал VK Видео и смотрите доклады, которые помогут вам стать ещё круче в профессии. Будем рады вашим отзывам и комментариям!
9🔥8
Моя статья «Документирование HTTP API (и не только) с Foliant», написанная по мотивам доклада на TWD1, попала в шорт-лист «Технотекста-7». Правда, категории про техническую документацию в этом году не было. Но, что есть, то есть.
В общем, вы знаете, что делать.
https://habr.com/ru/companies/habr/articles/906136/
🔥274🫡2
Спите? Ну тогда просыпайтесь!

Я наконец-то сделал это, переформатировал и опубликовал Курс по проектированию и документированию API в виде сайта на Github Pages.

Если вы до этого момента сомневались, стоит ли проходить, хватит сомневаться. Кликайте сюда и проходите курс.
🔥549👏7🤯1
Нашел в закромах

А ведь я когда-то (во времена фрилансерства) даже участвовал в «битве Главреда» (да-да, того самого, «всея руси» который, на букву Иль...хов). Выиграть не получилось. Но опыт был интересный.

Почему я тогда ввязался в это? В тот момент работал с клиентом, который продвигал услуги по защите авторских прав с упором именно на IT. А тут как раз и битва на эту тему нарисовалась. «А почему бы и нет?» — подумал я.

В общем, результат по ссылке.
🔥9👏3
PlantUML прямо в Miro

Не знаю, может, для кого-то это не будет открытием, но я недавно узнал, что в Miro есть встроенная поддержка PlantUML. Очень удобно: можно открыть редактор, набросать код диаграммы и добавить ее на доску. Удобно, КМК, особенно для тех, кто много работает в Miro.
Итого, сейчас у меня в арсенале следующие способы работы с UML (и не только) диаграммами:

- расширение для VS Code,
- онлайн-редактор PlantUML,
- встроенный в Miro редактор.
🔥6👌3