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

Введение

В книге рассмотрена технология создания документации на информационную систему как программный продукт, обрабатывающий информацию, с опорой на существующие в странах СНГ стандарты. Сложные системы (наподобие АСУ или АСУ ТП), включающие в себя технические устройства и требующие дополнительной (конструкторской) документации, здесь подробно не рассматриваются по причине малого опыта автора в этой области.

Документирование информационной системы (ИС) можно разбить на пять этапов:

1)Подготовительный этап;

2)Начальный этап;

3)Основной этап;

4)Заключительный этап;

5)Этап доработки.

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

Термины и определения

Терминология документирования при разработке программных продуктов (программного обеспечения), к которым относятся и информационные системы, сложна и основана на трех составляющих:

1)Терминология, относящаяся непосредственно к производству документов (программных и эксплуатационных, законодательных и технических, организационных и административных);

2)Терминология, относящаяся к области производства программного обеспечения (разработка ПО и ИС);

3)Терминология, относящаяся к области информационной безопасности, которая сейчас играет значимую роль.

Приведём несколько определений основных понятий, которые используются в процессе создания документации на ИС по существующим стандартам (таблицы 1 и 2).

Таблица 1. Определения ИС

Примечание по РК. В Казахстане профессии (должности) определяемой как Технический писатель не существует. Есть должность Начальник отдела автоматизированной системы управления производством (АСУП) (подразделения или центра информационных технологий) которая требует от работника знания порядка разработки и оформления технической документации и вменяет в обязанность руководство разработкой и участие в разработке ТЗ, инструкций, методических и нормативных материалов.

Термин «информационная система» вошел в обиход в 90-е годы 20 века, после взрывного развития технологий обработки информации с помощью компьютерной техники. Ранее использовался термин «автоматизированная система», который сейчас используется как один из признаков информационной системы (степень автоматизации). До сих пор действуют стандарты комплекса 34 на автоматизированные системы, разработанные в конце 80-х и начале 90-х годов 20 века, которые иногда обновляются и приводятся в более современный вид.

Таблица 2. Определения других понятий

Ранее использовались стандарты комплекса 24 на автоматизированные системы управления, разработанные в середине 80-х годов 20 века и теперь замененные комплексом 34.

Рассмотрим понятия автоматизированной системы и документации на неё, которые даются в комплексе 34 (ГОСТ 34.003-90):

– Автоматизированная система (АС) – система, состоящая из персонала и комплекса средств автоматизации его деятельности, реализующая информационную технологию выполнения установленных функций;

– Документация на АС – комплект взаимоувязанных документов, полностью определяющих технические требования к АС, проектные и организационные решения по созданию и функционированию АС.

Часть терминологии по производству документов определена следующими стандартами:

1)По части документации, обобщённо называемой ОРД, используется ГОСТ Р 7.0.97-2016 «Система стандартов по информации, библиотечному и издательскому делу. Организационно-распорядительная документация. Требования к оформлению документов», введенному взамен ГОСТ Р 6.30-2003 «Унифицированные системы документации. Унифицированная система организационно-распорядительной документации. Требования к оформлению документов»;

2)По части программной документации используются стандарты комплекса 19:

– ГОСТ 19.004-80 «Термины и определения»,

– ГОСТ 19.103-77 «Обозначение программ и программных документов»,

– ГОСТ 19 105-78 «Общие требования к программным документам»;

3)По части эксплуатационной документации используются стандарты комплекса 34: