Эксплуатационная документация Одним из самых распространенных видов технической документации является эксплуатационная документация. Для чего предназначен данный тип документации и каким требованиям должен удовлетворять? Эксплуатационная документация – это вид технической документации, описывающий порядок установки, настройки и использования разработанного программного обеспечения (автоматизированной системы). Именно эксплуатационную документацию мы чаще всего подразумеваем, когда говорим о программной документации в целом. Какие основные документы входят в состав эксплуатационной документации? - техническое задание;
- руководство пользователя;
- руководство администратора;
- руководство программиста;
Техническое задание Техническое задание представляет собой документ, в котором формулируются основные цели разработки, требования к программному продукту, определяются сроки и этапы разработки и регламентируется процесс приемно-сдаточных испытаний. В формулировании технического задания участвуют представители как заказчика, так и исполнителя (разработчик). В основе этого документа лежат исходные требования, заказчика, результаты выполнения предпроектных исследований и т. п. Техническое задание (ТЗ) должно быть составлено так, чтобы программист, получивший этот документ, разработал именно то, что заказчик хотел получить Программный документ «Техническое задание» разрабатывается в соответствии с ГОСТ 19.201 — 78. В соответствии с ГОСТ 19.201 — 78 программный документ «Техническое задание» содержит следующие разделы. Введение. 1. Основание для разработки. 2. Назначение разработки. 3. Требования к программе или программному изделию. 4. Требования к программной документации. 5. Технико-экономическое обоснование. 6. Стадии и этапы разработки. 7. Порядок контроля и приемки. 8. Приложения. Техническое задание является юридическим документом — как приложение включается в договор между заказчиком и исполнителем на проведение проектных работ и является его основой: определяет порядок и условия работ, в том числе цель, задачи, принципы, ожидаемые результаты и сроки выполнения. Руководство пользователя Цель создания документа заключается в том, чтобы предоставить пользователю возможность самостоятельно решать свои прикладные задачи с помощью системы. Этой цели может служить и введение в предметную область, и ознакомление со всеми возможностями программы, и описание конкретных процедур решения задач, и приведение различных инструкций. Иногда Руководство пользователя больше похоже на справочник, к которому можно обращаться в процессе работы, а иногда – на учебник, который позволяет изучить принципы работы с программой и ее возможности, а затем применять их на практике. Руководство администратора Проектная документация на автоматизированную систему очень важна, так как является определяющей в процессе разработки и представляет собой то видение системы, которое будет в дальнейшем реализовано. Однако, не менее важны и эксплуатационные документы, которые позволят использовать и обслуживать систему правильно, эффективно и с минимальными затратами. Одним из необходимых в процессе эксплуатации системы документов является Руководство администратора. Роль администратора системы заключается в том, чтобы организовывать и поддерживать работу конечных пользователей, тогда как обеспечение технической работоспособности системы обычно обеспечивается другими людьми. Руководство программиста Руководство программиста относится к эксплуатационно-технической документации и требуется в тех случаях, когда система тем или иным образом предоставляет возможность написания, редактирования или использования программного кода. Примерами могут служить: – библиотека функций; – платформа или среда для разработки ПО; – ПО с открытым кодом. В соответствии с какими отечественными стандартами разрабатывается эксплуатационная документация? – ЕСКД, Единая система конструкторской документации (ГОСТ 2); – ЕСПД, Единая система программной документации (ГОСТ 19); – КСАС, Комплекс стандартов на автоматизированные системы (ГОСТ 34). Каждая из вышеперечисленных серий ГОСТ предъявляет свои требования к составу, порядку разработки и ведения комплектов эксплуатационной документации, а также к содержанию и оформлению отдельных документов комплекта. В соответствии с какими зарубежными стандартами разрабатывается эксплуатационная документация? Данный вид документации в плоскости зарубежных стандартов разработки документации соответствует следующим видам: – End user, руководства для пользователей, администраторов и обслуживающего персонала (аналог Руководство пользователя, Руководство администратора); – Technical, описание кода, алгоритмов и интерфейсов (аналог Руководство программиста, Справочник разработчика). В отличие от ГОСТов, за рубежом изначально несколько иной подход к стандартам документирования. Эксплуатационная документация в ИТ сфере – это комплект документов, в которых описываются узлы ИТ системы, требования по их техническому обслуживанию, ремонту, хранению, а также нормы безопасности. Такого рода документация важна как при внедрении ИТ системы, так и в процессе ее использования и может описывать как материальные объекты (локальные сети, компьютерную технику), так и программное обеспечение. - Информационная – изначальное и текущее состояние системы и какое развитие ее ожидает в дальнейшем.
- Охранительная – описание требований по безопасности; снижение затрат вследствие обучения персонала безопасным методам работы; защита от материального и нематериального вреда (взломы, кражи, порча, утеря); облегченное лицензирование программных продуктов.
- Техническая — снижение рисков при сбое системы и меры по ее быстрому восстановлению.
- Познавательная — повышение общей компетентности персонала, вследствие проработанного информационного описания системы и ее узлов.
Пример эксплуатационной документации для кабельных сетей компании (СКС, ЛВС, ВОЛС): - инструкции по эксплуатации;
- схемы размещения объектов кабельных сетей;
- спецификация оборудования;
- таблицы и схемы коммутации;
- кабельные журналы;
- протоколы плановых испытаний.
Пример эксплуатационной документации на программный продукт: - описание программного продукта;
- области применения;
- требования к аппаратному обеспечению;
- описание языка программирования;
- руководство пользования для пользователей программы;
- справочная информация (F.A.Q.)
|
Скачать 394.42 Kb.