Документ "Описание программного обеспечения"

РД 50-34.698-90. Автоматизированные системы. Требования к содержанию документов: <...>.

УКАЗАНИЯ ГОСТ:
Настоящие методические указания распространяются на автоматизированные системы (АС), используемые в различных сферах деятельности (управление, исследование, проектирование и т. п.), включая их сочетание, и устанавливают требования к содержанию документов, разрабатываемых при создании АС.

Описание программного обеспечения

Структура документа:
ВВЕДЕНИЕ
1 СТРУКТУРА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
2 ФУНКЦИИ ЧАСТЕЙ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
3 МЕТОДЫ И СРЕДСТВА РАЗРАБОТКИ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
4 ОПЕРАЦИОННАЯ СИСТЕМА
5 СРЕДСТВА, РАСШИРЯЮЩИЕ ВОЗМОЖНОСТИ ОПЕРАЦИОННОЙ СИСТЕМЫ
5.1 Наименование и краткая характеристика средства
5.2 Руководство по настройке средства
5.3 Требования по настройке средства

ВВЕДЕНИЕ

УКАЗАНИЯ ГОСТ:
Во вводной части приводят основные сведения о техническом, информационном и других видах обеспечения АС, необходимые для разработки программного обеспечения или ссылку на соответствующие документы проекта АС.
ПРИМЕР СОДЕРЖАНИЯ:
АИС «Кадры» предназначена для комплексного информационно-аналитического обеспечения процессов федерального агентства "Государственные Кадры", в части исполнения следующих процессов:
...
...
...

Сведения о техническом обеспечении АС Кадры приведены в пояснительной записке к техническому проекту (п.3.8).
Сведения об информационном обеспечении АС Кадры приведены в документе «Описание информационного обеспечения системы».

1 СТРУКТУРА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

УКАЗАНИЯ ГОСТ:
В разделе "Структура программного обеспечения" приводят перечень частей программного обеспечения с указанием их взаимосвязей и обоснованием выделения каждой из них.
ПРИМЕР СОДЕРЖАНИЯ:
Наполнение этого раздела можно взять в ТЗ, пункте "4.1.1.1 Перечень подсистем, их назначение и основные характеристики".
Содержание необходимо переписать в императиве (не "В состав АС Кадры должны входить следующие подсистемы", а "В состав АС Кадры входят следующие подсистемы").

2 ФУНКЦИИ ЧАСТЕЙ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

УКАЗАНИЯ ГОСТ:
В разделе "Функции частей программного обеспечения" приводят назначение и описание основных функций для каждой части программного обеспечения.
ПРИМЕР СОДЕРЖАНИЯ:
Наполнение этого раздела можно взять в ТЗ, пункте "4.2 Требования к функциям (задачам), выполняемым системой".
Содержание необходимо переписать в императиве (не "Модуль должен реализовывать следующие функции", а "Модуль реализует следующие функции").

3 МЕТОДЫ И СРЕДСТВА РАЗРАБОТКИ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

УКАЗАНИЯ ГОСТ:
В разделе "Методы и средства разработки программного обеспечения" приводят перечень методов программирования и средств разработки программного обеспечения АС с указанием частей программного обеспечения, при разработке которых следует использовать соответствующие методы и средства.
ПРИМЕР СОДЕРЖАНИЯ:
Проектирование модели предметной области АС «Кадры» выполнялось с использованием программного средства Rational Rose Enterprise Edition.
Проектирование структур баз данных АС «Кадры» выполнялось с использованием программного средства Microsoft Visio 2003 Enterprise Architect.
Создание программного обеспечения АС «Кадры» и создание установочных пакетов выполнялось с помощью среды разработки Microsoft Visual Studio 2005 Team Server.
Управление изменениями требований к АС «Кадры» выполнялось с помощью программного средства Rational Rose RequisitePro.

4 ОПЕРАЦИОННАЯ СИСТЕМА

УКАЗАНИЯ ГОСТ:
В разделе "Операционная система" указывают:

1) наименование, обозначение и краткую характеристику выбранной операционной системы и ее версии, в рамках которой будут выполнять разрабатываемые программы, с обоснованием выбора и указанием источников, где дано подробное описание выбранной версии;
2) наименование руководства, в соответствии с которым должна осуществляться генерация выбранного варианта операционной системы;
3) требования к варианту генерации выбранной версии операционной системы.

ПРИМЕР СОДЕРЖАНИЯ:
Для выделенного сервера баз данных АС «Кадры» могут быть использованы следующие операционные системы:
- Microsoft Windows 2000 Server SP4;
- Microsoft Windows 2003 Server SP2.
Предпочтительным является использование операционной системы Microsoft Windows 2003 Server SP2.
Для клиентской части программного обеспечения АС «Кадры» могут быть использованы следующие операционные системы:
- Microsoft Windows 2000 Professional SP4;
- Microsoft Windows XP Professional SP2.
Предпочтительным является использование операционной системы Microsoft Windows XP Professional SP2.

5 СРЕДСТВА, РАСШИРЯЮЩИЕ ВОЗМОЖНОСТИ ОПЕРАЦИОННОЙ СИСТЕМЫ

ПРИМЕР СОДЕРЖАНИЯ:
В состав программного обеспечения АС «Кадры» не входят средства, расширяющие возможности операционной системы.

ПРИМЕР СОДЕРЖАНИЯ:
В состав программного обеспечения АС «Кадры» входят следующие средства, расширяющие возможности операционной системы:
- Программная библиотека доступа к функциям сервера СУБД.

5.1 Наименование и краткая характеристика средства

ПРИМЕР СОДЕРЖАНИЯ:
Библиотека доступа "БДУправ 1.0".

5.2 Руководство по настройке средства

ПРИМЕР СОДЕРЖАНИЯ:
Настройка не производится.

5.3 Требования по настройке средства

ПРИМЕР СОДЕРЖАНИЯ:
Требования по настройке средства не предъявляются.