5. Документирование программного обеспечения

5.1. Общие положения

Программная и эксплуатационная документация может использоваться для изготовления и сопровождения программного изделия, для его тестиро­вания (испытания), для его эксплуатации.

Документирование должно начинаться одновременно с разработкой про­дукта или даже раньше В процессе разработки создаются следующие ос­новные программные документы:

Текст программ — запись программы с необходимыми комментариями.

Описание программы — сведения о логической структуре и функциони­ровании программы.

Программа и методика испытаний — требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля.

Техническое задание — см. раздел 2.4.

Пояснительная записка — схема алгоритма, общее описание алгоритма и/или функционирования программы, а также обоснование принятых техни­ческих и экономических решений.

Эксплуатационные документы:

Руководство пользователя — сведения о назначении программы, области применения, применяемых методах, ограничениях при применении, конфи­гурации технических средств; сведения для обеспечения процедуры общения пользователя с вычислительной системой в процессе выполнения програм­мы. Создается на основе документов “Описание применения” и “Руково­дство оператора”, описанных в ЕСПД.

Руководство системного администратора — сведения для обеспечения установки, функционирования и настройки программ на условия конкретно­го применения. Создается на основе документа “Руководство системного программиста”, описанного в ЕСПД.

5.2. Программа и методика испытаний

Документ должен содержать сле­дующие разделы:

• объект испытаний;

• цель испытаний;

• состав предъявляемой документации;

• технические требования;

• порядок проведения испытаний;

• методы испытаний.

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

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

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

В разделе “Состав предъявляемой документации” указывают перечень документации, предъявляемой при проведении испытаний.

Раздел “Технические требования” может состоять из следующих подраз­делов:

• требования к программной документации;

• требования к техническим характеристикам.

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

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

• требования к характеристикам программы применительно к условиям эксплуатации;

• требования к информационной и программной совместимости.

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

для испытаний.

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

В методах испытаний должны быть приведены описания проверок с ука­занием результатов проведения испытаний (перечня тестовых примеров, контрольных распечаток тестовых примеров и т.п.).

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