Слайд 33. Создание иэтр
Пояснения
Перед разработкой технического руководства необходимо провести анализ требований к документации и определить к какому классу будет относиться требуемая ИЭТР, а также провести оценку имеющихся средств на разработку.
Стоимость разработки является ключевым фактором при выборе оптимального уровня функциональности ИЭТР, но детальной модели анализа стоимости разработки ИЭТР не существует. При выборе концепции разработки необходимо рассмотреть все возможные варианты и по возможности обсудить с заказчиком различные схемы функциональности ИЭТР и соответствующие стоимости разработки.
Как правило, в контрактах указывается требование поставить твердую (бумажную) копию документации на изделие, в связи с чем перед началом разработки ИЭТР необходимо проанализировать затраты на последующее получение твердой копии ИЭТР. ИЭТР с функциональностью класса 1 или 2 позволяют получить бумажный вариант документации без существенных затрат. Если же рассматривать ИЭТР класса 3, 4 или класса 5, можно придти к выводу о большей сложности получения твердой копии этих руководств либо ее невозможности вообще.
Использование аудио и видео данных значительно улучшает качество и интерактивность электронных технических руководств, но при переводе документации в бумажный вид эти компоненты ИЭТР подлежат изменению: аудио данные без потери своих функциональных качеств могут быть представлены на странице руководства (например, в виде субтитров). Для видео данных нет способа эквивалентного представления на экране, но чаще всего видео фрагмент можно заменить набором изображений с текстовыми описаниями.
В любом случае при выборе концепции разработки ИЭТР необходимо учитывать данный фактор.
Разработку интерактивных электронных технических руководств рекомендуется начать одновременно с этапом проектирования изделия. Это позволит осуществлять обмен данными между системой проектирования и системой подготовки ИЭТР или настроить прямое интерфейсное взаимодействие между ними. Как правило, изделие и ИЭТР на него разрабатываются параллельно.
Слайд 34. Модель создания иэтр класса 3
Пояснения
Шаг 1: Необходимо определить список программного и аппаратного обеспечения, которое потребуется для перевода технического руководства в ИЭТР класса 3. Если в наличии не имеется лицензий на использование требуемого ПО, необходимо инициировать процесс приобретения лицензий.
Шаг 2:Необходимо разработать (или подобрать уже имеющиеся) DTD, наиболее соответствующие структуре и содержанию документации.
Шаг 3: На основе выбранного DTD необходимо разработать структуру руководства
Шаг 4: Необходимо установить перечень внутренних ссылок в документе (например, ссылки из оглавления документа в соответствующие главы) и внешних ссылок (на иллюстрации, графики, аудио, видео данные и т.п.)
Шаг 5: Для уменьшения объема работ необходимо убедиться, не имеется ли в наличии исходная документация в формате ASCII.
Шаг 6: Если в наличии не имеется документации в ASCII формате, ее необходимо перевести в данный формат.
Шаг 7: Необходимо разметить текстовый документ в соответствии с правилами стандарта ISO-8879 (SGML) и выбранным DTD.
Шаг 8: После получения SGML файлов необходимо проверить документацию на соответствие требованиям SGML(существует несколько программ проверки корректности) и при необходимости отредактировать данные.
Шаг 9: После получения документации в формате SGML ее необходимо конвертировать в ИЭТР.