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

1. Иерархический подход к
документированию
информационных систем
Эксплуатационная документация: Технический Паспорт
Сергей Солдатов, август 2013

2. В фокусе внимания
• Технический паспорт на ИС в рамках
• проектов
• операционной деятельности
• Краткий план мягкого перехода на предлагаемую методологию

3. Текущая ситуация: взаимосвязь проблем
Текущие шаблоны эксплуатационной документации требуют
для каждой ИС описания всей связанной инфраструктуры
Высокая трудоемкость подготовки
документов: при описании каждой ИС
требуется отвлекаться на детали
инфраструктуры
Многократное дублирование
описания общих сервисов,
компонентов …
Инфраструктурное
изменение потребует
корректировок во все эти
копии, что технически
невозможно
Мало что
документировано
Сложность документирования
изменений: небольшая модификация
требует копирования описаний всех
не затронутые изменениями сервисов
Изменения не отражаются
в документации
Снижение надежности ИТ-сервисов,
ввиду отсутствия актуальной
эксплуатационной документации

4. Типовое содержание паспорта ИС
Физический периметр
СХД
Сеть
Оборудование
Виртуализация
СКС
Оборудование
ЛВС
Виртуализация
Операционные системы
Инфраструктурные службы
СУБД
Промежуточное ПО*
* Middleware
Приложение
Технический паспорт Приложения
Пример проблемы: смена серверного
помещения требует изменения всех
паспортов Приложений, использующих
переносимые сервера

5. Принципы предлагаемого подхода к
документированию
• Модульный подход: используемые многими ИС компоненты инфраструктуры и
смежные системы оформляются отдельными паспортами, их описание не
дублируется в паспорте каждой ИС, а дается ссылка.
• Управление изменениями и конфигурациями: при проведении изменений
обязательно документируется новая конфигурация ИС - выпускаются новые версии
паспортов на компоненты, затронутые изменением.
• Разделение на компоненты выбирается исходя из удобства подготовки
качественного описания вносимых изменений и может быть различным для
каждой ИС
• Степень детализации паспорта (≡ описание конфигурации) должна позволять:
• Планировать изменения,
• Оценивать риски изменения (риски ИТ и ИБ),
• Сохранить знания о конфигурации ИС в случае ухода ключевых специалистов.

6. Модель* паспорта с учетом предлагаемого
подхода
Физический периметр
СХД
Сеть
Оборудование
Виртуализация
СКС
Оборудование
ЛВС
Виртуализация
Операционные системы
Инфраструктурные службы
СУБД
Промежуточное ПО
Приложение
ТПс ЦОД
ТПс СКС
ТПс ЛВС
ТПс СХД
ТПс
Виртуализации
ТПс
Инфраструктуры
ТПс** общих СУБД
ТПс Приложения
Специфичная для
Приложения конфигурация
*Для каждой ИС модель описания может быть различна
** Технический паспорт

7. Пример 1: Документирование сетевой
инфраструктуры
Паспорт ЦОД
Паспорт СКС
Паспорт Кроссовых
Паспорт ЛВС
• Адреса зданий,
• Номера помещений,
• Номера стоек, шкафов
• Физическая безопасность, СКУД …
• Системы жизнеобеспечения
• Схемы разводки кабелей (патч-панели, лючки, т.п.),
• Расположение сетевого оборудования,
• Модели оборудования,
• Сведения о конфигурации оборудования,
• Схема коммутации (L2)
• Логические сетевые устройства (коммутаторы,
маршрутизаторы, МЭ),
• Логические линки,
• VLAN-ы и адресация
• Схема маршрутизации (L3)
Настроена на ….
Располагается в …

8. Пример 2: Документирование приложения
общего вида
Паспорт
Инфраструктурных
сервисов
Паспорт
Инфраструктурных
сервисов
Паспорт общего
сервера
публикации
(сервера
приложений)
Паспорт ЦОД
Паспорт
виртуальной фермы
Паспорт ЛВС
Паспорт ИС
Паспорт(а)
Инфраструктурных
сервисов
Паспорт общей
СУБД
Паспорт СХД

9. Управление Изменениями и Конфигурациями
Изменение оформляется следующими
документами:
• Запрос на изменение: описание бизнес-цели
изменения;
• Подробный план работ: перечень работ,
даты проведения, ответственные
исполнители, планы отката;
• Описание изменения: перечень измененных
паспортов с указанием номеров новых
версий.
Паспорт ИС – описание конфигурации: в любой
момент времени последняя версия Паспорта
описывает актуальную конфигурацию ИС.
ТПс1v0 ТПс2v0
ТПс3v0
ТПс4v1
ТПс8v1 ТПс9v1
ТПс6v1 ТПс7v1
ТПс4v0 ТПс5v0
ТПс6v0 ТПс7v0
ТПс8v0 ТПс9v0
ТПс4v2 ТПс5v2
ТПс6v2 ТПс7v2
Актуальная конфигурация
Архив конфигураций
Область изменения
Описание изменения
ТПс4v1 ТПс5v1
ТПс6v1 ТПс7v1
ТПс5v1

10. Конкретный план (Вехи)
• Утвердить выбранный подход (ОРД или протокол совещания)
• Разработать модели** документирования конкретных ИС (Пример 1, Пример 2)
(внутренний нормативный док. уровня Инструкция/Методические указания)
• Переработать разделы шаблонов ТПс с учетом предлагаемого подхода* (Шаблоны ТПс
в рамках каждой модели – приложения к Инструкции/МУ)
• Все новые ИС документировать в соответствии с новым подходом (обновление
методологии ведения проектов Проектного офиса)
• Для существующих ИС:
• Спрогнозировать поток изменений (перечень ТПс подсистем)
• Модули документации (ТПс подсистем), которые будут меняться разработать в рамках процесса
Управления изменениями (ТПс на изменяемые подсистемы): по мере оформления изменений буду
появляться модули в правильном формате
• Модули документации, которые не будут меняться – можно разработать в рамках отдельного
проекта (Приказ об открытии проекта, план проекта), но логичнее оставить как есть
* Например, в ТПс на Приложение пропадут разделы про СКС и серверные помещения и т.п.
** «Модель» - это совокупность взаимосвязанных ТПс на подсистемы ИС