Mikluho.md 5.5 KB
# Оформление основных эксплуатационных документов на автоматизированную систему.
Введение
современном мире каждый день появляется десятки и сотни различных программ, приложений, информационных систем. Они могут быть разработаны как для государственного или коммерческого сектора, так и для обычных пользователей. 90% всех пользователей не читает документацию, считает её скучной, занудной и неинтересной, а открывает руководство пользователя только тогда, когда что-то не получается или разобраться без инструкции уж совсем невозможно. Общепринято теперь строить пользовательский интерфейс таким образом, чтобы он был интуитивно понятен, и пользователь мог разобраться с системой, не прибегая к чтению длиннейших мануалов. Однако, при работе с крупными заказчиками практически всегда необходимо сдать определённый пакет документов – руководств, инструкций, проектных решений, оформленных по ГОСТу. Когда впервые сталкиваешься с написанием документации по ГОСТу, то приходишь в ступор и полный шок, так как этих ГОСТов «море» и, как и чего по ним писать становится неясно. В этой статье рассмотрены ГОСТы для написания документации и их основные моменты.
Какие основные документы входят в состав эксплуатационной документации?
- руководство пользователя;
- руководство администратора;
- руководство программиста;
- и т.д.
Стоит отметить, что все эти документы – это лишь основной перечень в соответствии с ролями пользователей (программист, администратор, обычный пользователь). Однако в комплекте эксплуатационной документации помимо Руководства пользователя очень часто встречается Краткое руководство пользователя, Руководство по быстрому старту и т.д. – все эти документы по сути также являются Руководством пользователя, но представлены в несколько иных вариациях.
Какие бывают ГОСТы?
Для начала надо разобраться какие бывают ГОСТы. Все лишь знают, что ГОСТ — это нечто, что разрабатывалось при Союзе и их просто бесконечное количество. Спешу вас успокоить для сферы IT ГОСТов не так много, и они все, несмотря на свой срок создания, не потеряли своей актуальности. В первую очередь стандарты для написания документации делятся на два типа:
- Международные стандарты (ISO, IEEE Std);
- Российские или Советские ГОСТы.
Документация на автоматизированную систему (АСУ ТП)
Автоматизированная система (ACУ) – совокупность технических и программных средств и персонала, реализующая информационную технологию установленных функций по обработке информации.
Процесс создания технической документации на АСУ представляет собой совокупность взаимосвязанных стадий (этапов) работ, а именно:
Заключение
ГОСТ — это не страшно и несложно! Главное понять, что нужно написать и какой для этого ГОСТ используется. Наши основные ГОСТы 19 и 34 для написания документации очень старые, но и по сей день актуальны. Написание документации по стандарту снимает множество вопросов между исполнителем и заказчиком. Следовательно, несёт в себе экономию времени и денег.