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

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

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

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

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

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

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

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

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

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

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

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

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

Скрытая угроза: критические моменты, на которые обращают недостаточно внимания после окончания разработки ПО

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

Как я документирую процесс разработки

Вы пишите лишнюю документацию для вашего проекта? Нет? Тогда вам ее недостаточно! Угадать для каждого конкретного проекта необходимый объем технической документации крайне сложно и важно. Важно — потому, что от этого зависит скорость процесса, качество и стоимость. Сложно — потому что сам процесс может меняться со временем, могут меняться исполнители, да и для заданного состояния […]

Построение СУИБ: С чего начать?

Доброго времени суток, уважаемые! Давно не писал на Хабр, не было времени, много работы было. Но теперь разгрузился и сформировались мысли для нового поста. Общался с одним из товарищей, на которого взвалили труд по ИБ в организации (товарищ сисадмин), и он просил рассказать с чего начать и куда двигаться. Немного привёл мысли и знания в […]

Детальное описание действий IT-отдела — базовый набор документации

Во многих западных странах IT-аутсорсинг регулируется либо отраслевыми стандартами, либо вообще на госуровне. У нас такого нет. Поэтому за несколько лет был собран документ, который детально определяет термины в IT-аутсорсинге и расписывает, что в какой тип работ конкретно входит. С его помощью мы документируем работы, а потом чётко и прозрачно считаем, что сколько стоит. Вот […]