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

Описание программного обеспечения — документ в составе комплекта технической документации на автоматизированную систему. Предусмотрен КСАС. Разрабатывается на стадии технического проекта.

Стандарты

ГОСТ 34.201— 2020, п. 3

Общие сведения о документе

Стадия создания	Код документа	Часть проекта	Принадлежность к		Дополнительные указания
			проектно-сметной документации	эксплуатационной документации
ТП	ПА	ПО	—	—	—

ГОСТ Р 59795—2021, п. 9.1

Требования к содержанию документов с решениями по программному обеспечению

1. Документ «Описание программного обеспечения» должен содержать вводную часть и следующие разделы:

• структура программного обеспечения АС;
• функции частей программного обеспечения АС;
• методы и средства разработки программного обеспечения АС;
• операционная система;
• средства, расширяющие возможности операционной системы.
  

2. Во вводной части приводят основные сведения о техническом, информационном и других видах обеспечения АС, необходимые для разработки программного обеспечения АС, или ссылку на соответствующие документы проекта АС.

3. В разделе «Структура программного обеспечения АС» приводят перечень частей программного обеспечения АС с указанием их взаимосвязей и обоснованием выделения каждой из них.

4. В разделе «Функции частей программного обеспечения АС» приводят назначение и описание основных функций для каждой части программного обеспечения АС.

5. В разделе «Методы и средства разработки программного обеспечения АС» приводят перечень методов программирования и средств разработки программного обеспечения АС с указанием его частей, при разработке которых следует использовать соответствующие методы и средства.

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

7. Раздел «Средства, расширяющие возможности операционной системы» должен содержать подразделы, в которых для каждого используемого средства, расширяющего возможности операционной системы, приводят:

• наименование, обозначение и краткую характеристику средства с обоснованием необходимости его применения и указанием источника, где дано подробное описание выбранного средства;
• наименование руководства, в соответствии с которым следует настраивать используемое средство на конкретное применение;
• требования к настройке используемого средства.
  

Практика

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

Тема	Документ
Порядок установки и настройки программы, поддержание ее экземпляра в работоспособном состоянии	Руководство системного программиста
Использование программы	Руководство оператора
	Руководство пользователя
Детали реализации программы	Описание программы
Встраивание программы в другие программы и системы	Руководство программиста

Программное обеспечение, описанное в документе, должно соответствовать требованиям, приведенным в подразделе «Требования к программному обеспечению» ТЗ на АС.

Шаблоны

Шаблон	Описание
Филогост	Комплект шаблонов и пустографок для Microsoft Word