5.4.4.Описание применения

Текст раздела Описание применения должен состоять из следующих подразделов:

1. назначение программы;

2. условия применения;

3. описание задачи;

4. входные и выходные данные.

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные подразделы.

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

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

В подразделе “Описание задачи” должны быть указаны определения задачи и методы ее решения.

В подразделе “Входные и выходные данные” должны быть указаны сведения о входных и выходных данных.

5.4.5.Руководство системного программиста

Текст раздела Руководство системного программиста должен содержать следующие подразделы:

1. общие сведения о программе;

2. структура программы;

3. настройка программы;

4. проверка программы;

5. дополнительные возможности;

6. сообщения системному программисту.

В зависимости от особенностей программы допускается объединять отдельные подразделы или вводить новые.

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

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

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

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

В подразделе “Проверка программы” должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).

В подразделе “Дополнительные возможности” должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора.

В подразделе “Сообщения системному программисту” должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.

В разделе к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).

5.4.6.Руководство программиста

Раздел Руководство программиста должен содержать следующие подразделы:

1. назначение и условия применения программы;

2. характеристики программы;

3. входные и выходные данные;

4. сообщения.

В зависимости от особенностей ПЗ допускается объединять отдельные разделы или вводить новые.

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

В подразделе “Обращение к программе” должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.).

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

В подразделе “Сообщения” должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо принять по этим сообщениям.

В разделе к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).