ГОСТ Р ИСО 9127-94

Системы обработки информации

ДОКУМЕНТАЦИЯ ПОЛЬЗОВАТЕЛЯ
И ИНФОРМАЦИЯ НА УПАКОВКЕ
ДЛЯ ПОТРЕБИТЕЛЬСКИХ
ПРОГРАММНЫХ ПАКЕТОВ

ГОССТАНДАРТ РОССИИ

Москва

Предисловие

1 РАЗРАБОТАН Московским научно-исследовательским центром (МНИЦ) и Всероссийским научно-исследовательским институтом стандартизации (ВНИИстандарт) Госстандарта России

ВНЕСЕН Комитетом при Президенте Российской Федерации по политике информатизации

ПОДГОТОВЛЕН Техническим комитетом по стандартизации ТК 22 «Информационная технология»

2 ПРИНЯТ И ВВЕДЕН В ДЕЙСТВИЕ Постановлением Госстандарта России от 10 октября 1994 г. № 242

3 Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО 9127-88 «Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов»

4 ВВЕДЕН ВПЕРВЫЕ

5 ПЕРЕИЗДАНИЕ. Сентябрь 2003 г.

СОДЕРЖАНИЕ

ГОСТ Р ИСО 9127-94

ГОСУДАРСТВЕННЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИ

Дата введения 1995-07-01

1. Область применения

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

- Документация пользователя

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

Документация пользователя описана в части I настоящего стандарта.

- Информация на упаковке

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

Информация на упаковке описана в части II настоящего стандарта.

Настоящий стандарт не распространяется на:

- торговые публикации;

- брошюры и листовки, целью которых является содействие распространению пакета;

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

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

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

2. Нормативные ссылки

В настоящем стандарте использована ссылка на следующий нормативный документ:

ИСО 7185-90 Информационная технология. Языки программирования. ПАСКАЛЬ

3. Определения

В настоящем стандарте применены следующие определения:

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

3.2.2. потребитель: Организация или человек, которые покупают программный пакет.

3.2.3. конечный пользователь: Человек, который использует программный пакет.

3.2.4. изготовитель: Организация, которая разрабатывает программный пакет.

3.2.5. торгующая организация: Организация, которая распространяет программный пакет.

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

3.2.7. поддержка программного средства: Действие по поддержанию программы и соответствующей ей документации в состоянии функционирования.

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

3.2.8. условия эксплуатации: Конфигурация аппаратных и программных средств, в которой эксплуатируется программа.

Например, тип(ы) компьютера, операционная система, другие программные средства и периферийное оборудование, под которые спроектирована программа.

4. Категории информации

В настоящем стандарте определены три категории информации:

a) обязательная - информация, поставляемая с каждым пакетом;

b) условная - информация, поставляемая с каждым пакетом, для которого она необходима;

c) факультативная - информация, поставляемая по усмотрению изготовителя или торгующей организации.

Аббревиатуры ОБ, УСЛ, ФАК означают соответственно обязательную, условную, факультативную информацию.

Часть I ДОКУМЕНТАЦИЯ ПОЛЬЗОВАТЕЛЯ (ОБ)

5. Назначение

Назначением документации пользователя является обеспечение конечного пользователя достаточной информацией для ясного понимания:

a) цели, функций и характеристик программного средства;

b) того, как ввести в действие и использовать программное средство;

c) договорных прав и обязанностей.

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

При необходимости к документации могут быть выпущены дополнения, например:

- список опечаток в документации;

- список установленных, но не исправленных ошибок в программной продукции с описанием известных последствий.

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

6. Справочная документация (ОБ)

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

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

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

6.1. Обозначение пакета (ОБ)

6.1.1. Наименование и код пакета (ОБ)

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

6.1.2. Вариант (УСЛ)

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

6.1.3. Версия (УСЛ)

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

6.1.4. Даты (ОБ)

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

6.1.5. Изготовитель или торгующая организация (ОБ)

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

Примечание - Рекомендуется, чтобы обозначения элементов из 6.1.1 - 6.1.5 демонстрировались пользователю при загрузке программы. Обозначение, демонстрируемое на экране, должно соответствовать обозначению, приведенному в справочной документации.

6.1.6. Ключевые слова (ФАК)

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

6.1.7. Язык (ФАК)

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

6.2. Компоненты пакета (ОБ)

6.2.1. Поставляемые элементы (ОБ)

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

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

6.2.2. Сопутствующие объекты (УСЛ)

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

6.3. Функциональное описание программного средства (ОБ)

6.3.1. Назначение и область применения (ОБ)

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

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

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

6.3.2. Условия эксплуатации (ОБ)

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

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

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

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

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

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

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

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

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

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

6.3.3. Характеристики (УСЛ)

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

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

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

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

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

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

6.3.4. Ограничения (УСЛ)

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

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

6.3.5. Защита (УСЛ)

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

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

6.4. Ввод в действие программного средства (ОБ)

6.4.1. Ввод в действие (ОБ)

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

6.4.2. Создание дублирующих копий (УСЛ)

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

6.4.3. Модификация программного средства (УСЛ)

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

6.5. Использование программного средства (ОБ)

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

a) подготовку к использованию;

b) входные команды и данные;

c) функции программного средства;

d) вывод результатов;

e) сообщения об ошибках и отказах, корректирующие и восстанавливающие действия.

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

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

6.5.1. Загрузка программного средства (ОБ)

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

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

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

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

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

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

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

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

6.5.3. Данные (ОБ)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

6.5.4. Обработка (УСЛ)

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

6.5.5. Ошибки и сбои (ОБ)

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

6.6. Техническая информация о программном средстве (УСЛ)

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

6.6.1. Язык (УСЛ)

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

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

6.6.2. Принципы и алгоритмы решения задач (ФАК)

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

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

6.6.3. Структура программного средства (ФАК)

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

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

6.7. Тестирование (ФАК)

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

6.8. Договорная информация (ОБ)

6.8.1. Обязательства или гарантии (ОБ)

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

6.8.2. Юридические права и обязанности (ОБ)

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

a) обучение и соответствующую помощь;

b) поддержку программного средства (исправление ошибок и т.д.);

c) гарантии качества (приемочные испытания и т.д.);

d) доступность исходной программы.

Должен(ны) быть приведен(ы) адрес(а) организации(й) или лица(лиц), ответственных за выполнение вышеперечисленных задач.

6.8.3. Стандарты и законы (ФАК)

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

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

6.9. Словарь (УСЛ)

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

6.10. Указатель (УСЛ)

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

6.11. Замечания конечных пользователей (ФАК)

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

7. Учебная документация (ФАК)

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

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

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

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

8. Быстрая справочная документация (ФАК)

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

Также рекомендуется обеспечение экранного меню и средств «помощи».

Часть II ИНФОРМАЦИЯ НА УПАКОВКЕ (ОБ)

9. Назначение

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

10. Содержание

10.1. Обозначение пакета (ОБ)

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

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

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

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

10.2. Назначение и область применения (ОБ)

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

10.3. Условия эксплуатации (ОБ)

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

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

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

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

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

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

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

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

10.4. Ввод (ФАК)

Должны быть определены или описаны устройство ввода или носитель, например клавиатура, «джойстик», «мышь», файл.

10.5. Вывод (ФАК)

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

10.6. Ограничения на данные или файлы (УСЛ)

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

10.7. Инструкции по использованию (ФАК)

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

10.8. Дополнительная информация (ФАК)

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

10.9. Договорная информация (УСЛ)

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

- авторское право;

- лицензионные элементы и условия использования;

- элементы прав и обязанностей.

10.10. Адрес обслуживания потребителя (ФАК)

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

10.11. Поставляемые элементы (ОБ)

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

10.12. Стандарты и законы (ФАК)

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

10.13. Независимая сертификация (ФАК)

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

10.14. Код продукции (ОБ)

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

10.15. Цена (ФАК)

Должна быть установлена рекомендуемая цена.