Мы уже разобрались, зачем докуменировать IT-проекты. А еще выяснили, как создавать хорошую рабочую документацию. Что ж, пора переходить к следующему этапу – разработке эксплуатационной документации.

Для чего она нужна?

Эксплуатационная документация отвечает на простой, но очень важный, вопрос – как использовать IT. Информация подается в руководствах, инструкциях, объяснительных записках и т.д. Но IT могут использовать как штатные сотрудники компании, так и конечные потребители ее услуг. Соответственно, инструкции нужны и тем, и другим. И они бывают очень разными.

Основные виды эксплуатационной документации

Документация к программному продукту

Не важно, создали вы его сами или купили у производителя. Если IT-продукт нужен бизнесу, важно позаботиться о том, чтобы с ним научились работать как штатные специалисты, так и потребители услуг. Такая документация включает:

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

Документация к аппаратному обеспечению

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

Документация к сервису

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

Документация к автоматизированной системе

Речь идет о полноценной системе, состоящей из отдельных сервисов, которая разворачивается в рамках текущей инфраструктуры. И не важно, используете ли вы эту систему прямо сейчас, или только собираетесь вводить в эксплуатацию. Что должно быть в документации к такой системе?

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

Общая эксплуатационная документация для всей IT-системы

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

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

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