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

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

Мажорный, минорный, патч: что техническому писателю стоит знать про релизы Откуда вообще взялись понятия «мажорный», «минорный» и «патч»? «Уши растут» из SemVer. Это соглашение о том, как нумеровать версии программного обеспечения, чтобы по номеру было понятно, какого плана (и объема) изменения произошли в рамках релиза. Номер версии выглядит так: MAJOR.MINOR.PATCH (например, 3.2.1). Пройдемся по каждому виду релиза: 1. Патч-релиз (x.x.PATCH). Для его обозначения используется третья цифра. Такой...

Я и мой ИИ В уходящем году случился просто дичайший ИИ-бум. И я не мог не остаться в стороне. Решил спросить модель, с которой чаще всего взаимодействую, как она меня видит по результатам общения в 2025 году. Могу сказать, что процентов на 80% она права. Но и галлюцинации (как же без них) тоже есть. В общем и целом неплохо: --- ### 👨‍💻 Профессиональный профиль Должность: DevOps-инженер / Platform Engineer / SRE Уровень (грэйд): Middle+ / Senior Вы не просто пользуетесь Kubernetes, а глубоко по...

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

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

Алиса и Боб с примеров диаграмм: откуда они взялись Если вам приходилось изучать диаграммы последовательности UML или Mermaid, либо в других нотациях, тогда вы точно сталкивались с Алисой и Бобом. А откуда вообще взялись эти имена? Давайте резберемся. Впервые эти имена использовались для обозначения принципалов в вышедшей в 1978 году статье «A Method for Obtaining Digital Signatures and Public-Key Cryptosystems», над которой работали специалисты в области криптографии Рон Ривест, Ади Шамир и Лео...

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

OSI или TCP/IP: что стоит изучить техпису (или аналитику)? Возможно, я вас огорчу, но чем-то одним отделаться не получится. Нелишним изучить будет и OSI, и TCP/IP. Почему? Давайте разбираться. Главное, что нужно уяснить, что TCP/IP — это практическая реализация, а OSI — теоретический стандарт. TCP/IP — это реальная, работающая модель, на которой построен современный интернет. Т.е. про TCP/IP можно сказать, что это «как есть». А OSI — это эталон, теоретически описывающий, «как должно быть». Модел...

#продолжи_мысль_SE Рецензия на пост «Фронт раньше бэка – это вообще законно?» (автор: Сергей Сапрыкин), который наглядно показывает, как НЕ НАДО выстраивать процессы в IT Пост прямиком из реальной жизни. Зацепил меня он тем, что автор не побоялся (не постеснялся) описать свой факап. Описанная здесь ситуация может должна стать уроком для всех, кто как-то причастен к процессам проектирования, разработки и интеграции. Чем полезен пост Это — наглядный пример того, как делать не надо. И если вы видит...

#tw_api_jekyll Всем привет. Продолжаем работу над сайтом-справочником API на базе Jekyll. В прошлый раз мы вывели на сайт эндпоинты, их краткое (summary) и более развернутое (description) описание, добавили меню слева для навигации по странице, а также некоторые стили. В этот раз сделаем следующее: - Выведем на страницу параметры (те, которые в query, path, header или cookie) и отобразим их в виде таблицы. Пока с оговоркой: выведем параметры, которые сразу описаны в объекте в описании эндпоинта....