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

Всем привет! В сообществе техписателей часто звучат разговоры о docs as code и о том, что мы используем методы и инструменты разработчиков. Допустим, мы используем Git. Но задумывались ли вы о том, как именно мы работаем с ветками? Какой тип ветвления нам подходит? Предлагаем вместе обсудить эту важную тему:

Что выбрать: Central Workflow, TBD или GitFlow?

Поясним для новичков: эти три основных подхода к работе с ветками. Конечно, они не включают бессмертного варианта: "Ребята, какая у нас ветка актуальная?" 😉

Итак, коротко:

1️⃣ Central Workflow. Одна ветка основная, рабочая. Все изменения — это коммиты в эту ветку. Удобно, если вы работаете в одиночку в очень маленькой команде разработки и точно знаете, что все изменения в продукте идут последовательно.

👉 Например, один фронтендер создаёт модальные окна, а вы описываете заполнение полей в них и публикуете эти инструкции.

2️⃣ TBD (Trunk-Based Development). Три типа ветки: основная (master или main), feature-ветки и релизная ветка. Одно изменение — одна ветка. Здесь важно: ветка отводится для конкретного изменения, а не для всей функциональности целиком, и сливается в основную ветку как можно быстрее.

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

TBD в разработке имеет ещё одну особенность — разработчики могут использовать feature-toggle (флаги), которые включают или выключают какую-то недоработанную часть фичи в базе данных. Поскольку техписатели почти никогда не используют базу данных для сборки документации, нам не нужны флаги, но мы можем закомментировать часть текста.

Когда созданные фрагменты документации часто попадают в основную ветку, feature-ветки создаются уже с этими изменениями, что уменьшает количество конфликтов при последующем слиянии.

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

3️⃣ GitFlow. Большой процесс со всеми типами веток. Классический GitFlow включает ветки main, develop, release-*, hotfix-* и feature-*. В отличие от TBD, в GitFlow каждая feature-ветка — это отдельная полноценная функциональность. Плюс в том, что пока фича не опубликована, ваши черновики по ней в основной ветке не маячат перед глазами других техписов.

👉 Такой подход удобно применять при раннем документировании, когда фича ещё проектируется и реализуется, или когда вы готовите новую структуру документации. Но чем дольше живёт ветка, тем больше будет конфликтов. Поэтому важно подливать в неё изменения из основной ветки, иначе pull-request вырастет до неразрешимых размеров.

Это лишь общее описание подходов, которое умещается в одном посте.

Расскажите, как вы работаете с ветками: придерживаетесь одной методологии или комбинируете их?

#какэтоработает #интервью

Всем привет! Заметили, как быстро мы пересаживаемся на ИИ? Теперь LLM (Большие языковые модели) везде: в мессенджерах, в поисковиках, в чатах поддержки. Как формирует свои ответы LLM?

Сегодня в гостях у Техписалити! — создатель Робота Макса на Госуслугах и автор канала ИИ что дальше Никита Устриков. Спросили у Никиты, как же появляется

База знаний для ИИ

— Никита, для пользователей ответы нейромоделей — это некая магия, которая появляется внезапно. А как на самом деле она формирует ответ?

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

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

— «Загрузка» документации в саму модель — это сложный процесс тонкой настройки. Например, в чатах поддержки используется RAG (Retrieval-Augmented Generation). Модель не ищет ответ в общих знаниях, а работает как умный анализатор: с помощью поиска мы находим вo внутренней базе знаний релевантные документы и передаём их модели. Её задача — проанализировать именно эти документы и сформулировать ответ.

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

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

— Если не говорить о разработке и Data Science, есть ли ещё какие-то особенности создания базы знаний именно для нейромодели?

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

— Спасибо за ответы!

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

Понять нейросеть за 2 минуты
Парадокс тупости или коллапс модели
Шок-контент

#twd3
Всем привет! Немного задержались, но всё же сформировали список участников розыгрыша.
Список здесь.

Каждому участнику мы присвоили номер — это номер его строки в таблице. Заносили в таблицу в порядке появления комментариев: вначале самые первые.
Два претендента в список не попали. К сожалению или к счастью, правила есть правила, и комментарии, опубликованные позже 12:00 по Москве мы не учитываем.

В этот четверг, 12 марта в 13-30 мы проведём трансляцию розыгрыша — по старинке с помощью генератора случайных чисел. Затем проверим, соблюдены ли у победителя условия конкурса, и свяжемся с ним. Если условия не соблюдены, сгенерируем новый номерок. (Самое время проверить свои подписки)

Ссылку на трансляцию пришлём за пять минут до трансляции.

До встречи в четверг!

Всем привет!
Через несколько минут начинаем трансляцию розыгрыша билета на TWD#3!

UPD:
И мы поздравляем победителя розыгрыша — участника №8, @Maria_mamleeva 🎉

До встречи на #twd3

Всем привет!

Мы снова с новостями для студентов🧑‍🎓

Хотите прокачать скиллы технического писателя и научиться превращать сложные технологии в понятные тексты? Вперёд на стажировку в Kaspersky! Доступно для студентов невыпускного курса любых вузов в Москве и Московской области.

В одной лодке с профессионалами Kaspersky можно научиться:

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

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

Переходите по ссылке https://kas.pr/c4x2 и подавайте заявку на направление Technical Writing🖥✍️

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

Техписалити! начинался как школа для новичков, и мы продолжаем придерживаться этой концепции, хотя и разбавляем контент более “взрослыми” постами. Мы хотим, чтобы информация всегда была доступна всем, без каких-либо заморочек.

Поэтому мы переходим в Макс.

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

Поскольку мы остаёмся в телеграме, предлагаем посмотреть залипательное – атлас телеграм-каналов, в котором есть и мы, и многие наши дружественные блоги.

Давайте найдём их все! А начнём отсюда)