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