Создание документации ИС

Вступление…

Решился продолжить статьи
«История одной инфраструктуры. Решения MS. Часть 1»
«История одной инфраструктуры. Решения MS. Часть 2»
«История одной инфраструктуры. Решения MS. Часть 3»
и более подробно рассмотреть вопрос создания документации информационной системы (ИС) предприятия. Сразу оговорюсь, что не претендую на истину, всего лишь, мой подход и мои соображения по данному вопросу. Надеюсь, что смогу помочь начинающим разработчикам документации в этом нелегком деле.

О чем это я?

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

Ну, как-то так… Все условно, субъективно и путано.

Зачем оно вообще нужно?

Мало построить, удовлетворяющую нуждам предприятия ИС, необходимо сделать ее максимально управляемой. А назвать ИС управляемой, никак нельзя, если нет адекватной документации. Т.е. ИС может управляться создателями, но, что будет, когда им на смену придут другие?
Руководство, которое инвестирует в ИС предприятия, немало переживает по этому поводу. Предприятие зависит от своих процессов, которые, в свою очередь, попадают в серьезную зависимость от ИС. И все критичные процессы управления ИС на небольшом предприятии, зачастую, замыкаются на одной персоне. А, на мой взгляд, большинству не свойственно иметь желание беспрепятственно делиться «рычагами управления» и, связанными с этим знаниями, по причине опасений потерять значимость и вес. Хотя, по моему мнению, опасения эти неоправданны и желание беспрепятственно делиться знаниями дает обратный эффект. Посему, я часто вижу, что персона, управляющая ИС, является «гордым носителем тайных знаний» и «незаменимым кнопконажимателем». Вот она, одна из возможных предпосылок к недоверию между руководством и представителями ИТ. Одни не желают делиться деньгами, другие – знаниями. Порочный круг, который необходимо разорвать, дабы продолжить эффективно работать.

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

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

• Процесс создания документации позволяет обнаружить и исправить имеющиеся отклонения.
• Процесс создания документации позволяет систематизировать и «обернуть в формы» имеющиеся представления об ИС, позволяет укрепить свои знания.
• Созданная подробная документация призвана помогать в понимании того, «что», «как» и «почему». А т.к., людям свойственно забывать, то, как говорится, «Лучше плохой карандаш, чем хорошая память…».

«Опыт, сын ошибок трудных…»

В самом начале было не оформившееся понимание нужности наличия какой-либо документации. И в процессе внедрений неоднократно предпринимались попытки ее создания. Но не было опыта и знаний того, с какой стороны подойти к решению данного вопроса и не было тех, на кого можно было ровняться. Результаты попыток сложно назвать успешными, лучшее из созданного имело две схемы — «логическая схема инфраструктуры» и «территориальная схема» (созданные в Photoshop), и документ, пытающийся это описать. В общем, «документация» не превышала 20 страниц и не имела права «носить гордого имени». Были еще разрозненные таблицы (списки учетных, записей, ПК и т.д.), но не было системы.
Шло время, внедрялись новые сервисы, исправлялись ошибки, знания систематизировались, понимание задач оформлялось…
И, первым делом, был разработан документ «Правила доступа и использования данных локальной вычислительной сети». Документ, по сути, описывал политики безопасности предприятия в разрезе ИТ и регламентировал отношения пользователей с ОИТ. Руководство одобрило эту инициативу и выпустило приказ, делающий документ неотъемлемой частью «Правил внутреннего трудового распорядка предприятия». Мы, хоть и старались разработать документ, не теряющий актуальности, но, на текущий момент, ему, все же, необходима актуализация.

Приступим?

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

• Общее описание ИС (обобщенная схема архитектуры ИС, описание, цели, задачи, краткое описание сервисов)
• Списки используемого оборудования и ПО
• Схемы размещения оборудования (стойки, шкафы, сервера, коммутационное оборудование, ИБП, подключение электропитания, оборудованию даны уникальные имена и номера)
• Логическая схема размещения сервисов (размещение и взаимозависимости сервисов, использование служб ОС)
• Описания сервисов (каждый сервис может иметь свой набор документов, отражающих специфику, в большинстве своем, общими являются «Описание сервиса» и «Организация резервного копирования данных сервиса»)
• Приложения к документации (списки «Список учетных записей администраторов серверов и сервисов», «Список учетных записей пользователей, ПК и групп безопасности», «Рекомендации по техническому обслуживанию Сервисов ИС», обобщенные списки «Общий список настроек серверов» и «Общий список заданий резервного копирования»)

Таким образом, используя данную структуру, мы можем «легко и непринужденно» вносить изменения в содержание, добавляя или убирая сервисы (что и было доказано эмпирическим путем впоследствии).
Дальше, «самое трудное» – выбрать оптимальный уровень детализации, разделить функционал и назвать Сервисы, а, как говорится, «Как вы лодку назовете – так она и поплывет».
Начнем, пожалуй, с коммутаций и назовем «Сервис физических коммуникаций». Объединим под этим названием коммутационное оборудование, его конфигурации, линии связи, схемы подключения.
Следующим шагом, объединим Active Directory, DNS, DHCP, Certificate Authority и назовем «Сервис каталогов».
Продукты Forefront для защиты от вредоносного ПО и нежелательных сообщений объединим под названием «Сервис защиты».
И так далее — «Сервис БД» (SQL Server), «Сервис почты» (Exchange), «Сервис автоматизации управления предприятием» (1С), «Сервис файлового хранилища» (файловый сервер), «Сервис документооборота» (SharePoint (разработанный функционал дополняет документацию сервиса)), «Сервис маршрутизации (ISA Server)», «Сервис конференций» (Office Communication Server), «Сервис обновления ПО» (WSUS), «Сервис автоматизации проектных работ» (САПР), «Сервис виртуализации» (Virtual Server), «Сервис Интернет-сайта» (Windows SharePoint Services).
Основной инструмент – Office 2007. Для создания схем использовался Visio, описания и таблицы, естественно, с помощью Word и Excel. Разрабатывая и дополняя общее, документами, описывающими специфику сервиса, получаем вполне законченную структуру документации ИС («Список документации ИС»).

Содержание «Списка документации ИС» (на текущий момент)

1. Общий дизайн информационной системы:
	1.0. Общий дизайн информационной системы (схема)
	1.1. Общий дизайн информационной системы (пояснение)
2. Список используемого оборудования
3. Список используемого программного обеспечения
4. Детализированная схема размещения оборудования:
	4.0. Детализированная схема размещения оборудования (Серверная) (схема)
	4.1. Детализированная схема размещения оборудования (Серверная) (пояснение)
	4.2. Детализированная схема размещения оборудования (Точки коммутации) (схема)
	4.3. Детализированная схема размещения оборудования (Точки коммутации) (пояснение)
5. Сервис физических коммуникаций:
	5.0. Территориальная схема физических коммуникаций (схема)
	5.1. Территориальная схема физических коммуникаций (пояснение)
	5.2. Схема подключения физических коммуникаций (Точка коммутации №0) (схема)
	5.3. Схема подключения физических коммуникаций (Точка коммутации №0) (пояснение)
	5.4. Схема подключения физических коммуникаций (Точка коммутации №1) (схема)
	5.5. Схема подключения физических коммуникаций (Точка коммутации №1) (пояснение)
	5.6. Схема подключения физических коммуникаций (Точка коммутации №2) (схема)
	5.7. Схема подключения физических коммуникаций (Точка коммутации №2) (пояснение)
	5.8. Схема подключения физических коммуникаций (Точка коммутации №3) (схема)
	5.9. Схема подключения физических коммуникаций (Точка коммутации №3) (пояснение)
	5.10. Схема подключения физических коммуникаций (Точка коммутации №4) (схема)
	5.11. Схема подключения физических коммуникаций (Точка коммутации №4) (пояснение)
	5.12. Схема подключения физических коммуникаций (Точка коммутации №5) (схема)
	5.13. Схема подключения физических коммуникаций (Точка коммутации №5) (пояснение)
	5.14. Схема подключения физических коммуникаций (Точка коммутации №6) (схема)
	5.15. Схема подключения физических коммуникаций (Точка коммутации №6) (пояснение)
6. Логическая схема сервисов ИС:
	6.0. Логическая схема размещения сервисов ИС (схема)
	6.1. Логическая схема размещения сервисов ИС (пояснение)
7. Сервис каталогов (Active Directory):
	7.0. Описание сервиса каталогов
	7.1. Принципиальная схема организационных подразделений (схема)
	7.2. Принципиальная схема организационных подразделений (пояснение)
	7.3. Группы безопасности
	7.4. Групповые политики
	7.5. Службы разрешения имен (DNS)
	7.6. Службы автоматического назначения адресов (DHCP)
	7.7. Службы сертификации (CA)
	7.8. Организация резервного копирования данных сервиса каталогов
8. Сервис защиты (Forefront)
	8.0. Сервис защиты от вредоносного ПО
	8.1. Сервис защиты от нежелательных сообщений
9. Сервис почты (Exchange):
	9.0. Описание сервиса почты
	9.1. Принципиальная схема сервиса почты (схема)
	9.2. Принципиальная схема сервиса почты (пояснение)
	9.3. Организация резервного копирования данных сервиса почты
10. Сервис баз данных (SQL):
	10.0. Описание сервиса баз данных (SQL)
	10.1. Организация резервного копирования данных сервиса БД
11. Сервис автоматизации управления предприятием (1С):
	11.0. Описание сервиса автоматизации управления предприятием
	11.1. Подробная документация сервиса автоматизации управления предприятием
	11.2. Организация резервного копирования данных сервиса автоматизации управления предприятием
12. Сервис файлового хранилища:
	12.0. Описание сервиса и структуры организации хранения данных
	12.1. Структура организации хранения данных (схема)
	12.2. Структура организации хранения данных (пояснение)
	12.3. Автоматическое перенаправление данных пользователей
	12.4. Организация резервного копирования данных сервиса файлового хранилища
13. Сервис документооборота (SharePoint):
	13.0. Описание сервиса документооборота
	13.1. Подробная документация системы управления ИТ
		Система управления ИТ (схема)
		Система управления ИТ (описание)
		Система управления ИТ (описание КПЭ)
		Система управления ИТ (порядок работы с записями)
		Система управления ИТ (схемы процессов) и т.д.
	13.2. Подробная документация системы управления кадровыми ресурсами
	13.3. Подробная документация системы управления технологическим оборудованием
	13.4. Подробная документация системы управления заказами
	13.5. Организация резервного копирования данных сервиса документооборота
14. Сервис маршрутизации (ISA):
	14.0. Описание сервиса маршрутизации
	14.1. Схема организации подключений Интернет (схема)
	14.2. Схема организации подключений Интернет (пояснение)
	14.3. Политики доступа к внешним ресурсам
	14.4. Политики публикации внутренних ресурсов
	14.5. Организация резервного копирования данных сервиса маршрутизации
15. Сервис конференций (OCS):
	15.0. Описание сервиса конференций
	15.1. Организация резервного копирования данных сервиса конференций
16. Сервис обновления ПО (WSUS)
17. Сервис автоматизации проектных работ:
	17.0. Описание сервиса автоматизации проектных работ
	17.1. Подробная документация сервиса автоматизации проектных работ
	17.2. Организация резервного копирования данных САПР
18. Сервис виртуализации (VS)
19. Сервис Интернет-сайта (WSS):
	19.0. Описание сервиса Интернет-сайта
	19.1. Организация резервного копирования сервиса Интернет-сайта

Приложения:
Приложение 1. Список учетных записей администраторов серверов и сервисов (имя входа, роль, членство в группах безопасности, описание).
Приложение 2. Список учетных записей пользователей, ПК и групп безопасности (ФИО, имя входа, принадлежность к структурному подразделению, должность, членство в группах безопасности, почтовые адреса, квоты размеров почтовых ящиков). 
Приложение 3. Общий список настроек серверов (имена, сетевые настройки, запущенные службы, установленное ПО, расположение ключевых данных, конфигурации массивов).
Приложение 4. Общий список заданий резервного копирования (имена заданий, расписания, источник и назначение резервного копирования, подробные сценарии).
Приложение 5. Рекомендации по техническому обслуживанию Сервисов ИС.

Детализированная схема размещения оборудования (для примера)

Заключение…

Документация готова в установленные сроки и красуется на полке. На текущий момент, документация насчитывает более 100 документов, 30 из которых схемы, в электронном виде и 250 страниц на бумаге. Результат удовлетворил все ожидания – удобно пользоваться, легко изучать, просто вносить изменения и расширять, а самое главное – очень много, приятных глазу, цветных картинок…
Необходимо, также учесть один важный момент – обеспечить процессы своевременной актуализации документации, иначе – напрасный труд. А стало быть – будем работать в этом направлении…

О системе управления ИТ и о том, как у нас получилось обеспечить процессы актуализации