Состав программного документа

Виды программных документов

ЕСПД устанавливает следующие вида программных документов:

· спецификацию, содержащую состав программы и документацию на нее;

· ведомость держателей подлинников – перечень предприятий, на которых хранят подлинники программных документов;

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

· пояснительную записку, содержащую общее описание алгоритма и функционирования программы;

· программу и методику испытаний, содержащие требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля;

· описание программы – сведения о логической структуре и функционировании программы;

· текст программы – запись программы с необходимыми комментариями;

· эксплуатационные документы, которые, в свою очередь, содержат:

ведомость эксплуатационных документов – перечень эксплуатационных документов на программу;

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

описание применения – содержит сведения о назначении, области применения программы, методах и классе решаемых задач;

руководство программиста – содержит сведения, необходимые при эксплуатации программ;

руководство системного программиста – содержит сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения;

описание языка – определяет синтаксис и семантику языка взаимодействия пользователя с программой;

руководство оператора – содержит сведения, необходимые для обеспечения процедуры общения оператора ЭВМ в процессе выполнения программы;

руководство по техническому обслуживанию – содержит описание применения текстовых и диагностических программ при обслуживании технических средств.

Материалы каждого программного документа необходимо располагать в такой последовательности:

· лист утверждения;

· титульный лист;

· аннотация, в которой кратко излагают назначение и содержание документа;

· содержание, текст документа (с рисунками, таблицами и т.п.);

· приложения;

· перечень ссылочных документов.

Содержание основных документов

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

Техническое задание включает следующие разделы:

¨ введение – даются наименование и краткая характеристика области применения программного изделия;

¨ основания для разработки – указываются наименования документов, на основании которых ведется разработка;

¨ назначение разработки – определяются функциональное и эксплуатационное назначение программного изделия;

¨ требования к программному изделию – содержит подразделы:

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

условия эксплуатации (условия окружающей Среды, выбор типов носителей информации, вид обслуживания, количество и квалификация персонала);

требования к составу и параметрам технических средств; к информационной и программной совместимости (требования к языкам программирования, программным и операционным системам);

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

¨ технико-экономические показатели;

¨ стадии и этапы разработки – устанавливаются необходимые стадии, этапы и содержание работ, а также сроки разработки;

¨ порядок контроля и приемки – указываются виды испытаний и общие требования к приемке работы.

Пояснительная записка включает следующие разделы:

¨ введение;

¨ назначение и область применения;

¨ технические характеристики – содержит подразделы:

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

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

описание и обоснование выбора метода организации входных и выходных данных, состава технических и программных средств;

¨ ожидаемые технико-экономические показатели.

Программа и методика испытаний включает следующие разделы:

¨ объект испытаний – дается наименование и обозначение испытуемой программы;

¨ цель испытаний – указывается цель проведения испытаний;

¨ состав предъявляемой документации – приводится перечень документации, предъявляемой при проведении испытаний;

¨ технические требования – включают подразделы - требования к программной документации; техническим характеристикам; информационной и программной совместимости;

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

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

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

¨ общие сведения – указываются наименование и обозначение программы, программное обеспечение, необходимое для ее функционирования, языки программирования, на которых написана программа;

¨ функциональное назначение – даются классы решаемых задач и сведения о функциональных ограничениях на их применение;

¨ входные данные – описываются характер, организация и предварительная подготовка входных данных, формат и способ их кодирования;

¨ выходные данные – приводятся те же сведения, что и в разделе “Входные данные”;

¨ описание логической структуры – содержит подразделы:

используемые методы;

структуру программы с описанием функций составных частей и связи между ними;

структуру и организацию данных, используемых в программе;

алгоритм программы;

связь программы с другими программами;

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

¨ используемые технические средства – даются типы ЭВМ и устройств, которые применяются при работе программы.

Текст программы содержит символическую запись программы на языке программирования с комментариями, отражающими структуру и назначение частей программы.

Описание применения – эксплуатационный документ, включающий разделы:

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

¨ условия применения – формулируются условия, необходимые для выполнения программы (требования к техническим средствам, другим программам, общие характеристики входной и выходной информации);

¨ описание задачи – определяется задача и методы ее решения;

¨ входные и выходные данные – указываются сведения о входных и выходных данных.

Руководство программиста – эксплуатационный документ, включающий разделы:

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

¨ характеристики программы – описываются основные характеристики и особенности программы (режим работы, средства контроля правильности выполнения и т.п.);

¨ обращение к программе – описываются процедуры вызова программы, способы передачи управления и параметров;

¨ входные и выходные данные – описываются организация входной и выходной информации, способы ее кодирования;

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

Руководство оператора (пользователя) – эксплуатационный документ, включающий разделы:

¨ назначение программы – приводятся сведения, необходимые для понимания функций программы и условий ее эксплуатации;

¨ условия выполнения программы – указываются условия, состав аппаратных и программных средств, необходимых для выполнения программы;

¨ выполнение программы – описываются последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, дается описание функций команд, с помощью которых оператор управляет выполнением программы;

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