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

ГОСТ Р ИСО 9127-94 Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов. Information processing systems. User documentation and cover information for consumer software packages. УДК 681.3.06:006.354 ОКС 35.080 П85 ОКСТУ 5001. Редакция от 09.02.2023.

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.5.5 Ошибки и сбои (ОБ) ГОСТ Р ИСО 9127-94

          Должны быть описаны все ошибочные и сбойные ситуации и соответствующие сообщения. Должны быть также приведены все корректирующие действия по всем ошибкам и сбоям [из 6.5.5 Ошибки и сбои (ОБ) ГОСТ Р ИСО 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.7 Тестирование (ФАК) ГОСТ Р ИСО 9127-94

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

                      Страницы

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