PRO_техписательство

ADR — еще один источник информации для технического писателяДумаю, многим техническим писателям хотелось бы минимизировать беготню за стейкхолдерами и ожидание от них ответов. В качестве одного из «факторов», который поможет в этом, можно рассмотреть ADR.ADR (Architecture Decision Record) — это доку...

О пользе DevTools для технического писателя или как я прошел «сложный» пунктуационный тест на 10 из 10, даже на вчитываясь в вопросыЭто первый пост из цикла, посвященного работе технического писателя с инструментами разработчика в браузере (DevTools). Посты из этого цикла покажут, чем DevTools могут...

Опубликованы записи докладов с конференции Techwriter days 2, которая проходила с 28 по 29 марта 2025 в Санкт-Петербурге. Напомню, что там я выступал с докладом про документирование GraphQL API.Ссылка на запись на YouTubeСсылка на запись ВКонтактеНу и ссылка на статью на Хабр по мотивам доклада.

Ликбез: C4 и 4C, в чем разница?Про C4 наверняка слышали многие технические писатели (особенно которые работают рука об руку с архитекторами). Это — метод (или подход, или нотация) моделирования и описания архитектуры программных систем. Здесь для описания архитектуры используется 4 уровня:- Context ...

Несу инфу про конфу!!!Если вам интересен Kubernetes, DevOps и вот это вот всё, приходите на Deckhouse Conf 2026.А если знаете, кто этим интересуется, поделитесь с ним инфой про конференцию (наверняка же многие мечтают о надежной, отказоустойчивой инфраструктуре, автоматизации всего и вся и прочих по...

Привет. Думаю, коллеги вас уже поздравили, теперь я хочу поздравить прекрасную половину читателей моего канала с приближающимся 8 марта (чтобы не дергать в выходной день и дать спокойно отдохнуть :))!Предлагаю получить свое поздравление с цветами через GraphQL API (а если точнее — через графический ...

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

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

Я и мой ИИВ уходящем году случился просто дичайший ИИ-бум. И я не мог не остаться в стороне. Решил спросить модель, с которой чаще всего взаимодействую, как она меня видит по результатам общения в 2025 году.Могу сказать, что процентов на 80% она права. Но и галлюцинации (как же без них) тоже есть. В...

Хотите узнать все про документирование GraphQL API? Без проблем.На Хабре вышла статья «Как документировать GraphQL API: полное руководство для технических писателей» по мотивам моего доклада на TW Days 2. Читайте, впитывайте знания и тренируйтесь «не отходя от кассы»: там есть ссылка на репозиторий,...

Мажорный, минорный, патч: что техническому писателю стоит знать про релизыОткуда вообще взялись понятия «мажорный», «минорный» и «патч»?«Уши растут» из SemVer. Это соглашение о том, как нумеровать версии программного обеспечения, чтобы по номеру было понятно, какого плана (и объема) изменения произо...

#tw_api_jekyllВсем привет.Давно не было новостей про наш сайт-справочник API на базе Jekyll. А их поднакопилось с прошлого раза.Рассказываю, что изменилось.Liquid-код разнесен по нескольким файламКоличество строк кода неуклонно растет, поэтому было принято решение разнести его по отдельным файлам.Та...