6 Справочная документация (ОБ) ГОСТ Р ИСО 9127-94

Справочная документация должна давать достаточно ясные и исчерпывающие сведения, позволяющие конечному пользователю успешно выбирать, вводить в действие и использовать программное средство.

В соответствующих местах должны быть даны примеры и иллюстрации и определены любые аббревиатуры и символы, использованные в справочной документации.

Должны быть также включены указания по использованию справочной документации [из 6 Справочная документация (ОБ) ГОСТ Р ИСО 9127-94]

6.1 Обозначение пакета (ОБ) ГОСТ Р ИСО 9127-94

6.1.1 Наименование и код пакета (ОБ) ГОСТ Р ИСО 9127-94

Должны быть приведены имя или заголовок, которым обозначен пакет, и подзаголовок, который указывает его функции. Должен быть также приведен код продукции или справочный номер пакета [из 6.1.1 Наименование и код пакета (ОБ) ГОСТ Р ИСО 9127-94]

6.1.2 Вариант (УСЛ) ГОСТ Р ИСО 9127-94

Должно быть приведено дополнительное обозначение для любого пакета, имеющего два или более текущих варианта (например, для различного оборудования или операционной системы) [из 6.1.2 Вариант (УСЛ) ГОСТ Р ИСО 9127-94]

6.1.5 Изготовитель или торгующая организация (ОБ) ГОСТ Р ИСО 9127-94

Должны быть приведены наименование и адрес изготовителя или организации, продающей программный пакет.

Примечание - Рекомендуется, чтобы обозначения элементов из 6.1.1-6.1.5 демонстрировались пользователю при загрузке программы. Обозначение, демонстрируемое на экране, должно соответствовать обозначению, приведенному в справочной документации [из 6.1.5 Изготовитель или торгующая организация (ОБ) ГОСТ Р ИСО 9127-94]

6.1.6 Ключевые слова (ФАК) ГОСТ Р ИСО 9127-94

Должны быть приведены ключевые слова или дескрипторы, которые характеризуют пакет и могут быть использованы для составления указателей или в целях поиска. Например, «обработка текстов», «широкоформатная таблица», «управление базой данных», «имитационная модель» [из 6.1.6 Ключевые слова (ФАК) ГОСТ Р ИСО 9127-94]

6.2 Компоненты пакета (ОБ) ГОСТ Р ИСО 9127-94

6.2.1 Поставляемые элементы (ОБ) ГОСТ Р ИСО 9127-94

Должны быть перечислены и обозначены по наименованиям и количеству все физические элементы пакета (например диски, кассеты, руководства и т. д.).

При необходимости, должно быть определено содержание физических элементов (например, программное обеспечение на дисках или кассетах, документы, включенные в руководства, и т. д.) [из 6.2.1 Поставляемые элементы (ОБ) ГОСТ Р ИСО 9127-94]

6.2.2 Сопутствующие объекты (УСЛ) ГОСТ Р ИСО 9127-94

Должны быть кратко описаны любые сопутствующие программы, аппаратура или документация, которые могут быть необходимы, но не включены в состав пакета. Должны быть также определены условия поставки и серийный номер любого такого объекта [из 6.2.2 Сопутствующие объекты (УСЛ) ГОСТ Р ИСО 9127-94]

6.3 Функциональное описание программного средства (ОБ) ГОСТ Р ИСО 9127-94

6.3.1 Назначение и область применения (ОБ) ГОСТ Р ИСО 9127-94

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

Должны быть даны примеры области применения программного средства.

При необходимости, должны быть описаны специфические и отличительные особенности программного средства, планируемые в будущем его модернизации и т. д. [из 6.3.1 Назначение и область применения (ОБ) ГОСТ Р ИСО 9127-94]

6.3.2 Условия эксплуатации (ОБ) ГОСТ Р ИСО 9127-94

  1. Требования к техническим средствам (ОБ)

    Должна быть определена конфигурация(и) технических средств, необходимых для прогона программного средства, включая требования к памяти. При необходимости должна быть дана ссылка на соответствующую документацию.

  2. Требования к программным средствам (УСЛ)

    Должны быть определены наименования, варианты, версии и даты любых других программных средств, необходимых для прогона данной программы, со ссылкой на соответствующую документацию.

  3. Требования к коммуникациям (УСЛ)

    Должны быть определены связные интерфейсы с другими системами.

    Должен быть определен используемый протокол и дана любая необходимая взаимосвязанная информация.

    Должны быть определены используемый набор символов или коммуникационный код и указаны любые исключения или специальные коды.

  4. Другие требования (УСЛ)

Должны быть описаны любые другие требования к условиям эксплуатации [из 6.3.2 Условия эксплуатации (ОБ) ГОСТ Р ИСО 9127-94]

6.3.3 Характеристики (УСЛ) ГОСТ Р ИСО 9127-94

  1. Рабочие характеристики (УСЛ)

    Должна быть приведена количественная информация для типовых примеров, такая как данные о производительности и уровне точности.

  2. Размер программы (ФАК)

    Должен быть установлен общий размер программы в общепринятых единицах (например, байтах, строках исходного кода).

  3. Скорость обработки (ФАК)

    Должна быть представлена информация о скорости обработки (например, скорость компиляции, время сортировки, скорость обмена, время поиска, время отклика).

[из 6.3.3 Характеристики (УСЛ) ГОСТ Р ИСО 9127-94]

6.3.4 Ограничения (УСЛ) ГОСТ Р ИСО 9127-94

Должны быть определены любые ограничения по использованию программного средства или его компонентов.

Должно быть указано, защищено ли программное средство от копирования [из 6.3.4 Ограничения (УСЛ) ГОСТ Р ИСО 9127-94]

6.3.5 Защита (УСЛ) ГОСТ Р ИСО 9127-94

Должны быть описаны любые защитные средства, позволяющие пользователю защищать программное средство или его компоненты и данные от несанкционированного доступа.

Должны быть также описаны любые способы проверки и средства дублирования данных [из 6.3.5 Защита (УСЛ) ГОСТ Р ИСО 9127-94]

6.4 Ввод в действие программного средства (ОБ) ГОСТ Р ИСО 9127-94

6.4.1 Ввод в действие (ОБ) ГОСТ Р ИСО 9127-94

Должна быть приведена любая необходимая информация о вводе в действие программного средства конечным пользователем, описывающая все действия, необходимые для ввода программного средства в его рабочее окружение, например подключение принтера, ввод спецификации принтера, ввод главного файла, прогон текстовой программы [из 6.4.1 Ввод в действие (ОБ) ГОСТ Р ИСО 9127-94]

6.4.3 Модификация программного средства (УСЛ) ГОСТ Р ИСО 9127-94

Если пользователь имеет возможность изменять программное средство под свое рабочее окружение или потребности, необходимая информация об этом должна быть приведена [из 6.4.3 Модификация программного средства (УСЛ) ГОСТ Р ИСО 9127-94]

6.5 Использование программного средства (ОБ) ГОСТ Р ИСО 9127-94

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

  1. подготовку к использованию;
  2. входные команды и данные;
  3. функции программного средства;
  4. вывод результатов;
  5. сообщения об ошибках и отказах, корректирующие и восстанавливающие действия.

Подготовка, ввод, обработка, вывод и ошибки могут быть описаны пофункционально или объединенно, как удобнее.

Должны быть приведены типовые примеры, помогающие пользователю понять работу программного средства, включая образцы листингов и экранных изображений данных и результатов [из 6.5 Использование программного средства (ОБ) ГОСТ Р ИСО 9127-94]

6.5.1 Загрузка программного средства (ОБ) ГОСТ Р ИСО 9127-94

Должны быть приведены инструкции по загрузке программного средства в ЭВМ. Когда требуются предварительные действия, такие как загрузка операционной системы, должны быть приведены соответствующие инструкции или дана ссылка на соответствующую документацию [из 6.5.1 Загрузка программного средства (ОБ) ГОСТ Р ИСО 9127-94]

6.5.2 Управляющие инструкции, команды или языковые правила (ОБ) ГОСТ Р ИСО 9127-94

  1. Управляющие инструкции и команды (ОБ)

    Должны быть четко определены форматы и функции всех управляющих инструкций или команд. Должны быть также определены любые ограничения по их применению, такие как режим работы, условия ввода и последовательности ввода.

  2. Выходные сообщения (ОБ)

    Должен быть указан список сообщений, отображаемых в ответ на управляющие инструкции или команды. Если сообщения не являются самоочевидными, их значения должны быть описаны. Должны быть также описаны любые действия, предпринимаемые пользователем в ответ на сообщения.

  3. Правила языка программирования (УСЛ)

    Для компиляторов должны быть описаны правила языка путем ссылки на соответствующую документацию (например ИСО 7185 для языка ПАСКАЛЬ).

[из 6.5.2 Управляющие инструкции, команды или языковые правила (ОБ) ГОСТ Р ИСО 9127-94]

6.5.3 Данные (ОБ) ГОСТ Р ИСО 9127-94

  1. Входные данные (УСЛ)

    Должны быть описаны содержание, логическая структура и формат входных данных, включая значение каждого элемента. Должна быть также описана любая зависимость данных от индивидуальных особенностей носителя данных.

    Если требуются другое оборудование или программные средства для подготовки входных данных к программе, например для создания файлов, требования к ним должны быть полностью определены.

  2. Вспомогательные данные (УСЛ)

    Должны быть описаны любые вспомогательные данные, требуемые для работы программного средства, например словарь для программы обработки текста.

  3. Выходные данные (ОБ)

    Должны быть описаны содержание и формат экранных изображений, печатных форм и любых других форм выходных данных. Должны быть приведены иллюстрации шаблона вывода.

  4. Промежуточные данные (УСЛ)

    Для понимания пользователем работы программного средства, при необходимости, должны быть описаны содержание и формат любых промежуточных данных.

  5. Ограничения на данные (УСЛ)

    Должны быть описаны любые ограничения на данные, например предел по числу разрядов.

  6. Хранение данных (УСЛ)

    Для понимания пользователем работы программного средства, при необходимости, должны быть описаны форматы файла и записей. Должно быть установлено, позволяют ли условия форматирования использовать файлы и записи других программных средств.

    Должны быть описаны любые ограничения, например максимальное число записей на файл, максимальное число файлов на диск.

[из 6.5.3 Данные (ОБ) ГОСТ Р ИСО 9127-94]

6.5.4 Обработка (УСЛ) ГОСТ Р ИСО 9127-94

При необходимости, должно быть приведено, для понимания пользователем работы программы, краткое описание функций, выполняемых программным средством в ответ на входные команды, инструкции и данные [из 6.5.4 Обработка (УСЛ) ГОСТ Р ИСО 9127-94]

6.6 Техническая информация о программном средстве (УСЛ) ГОСТ Р ИСО 9127-94

Для некоторых типов пакетов, например программных средств научного назначения, может быть необходимым представление технической информации о программе, например используемый язык, структура программного средства, используемый алгоритм [из 6.6 Техническая информация о программном средстве (УСЛ) ГОСТ Р ИСО 9127-94]

6.6.1 Язык (УСЛ) ГОСТ Р ИСО 9127-94

Должен быть точно определен язык программирования, преимущественно путем ссылки на соответствующий стандарт, если пользователю необходима эта информация, например для объединения пакета с другим программным средством. Дополнительно должны быть приведены наименование, вариант, версия и поставщик компилятора или интерпретатора.

Должно быть установлено, приняты ли какие-либо исключения для стандарта на язык [из 6.6.1 Язык (УСЛ) ГОСТ Р ИСО 9127-94]

6.6.2 Принципы и алгоритмы решения задач (ФАК) ГОСТ Р ИСО 9127-94

Должны быть описаны теоретические принципы, методы решения и алгоритмы, использованные в связи с определенными функциями и со структурной организацией программы. Должны быть приведены ссылки на соответствующую литературу.

Должны быть приведены уточнения любых специальных представлений символов или сочетаний символов, применяемых при решении задачи, особенно в части префиксов, суффиксов, обозначений, точности, округления, систем координат и диапазона значений [из 6.6.2 Принципы и алгоритмы решения задач (ФАК) ГОСТ Р ИСО 9127-94]

6.6.3 Структура программного средства (ФАК) ГОСТ Р ИСО 9127-94

Должна быть описана организация элементов программного средства (например программ, модулей, сегментов, общих областей памяти).

Представление структуры может быть графическим, например посредством древовидной структурной схемы или путем соответствующего структурированного текстового описания, оно может содержать наименования элементов, их точки входа и интерфейсы, так же как и их взаимосвязи [из 6.6.3 Структура программного средства (ФАК) ГОСТ Р ИСО 9127-94]

6.8 Договорная информация (ОБ) ГОСТ Р ИСО 9127-94

6.8.2 Юридические права и обязанности (ОБ) ГОСТ Р ИСО 9127-94

Должны быть описаны юридические обязанности изготовителя и права потребителя, включая:

  1. обучение и соответствующую помощь;
  2. поддержку программного средства (исправление ошибок и т. д.);
  3. гарантии качества (приемочные испытания и т. д.);
  4. доступность исходной программы.

Должен(ны) быть приведен(ы) адрес(а) организации(й) или лица(лиц), ответственных за выполнение вышеперечисленных задач [из 6.8.2 Юридические права и обязанности (ОБ) ГОСТ Р ИСО 9127-94]

6.8.3 Стандарты и законы (ФАК) ГОСТ Р ИСО 9127-94

Должны быть приведены ссылки на любые примененные стандарты.

Должны быть установлены степень или уровень, до которых следуют стандарту, в случае неполного соответствия ему [из 6.8.3 Стандарты и законы (ФАК) ГОСТ Р ИСО 9127-94]

6.11 Замечания конечных пользователей (ФАК) ГОСТ Р ИСО 9127-94

Должны быть приведены способы, с помощью которых конечные пользователи могут делать замечание о точности и полезности документации. Это может быть сделано в форме предварительно отпечатанной, оплаченной для пересылки почтовой карточки, возвращаемой изготовителю или торгующей организации [из 6.11 Замечания конечных пользователей (ФАК) ГОСТ Р ИСО 9127-94]