Причины разделения технологической инструкции и руководства пользователя. Основные элементы технологической инструкции. Этапы разработки эксплуатационной документации. Средства автоматизированного документирования. Экспертиза технической документации.
Аннотация к работе
Разработка проектной и эксплуатационной документации на ИС.2 Разработка эксплуатационной документации на ИС Документация на ИС включает: документацию на ПО; документацию на ТС; документацию для персонала. Процесс создания документации пользователя программного средства»7 Разработка эксплуатационной документации8 Содержание плана документирования рабочее наименование, назначение, область применения и ограничения по использованию; спецификация стиля; определение аудитории пользователей; содержание документации с оценкой ее постраничного объема; номенклатура поставки; установление собственника авторских прав на документацию; обеспечение перевода документации на другие языки. уровни (грифы) секретности и конфиденциальности (при необходимости); процедуры и проверки, могущие влиять на процесс разработки документации; методы и средства производства и используемые версии данных средств; структура коллектива разработчиков документации; взаимосвязи (подчиненности) проекта; почасовая загрузка и зарплата персонала; требования к проектным ресурсам, включая информационные и прочие ресурсы, представляемые заказчиком, и срокам их представления; метод передачи документатору информации об изменениях программного средства в процессе его разработки; планы контроля изменений и сопровождения документации; планы проверки документации после ее создания; календарное планирование по контрольным точкам.9 Методы оценки трудоемкости разработки ТД ГОСТ Р ИСО/МЭК 15910-2002 «Информационная технология. 1 сут .14 Метрики документирования Метрики проекта Метрики пользовательской перспективы Метрики данных Метрики интерфейса пользователя Объем доступной документации; Количество экспертов Количество рецензентов Количество функциональных ролей; Количество пользовательских задач; Количество функций программы; Количество реакций пользователя на сообщения программы Количество сущностей; Количество атрибутов объектов; Количество поддерживаемых форматов данных Количество главных окон и рабочих областей; Количество крупных экранных форм; Количество команд главного меню; Количество сообщений об ошибках15 Последовательность разработки эксплуатационной документации Изучение продукта Чтение документации; Интервью; Работа на стенде Составление плана документирования Анализ требований к документу; Составление структуры документа; Составление и согласование плана документирования Написание текста Изложение структурной информации; Изложение процедурной информации; Изложение справочной информации; Подготовка рисунков Согласование текста Обсуждение замечаний; Внесение исправлений Оформление текста Авторская разметка; Расстановка перекрестных ссылок; Разметка указателя16 Для решаемой задачи измеряются значения каждого показателя из списка метрик. ЗАДАЧИ: проверка технической документации на комплектность; проверка структуры разделов технической документации на соответствие требованиям стандартов, нормативных документов и актов; проверка соответствия содержательной части технической документации требованиям НТД и техническим требованиям организации-эксперта.20 Техническая документация, подлежащая экспертизе Техническое задание на создание автоматизированной системы; Технический или технорабочий проект; Документы, разрабатываемые на стадии «Рабочая документация»; Эксплуатационная документация; Программа и методики испытаний.21 Взаимосвязь технической документации Техническое задание Пояснительная записка к техническому проекту Общее описание системы (рабочий проект) Требования Решения Стадия анализа предметной области Сведения о системе Проектная стадия Стадия реализации (разработки)22 Техническое задание Пояснительная записка к ТП Общее описание системы перечень подсистем, их назначение и основные характеристики... решения по структуре системы, подсистем… сведения об АС в целом и ее частях... требования к характеристикам взаимосвязей системы со смежными системами, требования к ее совместимости решения по взаимосвязям АС со смежными системами, обеспечению ее совместимости описание взаимосвязей АС с другими системами требования к режимам функционирования системы решения по режимам функционирования описание функционирования системы2324 Оценка трудоемкости разработки ТЗ Справочник базовых цен на разработку технической документации на автоматизированные системы управления технологическими процессами (АСУТП ) Разработчики: ЗАО «Научно-производственный центр «ВНИПИ САУ-40» ТП «ЦЕНТРИНВЕСТПРОЕКТ » Минстроя России.