При определении объема документирования важно:
- Включать только необходимый набор артефактов.
- Разделять постановку и документирование ИТ-решения.
Постановка отвечает на вопрос «что нужно сделать?», а техническая документация — «как это сделано / как это работает?». Стоит заметить, что грамотно сформированная классификация постановок в терминах UML может стать частью документирования. Это может помочь, когда на проекте отсутствует отдельный процесс документирования.
КонкретикаДокументацию необходимо писать просто, кратко и точно, применяя лексику, понятную пользователям, во избежание расхождений в интерпретации артефактов и фраз в постановке.
Команда- Учитывайте формат, особенности и традиции работы команды.
- Учитывайте необходимость брать на себя описание артефактов и документирование, а также наличие компетенций для этого.
Переиспользование артефактовЧтобы была возможность переиспользовать артефакты, необходимо подумать об их:
- Кодировании
- Классификации
- Хранении и обеспечении быстрого доступа
- Доступности для модификации и совместной работы
- Версионировании (т.к. видоизмененный в новой постановке артефакт, при отсутствии версионирования, не позволит доработать предыдущую версию артефакта по замечаниям от разработчика, например)
Счастливая команда – залог успехаСчастливый менеджер понимает, что:
- в постановке описаны только те артефакты, которые реально необходимы для конкретной задачи
- артефакты, которые можно переиспользовать, перед используются
- время (деньги) потрачено с умом
Счастливые разработчики понимают, что написано в постановке, у них нет необходимости просматривать справочники по нотациям моделирования для понимания артефактов.
Счастливые тестировщики понимают, какие есть пользовательские сценарии использования продукта, внутренних алгоритмов
Счастливые тимлиды понимают, как можно разбить задачу между исполнителями