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

Проектная и рабочая документация – разделять или нет?

Некоторые специалисты не отделяют рабочую документацию от проектной, а их создание объединяют в один этап. Но куда более логичным выглядит подход, при котором между проектной и рабочей документацией проводится разделяющая черта.

На проектной стадии (П) разработки системы, сервиса или отдельного IT-решения самой системы может еще не существовать. Основная задача этого этапа – описать будущую систему со всех сторон.

Чаще всего стадии П предшествует предпроектная стадия, на которой формируется техническое задание. А уже в проектной документации описываются подходы, методы и решения, необходимые для выполнения поставленного ТЗ. Все они должны быть реализованы на следующей стадии – рабочей (Р).

На ней уже никто не обосновывает выбранные технические решения – их просто воплощают. В ходе этапа Р и создается рабочая документация, которая необходима для успешного развертывания и запуска запланированной системы или сервиса. Ее отличительная черта – максимальная конкретность и объективность.

Что должно быть в рабочей документации?

Прежде всего, технические описания реализуемых решений. Это схемы IT-инфраструктуры, описания конфигураций и т.д.

Основная задача рабочей документации – дать полное представление о том, как устроена система, из чего она состоит и как функционирует.

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

Например, при создании рабочей документации всей IT-инфраструктуры многие компании используют следующий шаблон:

Общие данные (схема и описание архитектуры, цели, задачи и характеристики подключенных сервисов).

Перечень используемого оборудования и программного обеспечения (информация о лицензиях, подписках и пр.).

Схема размещения рабочего оборудования (включая серверы, стойки, коммутационное оборудование и т.д.). Ее логично дополнить описанием конфигураций, линий связи и схемами подключения оборудования.

Схема размещения подключенных сервисов с описанием их взаимодействия (в том числе, при наличии предусмотренных систем отказоустойчивости и масштабируемости).

Приложения (например, список учетных записей администраторов и пользователей, список настроек сервисов и т.д.).

 

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

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

Что дает грамотно составленная рабочая документация?

систематизирует данные об IT-инфраструктуре;

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

облегчает принятие управленческих решений (к примеру, показывает, какой сервис можно убрать или заменить и как это отобразится на всей системе);

дает возможность комплексно оценить выбранную структуру IT и, также, вовремя заметить допущенные ошибки или дыры в архитектуре.

Порой объем такой документации превышает 100 страниц. К счастью, для ее создания можно использовать специальные генераторы (например, NDoc, Doxygen или JavaDoc). Или вообще поручить документирование IT-проекта опытным специалистам.