ГОСТ Р ИСО 9127-94

Группа П85

     

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


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

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

Information processing systems. User documentation and cover information for consumer software packages

ОКСТУ 5001

ОКС 35.080     

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

Предисловие

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

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

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

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

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

________________
     * Доступ к международным и зарубежным документам, упомянутым в тексте, можно получить, обратившись в Службу поддержки пользователей. - Примечание изготовителя базы данных.

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

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

     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) условная - информация, поставляемая с каждым пакетом, для которого она необходима;

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

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

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

     5 Назначение

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

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

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

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

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

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

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

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

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

     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 Назначение и область применения (ОБ)

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

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

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