В книге рассмотрена технология создания документации на информационную систему как программный продукт, обрабатывающий информацию, с опорой на существующие в странах СНГ стандарты. Сложные системы (наподобие АСУ или АСУ ТП), включающие в себя технические устройства и требующие дополнительной (конструкторской) документации, здесь подробно не рассматриваются по причине малого опыта автора в этой области.
Документирование информационной системы (ИС) можно разбить на пять этапов:
1)Подготовительный этап;
2)Начальный этап;
3)Основной этап;
4)Заключительный этап;
5)Этап доработки.
В книге первые четыре этапа описаны в разделе «Процессы документирования», так как это обязательные этапы при разработке новой ИС. Этапы эти в явной или скрытой форме входят в технологические процессы разработки ИС, независимо от того, фиксируются они в Договоре на разработку или нет. Технический писатель (или специалист, который занимается документированием, но числится в другой должности) должен это понимать и принимать, как должное. Пятый этап вынесен в раздел «Доработка документации в процессе эксплуатации ИС» по причине того, что не каждая разработанная система будет проходить сертификацию или аттестацию по информационной безопасности (ИБ) или будет служить достаточно долго и успешно, что потребуется ее доработка или развитие, которое сопровождается внесением (обязательным по стандартам, но часто не исполняемым требованием) изменений в документацию.
Терминология документирования при разработке программных продуктов (программного обеспечения), к которым относятся и информационные системы, сложна и основана на трех составляющих:
1)Терминология, относящаяся непосредственно к производству документов (программных и эксплуатационных, законодательных и технических, организационных и административных);
2)Терминология, относящаяся к области производства программного обеспечения (разработка ПО и ИС);
3)Терминология, относящаяся к области информационной безопасности, которая сейчас играет значимую роль.
Приведём несколько определений основных понятий, которые используются в процессе создания документации на ИС по существующим стандартам (таблицы 1 и 2).
Таблица 1. Определения ИС
Примечание по РК. В Казахстане профессии (должности) определяемой как