Описание применения. Требования к содержанию и оформлению

ГОСТ 19.101-77 определяет программный документ "Описание применения" как совокупность сведений о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях применения и минимальной конфигурации технических средств.

Согласно ГОСТ 19.502-78 документ должен содержать четыре составные части, которые уже упоминались выше. Титульная, информационная и часть регистрации изменений оформляются по общим правилам. Основная часть документа должна состоять из следующих разделов: назначение программы, условия применения, описание задачи (определения, метод и алгоритм решения), входные и выходные данные, основные характеристики занимаемой памяти, пример использования.

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

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

В разделе "Описание задачи" приводятся постановка задачи и математическая модель, описывается метод решения задачи. При описании метода решения необходимо сформулировать определения используемых понятий. Метод решения описывается словами с использованием математических формул и рисунков, необходимых для объяснения сути задачи.

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

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

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

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

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

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