ГОСТ Р ИСО 9127-94 Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов стр. 4

Должен быть точно определен язык программирования, преимущественно путем ссылки на соответствующий стандарт, если пользователю необходима эта информация, например для объединения пакета с другим программным средством. Дополнительно должны быть приведены наименование, вариант, версия и поставщик компилятора или интерпретатора.
Должно быть установлено, приняты ли какие-либо исключения для стандарта на язык.
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 Требования к техническим средствам (ОБ)