Руководство

33 - Руководство программиста ГОСТ 19.504-79

33 Аннотация [из п. 1.1 ГОСТ 19.504-79]

Next Icon

Аннотация

Настоящий документ представляет собой Руководство программиста ПК «Интероперабельность».

Документ предназначен для участников команды проекта, осуществляющих разработку ПК «Интероперабельность», а также персонала ФГУП «Спецтяжмонтажстройсельхозавтоматика», ответственного за эксплуатацию ПК «Интероперабельность» в части использования по назначению.

Основная часть документа содержит сведения о назначении, условиях применения, характеристиках ПК «Интероперабельность», способы обращения к ПК «Интероперабельность», сведения о входных и выходных данных, а также сообщения ПК «Интероперабельность».

34 - Руководство оператора ГОСТ 19.505-79

34 - Руководство оператора ГОСТ 19.505-79

Next Icon

Аннотация

Настоящий документ представляет собой Руководство оператора ПК «Интероперабельность».

Документ предназначен для персонала ФГУП «Спецтяжмонтажстройсельхозавтоматика», ответственного за эксплуатацию ПК «Интероперабельность» в части использования по назначению.

Документ разработан согласно ГОСТ 19.505-79, структура и оформление документа соответствуют ГОСТ 19.105-78, основные надписи титульной части - по ГОСТ 19.104-78, выполнен печатным способом согласно ГОСТ 19.106-78.

Основная часть документа содержит сведения о назначении, условиях выполнения, выполнении ПК «Интероперабельность» и сообщения оператору.

Как писать руководство пользователя? Часть I - обобщенная структура руководства пользователя по ГОСТам 19-й системы и сравнительный ее анализ с рекомендациями IEEE Std 1063-2001

Как писать руководство пользователя? Часть I - обобщенная структура руководства пользователя по ГОСТам 19-й системы и сравнительный ее анализ с рекомендациями IEEE Std 1063-2001

Сравнительный анализ структур руководств пользователя программы по ЕСПД и IEEE Std 1063-2001 с учетом рекомендаций «манифеста Кагарлицкого». Показано, что обобщенная структура руководства пользователя, собранная согласно требованиям «устаревших» ГОСТов 19-й системы, существенно превосходит структуру руководства, рекомендуемую суперсовременным IEEE Std 1063-2001. Редакция от 20.06.2018.

Как писать руководство пользователя? Часть II - обобщенная структура руководства пользователя по ГОСТ 19.ххх, IEEE Std 1063-2001 и пример наполнения руководства пользователя содержимым

Как писать руководство пользователя? Часть II - обобщенная структура руководства пользователя по ГОСТ 19.ххх, IEEE Std 1063-2001 и пример наполнения руководства пользователя содержимым

Обобщенная структура руководства пользователя программы на основе ГОСТов 19-й системы, IEEE Std 1063-2001 и с учетом рекомендаций «манифеста Кагарлицкого», установлена степень опциональности разделов руководства в зависимости от того, кому поставляется программа, частично заполнены разделы и подразделы руководства. Редакция от 20.06.2018.

Интерактивное электронное техническое руководство по ГОСТ Р 53394-2017

Интерактивное электронное техническое руководство по ГОСТ Р 53394-2017

Обобщенное название для взаимосвязанной совокупности эксплуатационных документов, выполненных в форме интерактивного электронного документа по ГОСТ 2.051 и, как правило, содержащихся в одной общей базе данных эксплуатационной документации.

Примечание - Английский эквивалент термина «интерактивное электронное техническое руководство» - interactive electronic technical manual [из п. 3.40 ГОСТ Р 53394-2017]

Интерактивное электронное техническое руководство по ГОСТ Р 53394-2017

Задание требований к интерактивному электронному техническому руководству [из подр. 5.1 ГОСТ Р 54088-2017]

Задание требований к интерактивному электронному техническому руководству [из подр. 5.1 ГОСТ Р 54088-2017]

Требования к ИЭТР устанавливают на основании настоящего стандарта с учетом требований ГОСТ 2.601 и ГОСТ 2.602. Эти требования должны быть увязаны с другими требованиями к изделию и системе его ТЭ. Разработчик изделия устанавливает требования к ИЭТР самостоятельно или по согласованию с заказчиком (заказчиками) конкретного типа изделия с учетом особенностей его конструкции, применения по назначению и ТЭ. При этом в ТЗ устанавливают:

[из подр. 5.1 ГОСТ Р 54088-2017]

Требования к содержанию и оформлению интерактивного электронного технического руководства [из подр. 5.3 ГОСТ Р 54088-2017]

Требования к содержанию и оформлению интерактивного электронного технического руководства [из подр. 5.3 ГОСТ Р 54088-2017]

Требования к содержанию ИЭТР устанавливаются в соответствии с ГОСТ 2.610 и нормативными документами, применяемыми для конкретных видов техники, в зависимости от вида(ов) ЭД (РД), выполняемого(ых) в форме ИЭТР [из п. 5.3.1 ГОСТ Р 54088-2017]

Реквизитная часть информационных объектов в ОБДЭ и в локальной БД ИЭТР - по ГОСТ 2.058 [из п. 5.3.2 ГОСТ Р 54088-2017]

Для идентификации информационных объектов в ОБДЭ и в локальных БД в составе ИЭТР используют коды (например, код МД, код СЧ по каталогу, логистический контрольный номер СЧ и т.д.) определенного синтаксиса и формата [из п. 5.3.3 ГОСТ Р 54088-2017]

Коды информационных объектов в ОБДЭ должны быть постоянными для всего ЖЦ изделия [из п. 5.3.4 ГОСТ Р 54088-2017]

ИЭТР представляют в одной из двух форм: странично-ориентированной и полностью интерактивной.

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

Во втором случае ИЭТР содержит локальную БД. ЭСО в составе ИЭТР обеспечивает полноценное интерактивное взаимодействие пользователя с указанной БД [из п. 5.3.5 ГОСТ Р 54088-2017]

Требования к функциональности интерактивного электронного технического руководства [из подр. 5.4 ГОСТ Р 54088-2017]

Требования к функциональности интерактивного электронного технического руководства [из подр. 5.4 ГОСТ Р 54088-2017]

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

  1. доступ;
  2. создание примечаний;
  3. поставка (распространение);
  4. контроль и прогнозирование;
  5. внешние процессы;
  6. использование графических объектов;
  7. создание ссылок;
  8. навигация и отслеживание;
  9. печать;
  10. использование специальных сведений;
  11. внесение изменений;
  12. выбор режима работы пользователя.

[из п. 5.4.1 ГОСТ Р 54088-2017]

В категории «доступ» задают требования в части разграничения доступа к данным между разными категориями пользователей [из п. 5.4.2 ГОСТ Р 54088-2017]

В категории «создание примечаний» задают требования в части возможностей пользователей добавлять метки и примечания к тексту и графике ИЭТР [из п. 5.4.3 ГОСТ Р 54088-2017]

В категории «поставка (распространение)» задают требования к способам передачи ИЭТР от поставщика к заказчику, а также способы доведения данных до конечных пользователей (эксплуатационного персонала заказчика). При установлении требований в этой категории учитывают располагаемые виды носителей информации и методы передачи данных, возможности существующей инфраструктуры и уровень подготовки пользователей к применению ИЭТР [из п. 5.4.4 ГОСТ Р 54088-2017]

В категории «контроль и прогнозирование» задают требования в части функциональных возможностей ИЭТР для его использования при выявлении отказов и повреждений изделия и (или) прогнозировании их появления путем контроля предотказных состояний СЧ изделия или изделия в целом [из п. 5.4.5 ГОСТ Р 54088-2017]

В категории «внешние процессы» задают требования в части функциональных возможностей ИЭТР, позволяющих пользователю интегрировать содержащиеся в ИЭТР данные в другие информационные системы (например, используемые для управления ТЭ). Такая совместная работа разных автоматизированных систем, как правило, повышает эффективность использования каждой из систем за счет обмена данными между ними [из п. 5.4.6 ГОСТ Р 54088-2017]

В категории «использование графических объектов» задают требования к способам взаимодействия с графической информацией, например:

При установлении требований в этой категории учитывают, что более сложные графические представления могут увеличить стоимость ИЭТР и повысить требования к программно-аппаратным средствам [из п. 5.4.7 ГОСТ Р 54088-2017]

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

В категории «навигация и отслеживание» задают требования к применяемым методам навигации по содержанию ИЭТР, времени поиска нужных сведений, способам отслеживания истории работы с ИЭТР, установления закладок и т.п. При этом учитывают возможности использования как традиционных интерфейсов, так и голосовых команд, диалогового общения пользователя с ИЭТР, различных способов фильтрации, например фильтрации данных по наименованию типа, модели, идентификационному номеру (например, обозначению или заводскому номеру) изделия, номеру извещения об изменении (бюллетеня) или коду исполнителя работ и др. [из п. 5.4.9 ГОСТ Р 54088-2017]

В категории «печать» задают требования к организации с помощью ИЭТР печати ЭД (РД) в соответствии с требованиями к бумажной ЭД (РД) либо к печати отдельных элементов данных (таблиц, иллюстраций, снимков экрана и т.п.). Здесь же реализуют функции, обеспечивающие учет распечатанных на бумаге копий ЭД (РД) [из п. 5.4.10 ГОСТ Р 54088-2017]

В категории «использование специальных сведений» задают требования к воспроизведению с помощью программы просмотра дополнительных типов данных (например, аудио- и видеоданных или анимации). При установлении требований в этой категории учитывают, что включение возможности вывода более сложных мультимедийных данных может увеличить стоимость ИЭТР и повысить требования к программно-аппаратным средствам [из п. 5.4.11 ГОСТ Р 54088-2017]

В категории «внесение изменений» задают требования к способам внесения изменений в данные, содержащиеся в ИЭТР, и способам их отображения ЭСО. При просмотре изменения могут отмечаться специальными метками и иными признаками [из п. 5.4.12 ГОСТ Р 54088-2017]

В категории «выбор режима работы пользователя» задают требования к способам реализации в ИЭТР разных режимов работы пользователя, включая режимы доступа к внешним источникам данных. Как правило, функциональные возможности этой категории зависят от организации работ, производственного оснащения эксплуатанта изделия и возможностей программного обеспечения по взаимодействию с внешними источниками данных [из п. 5.4.13 ГОСТ Р 54088-2017]

Дополнительные элементы требований к функциональным характеристикам ИЭТР по указанным в 5.3.1 категориям приведены в приложении А [из п. 5.4.14 ГОСТ Р 54088-2017]

Для различных видов ИЭТР применяют разные виды требований из числа указанных в настоящем стандарте. Для систематизации требований к разным видам ИЭТР, выпускаемых для одного изделия, при составлении ТЗ, разработке, испытаниях и контроле качества ИЭТР рекомендуется использовать матрицу функциональности ИЭТР. В матрице используют установленные настоящим стандартом наименования категорий функциональных требований и оформляют ее в виде таблицы.

В заголовки столбцов таблицы (слева направо) помещают:

  • «Функциональные требования»;
  • «Форма ИЭТР»;
  • «Наименование».

В столбце «Функциональные требования» в качестве заголовка каждой из строк таблицы помещают категории функциональности (виды функциональных требований) согласно 5.3.1 и приложению А к настоящему стандарту.

В столбце «Форма ИЭТР» для каждого вида ИЭТР указывают его выполнение: странично-ориентированное или интерактивное.

В столбце «Наименование» для каждого вида ИЭТР указывают применимые функциональные требования. Для этого в ячейках матрицы, находящихся на пересечении столбца с наименованием вида ИЭТР и строки с наименованием (видом) функционального требования, проставляют символы (например, «X» или «+»), указывающие на необходимость данной функциональности для данного вида ИЭТР [из п. 5.4.15 ГОСТ Р 54088-2017]

Заполненная матрица функциональности содержит формализованные требования к функциональным характеристикам ИЭТР и может использоваться впоследствии при оценке соответствия ИЭТР заданным требованиям [из п. 5.4.16 ГОСТ Р 54088-2017]

Страницы

«Техническая документация»

Связь по эл. почте admin @ tdocs . su (без пробелов), тел. +7(967) 044-84-77 или в форме Контакты.

Copyright © «Техническая документация» 2008. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика