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

Как мы строили систему обучения, адаптации и проверки знаний новичков

Передача знаний: инструкция на случай ухода эксперта

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

Скрытые языки: как инженеры передают информацию внутри команды, избегая документации

Технические команды часто избегают лишней документации, но информация всё равно каким-то образом передаётся, сохраняется и развивается. В этой статье — попытка разобрать скрытые механизмы общения внутри инженерных команд: как выстраиваются негласные соглашения, каким образом рождаются «внутренние диалекты» и зачем вообще всё это, если есть JIRA, Confluence и куча других инструментов. Много примеров, блоков кода на […]

Obsidian для профессионалов: рабочая система заметок на стыке подходов

Обложка: гибридная система заметок в Obsidian

Системный аналитик и управление хаосом на проекте. Часть 2: Методика структурирования требований

Диагностика хаоса — первый шаг. Об этом мы говорили в предыдущей статье. Но сама по себе она ничего не меняет. Это лишь осознание проблемы. Настоящая работа начинается на этапе структурирования требований. Это тот момент, когда вы берёте множество разрозненных данных, противоречий, записей в Telegram, Excel-таблиц, каких-то старых писем и превращаете всё это в рабочий артефакт: […]

Чем заменить базу знаний Confluence? Проверили 4 российских сервиса и делимся результатами

Спойлер: это было долго, больно, но в итоге мы всё же нашли подходящее решение.

Документация в проекте

Автор статьи: Сергей Прощаев (@sproshchaev) Ведущий инженер, Java-разработчик в Surgutneftegas В этой статье я расскажу о ключевой роли документации в проектах разработки программного обеспечения и объясню, почему важно подходить к её созданию профессионально, соблюдая стандарты и лучшие практики на примере backend-проекта.

Важность написания документации – зачем, кому, о чем, когда и как

Привет, меня зовут Наталья, я мобильный QA Engineer вот уже более 6 лет. Занимаюсь как мануальным, так и авто-тестированием, успела поработать в стартапах и в крупных компаниях. Однако везде, где мне доводилось работать, была одна и та же боль – документация. А если быть точнее, ее скупость или отсутствие как таковой. И на каждом новом […]

Снижаем Bus Factor в команде

Всем привет! В этой статье я расскажу о трансформации команды разработки в части состава по количеству человек и количеству продуктов на сопровождении. Какие практики внедрили в нашей команде в Мир Plat.From (НСПК), сопровождающей 10 систем, чтобы снизить Bus Factor и уменьшить время входа для новичков. Обзор реальных инструментов, которые работают в нашей команде, и могут […]

Простой способ организовать требования на этапе сбора требований (или первый шаг к формированию уютного бэклога)

Зачем, кому это нужно, чем это сделать Не раз задавалась вопросом: как бы так комфортно организовать входящие требования к системе — на этапе, когда требования только собираются, когда формируются вопросы и озвучиваются ответы, а ещё всё постоянно меняется и пересматривается, а ещё когда в реализации задействовано несколько систем, а ещё, а ещё… При этом очень […]

12