Техническая документация    233

Наличие процедур позволит упорядочить происходящие в организации процессы и повысить ее безопасность. ИТ-специалисты не должны выполнять никаких действий в обход процедур, но, напротив, пресекать таковые.

Процедуры являются тем документом, на который можно сослаться в случае невыполнения каких-либо действий по объективным причинам.

Конечно же, не все можно описать конечным набором документов. Будут и такие ситуации, которые не укладываются в список описанных процедур. И в случае форс-мажорных обстоятельств вам не следует садиться за написание документа, потом согласовывать его и только после этого что-то делать. Вначале необходимо устранить опасность, проанализировать, предотвратить ее повторение и только потом приниматься за исправление документации.

Следует учесть, что документация никогда не сможет отхватить все, однако ее отсутствие представляет серьезные риски для организации.

Инструкции

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

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

Техническая документация

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

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

Хорошая документация должна содержать в себе следующие пункты:

аннотацию — краткое описание предназначения данного документа, функции ИС и ее компонентов;

234    Глава 18  •  Бумажная работа

список сокращений — облегчит понимание сути документа коллегами, а вам позволит быстрее справиться с его написанием;

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

инструкция для администратора — описание установки и конфигурации ИС, выполнение основных административных действий;

обновление ИС — процедуры обновления ИС, проверки ее работоспособности и устранения возможных проблем;

тестирование работоспособности — какие шаги следует принять для всесторонней проверки ИС, критерии удачного прохождения тестов;

аварийные ситуации — рассматриваются возможные нештатные ситуации работы ИС, алгоритмы поиска и устранения проблем, а также способы восстановления работоспособности.