Архив рубрики ‘документация’

Handoff-driven development

Улучшенный Spec-driven-dev. Это SDD + handoff’ы — передний край лучших мировых практик как для соло-разработки, так и для небольших команд. Это не история про рой агентов, которые в абстрактном цикле «план → код → ревью → тесты → деплой» самостоятельно везут продукт, синхронизируясь друг с другом через воркфлоу. У нас нет личного датацентра или полумиллиона […]

«Боргворглер: боргает ворглер», или как сделать действительно полезную документацию к проекту

Обсуждения неудачных примеров README-файлов и документации — одна из популярных тем на профильных площадках и форумах [вкупе с другими «вечнозелеными» спорами в ИТ]. Сегодня мы в Beeline Cloud решили посмотреть, что думают о проблеме плохой документации разработчики и ученые, может ли ИИ улучшить ситуацию, что такое «нейросетевой ридмитит» — и как можно «доработать напильником» сгенерированные […]

Когда онбординг длится 2 месяца: день 3 — проследить главный поток данных

Вступление Рано или поздно сложную систему приходится объяснять человеку со стороны: новому разработчику, техлиду, архитектору или ревьюеру. И тут часто начинается боль: репозитории уже показали, основные сущности вроде бы объяснили, но всё ещё непонятно, как данные проходят через систему. В этой части я покажу, как сделать первое погружение в код наменее болезненным: выбрать один главный […]

Без документации ИИ далеко не уедет: мои грабли на проекте

Это продолжение статьи «ИИ может писать код, но умеет ли он делать красиво? Мой опыт с виджетом и аватарами». На этой неделе я побывал в телеграм-клубе AI Practiq, где ребята собираются, обсуждают вайбкодинг, делятся опытом и практиками. Один из участников рассказывал о своём опыте и выделил четыре важных аспекта качественной разработки с ИИ. Один из них […]

Когда онбординг длится 2 месяца: день 2 — карта репозиториев

Итак, ваш первый день в офисе, вам дали доступы ко всем 15 репозиториям проекта, рассказали где что лежит, и теперь ждут от вас великих дел. Они и не подозревают, что вы уже забыли, какой карточкой открывается этаж и где стоит кофемашина. Добро пожаловать в 50% IT-компаний вторую статью цикла про онбординг в сложную систему! В […]

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch. Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит […]

MoneyDev: Сказка про три главных слова

Давным-давно, кажется в позапрошлый вторник, в одной из статей была поднята тема зарабатывания денег, где я поделился личным опытом работы на программных проектах, на рентабельность которых существенно повлияла проектная и эксплуатационная документация. По аналогии с фильмом «MoneyBall» материалы этой серии я объединил под названием «MoneyDev». Сказка, которую вы сможете прочитать под катом, является логическим продолжением […]

Диагностика ОРД: как выявить «хромые» места в документах, пока их не нашел регулятор

Автор: Елизавета Пермякова, консультант по информационной безопасности Innostage

Как мы потеряли GitBook за 5 минут и нашли Gramax — open-source альтернативу, которую теперь используем сами

Пишет об этом Product Manager команды: Котельникова Екатерина Андреевна.

Вася уволился — и унёс с собой 80% знаний о системе

Однажды утром вы открываете задачу и понимаете: единственный человек, который знал, как это работает, вчера уволился. Знания ушли вместе с ним. Всем привет, я Артём Герасимов, владелец продукта SimpleOne SDLC. Сегодня поговорим о проблеме, с которой сталкивалась, наверное, каждая ИТ-команда: уходит ключевой разработчик — и вместе с ним испаряется всё, что он знал о системе. […]

123.5