Документирование инфраструктуры информационных технологий в организации

1. Техническая документация и ее потребители в компании

Почему IT-департаментом приходится заниматься документированием.

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

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

2. Заказные разработки: требования к документированию и приемка технической документации у исполнителя

Состав требований к документированию заказной разработки. Применение стандартов при формировании требований к документированию, ГОСТы серий 34, 19, 7 и 2. Требования формальные и требования содержательные.

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

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

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

3. Собственные разработки: процесс документирования

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

Разработчики технической документации, средства разработки технической документации: возможные варианты и выбор из них.

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

4. Эксплуатируемые IT-ресурсы: описание практики использования и учет

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

5. Техническая документация как IT-ресурс

Стандарт организации на документирование. Ведение единого каталога технической документации на все компоненты IT-инфраструктуры. Сопровождение технической документации, поддержание ее постоянной актуальности. Публикация технической документации в корпоративной сети. Автоматизация документирования, технологии 'единого источника'. Формирование технической документации на основе конфигурационной базы данных. Особенности документирования приложений при подготовке интеграционных проектов.