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

При разработке документации необходимо придерживаться требований СТП101-00 и стандартов ЕСПД. Стандарт предприятия разработан с учетом всех действующих ГОСТов на документацию. При работе необходимо изучить следующие разделы:

- оформление текста;

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

- аннотация;

- содержание;

- введение;

- основная часть;

- изложение текста;

- заключение;

- оформление иллюстраций;

- построение таблиц;

- список использованных источников;

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

- графическая часть;

- схемы;

- кодирование документов;

- общие требования к оформлению работ.

В стандарте ЕСПД необходимо обратить внимание на следующие разделы:

- виды программных документов ГОСТ 19.101-77;

- стадии разработки ГОСТ 19.102-77;

- техническое задание. Требования к содержанию и оформлению ГОСТ 19.201-78;

- схемы алгоритмов, программ данных и систем ГОСТ 19.701-90;

- текст программы ГОСТ 19.401-78;

- описание программы ГОСТ 19.402 -78;

- программа и методика испытаний ГОСТ 19.301-79

- пояснительная записка ГОСТ 19.404-79;

- описание применения ГОСТ 19.502-78;

- руководство программиста ГОСТ 19.504-79;

- руководство оператору ГОСТ 19.505-79.

Содержание отчета

Отчет должен иметь следующую структуру и состоять из разделов.

Аннотация

Введение

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

1.1 Основное функциональное назначение программного средства

1.2 Полное наименование программного средства

1.3 Условное обозначение программного средства

1.4 Разработчики программного средства

2 Техническое задание

2.1 Основание для разработки

2.2 Назначение разработки

2.3 Требования к программному средству

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

2.5 Требования к эргономике и технической эстетике

2.6 Стадии и этапы разработки

3 Пояснительная записка

3.1 Реализация функционального назначения программного средства

3.2 Разработка алгоритма решения задачи

3.2.1 Детальная разработка алгоритмов отдельных подзадач

3.3 Структурная организация данных

3.4 Разработка интерфейса ПС

3.5 Описание структуры выходной информации

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

5.1 Назначение и условия применения программного средства

5.2 Характеристика программного средства

5.3 Работа с программным средством

5.4 Входные и выходные данные

5.5 Сообщения программисту

6 Руководство пользователя

6.1 Назначение программного средства

6.2 Условия выполнения программного средства

6.3 Эксплуатация программного средства

6.4 Сообщения пользователю

7 Заключение

8 Список использованной литературы

9 Приложения

В пояснительной записке должна содержаться следующая информация.

Аннотация. В аннотации указывается тема работы, ее основное назначение, функции, выполняемые программным средством (ПС), объем пояснительной записки, перечень графической части работы, перечень приложений и др. (Приложение Д).

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

Общие сведения о ПС. В этом разделе описывается назначение ПС, т.е. какую задачу оно решает и где может найти применение. Указывается полное наименование ПС с расшифровкой слов, которые представлены аббревиатурой. Указывается условное обозначение ПС, которое дали ему авторы разработки, например пакет прикладных программ (ППП) «OMEGA» или программный комплекс (ПК) «НАДЕЖДА» и др. Представляются авторы разработки: Фамилия, имя, отчество, основное место учебы (учеба и работа), а также та часть работы, которая выполнялась в данном курсом проекте.

Далее необходимо сформулировать техническое задание, на данную работу состоящее из нескольких разделов.

Основание для разработки. В этом разделе должны быть указаны документы, на основании которых ведется разработка, организация, утвердившая этот документ, дата утверждения, наименование или условное обозначение темы разработки.

Назначение разработки. Здесь должно быть указано функциональное и эксплутационное назначение ПС.

Требования к ПС. В этом разделе должна содержаться следующая информация:

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

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

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

- условия эксплуатации (температура, влажность, количество и квалификация персонала);

- требования к составу и параметрам технических средств (состав технических средств с указанием их технических характеристик);

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

- требования к транспортировке и хранению;

- специальные требования.

Требования к программной документации. Указываются стандарты, на основании которых должна выполняться документация на разрабатываемое ПС и состав документации.

Требования к эргономике и технической эстетике. Формулируются требования к организации пользовательского интерфейса. Общий дизайн ПС. Представление выходной информации (иллюстрации, графическое представление информации, анимация и т.д.).

Стадии и этапы разработки. Указываются сроки разработки, т. е. временной период, в течение которого данная работа должна быть выполнена. А также, на какие этапы данная работа разбита (Приложение Е).

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

Разработка алгоритма решения задачи. На основе анализа всех функций, которые должно выполнять проектируемое ПС, необходимо разработать и описать алгоритм решения задачи. В зависимости от выполнения или невыполнения тех или иных условий показать порядок и последовательность решения задачи. Логическую структуру ПС показать на укрупненной схеме алгоритма.

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

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

Разработка интерфейса ПС. В этом разделе необходимо описать структуру разработанного интерфейса. Обосновать его эргономичность.

Описание структуры выходной информации. Здесь необходимо описать, какую информацию можно получить в результате эксплуатации ПС.

Разделы пояснительной записки могут сопровождаться схемами, для повышения наглядности процесса проектирования ПС (см. Приложение Ж).

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

Назначение и условия применения ПС. Поясняется основное функциональное назначение ПС и возможность его применения. Минимальный состав технических средств с указанием их технических характеристик для нормальной эксплуатации ПС.

Характеристика ПС. Дается краткая характеристика ПС: режимы работы, необходимый объем памяти для эксплуатации, средства контроля и др.

Работа с ПС. Здесь поясняется обращение к программе, способы передачи управления, вызов программы и др.

Входные и выходные данные. В этом разделе описывается организация входных и выходных данных.

Сообщения программисту. Если в ПС при проектировании предусмотрена возможность расширения или изменения некоторых функций они должны быть описаны для программиста, который будет заниматься сопровождением ПС.

В разделе «Руководство пользователя» нужно представить информацию необходимою для эксплуатации ПС. Должна быть описана последовательность выполнения работы, средства защиты, разработанные в данном ПС, реакцию ПС на неверные действия пользователя.

Назначение ПС. В этом разделе дается краткое описание основного назначения ПС.

Условия выполнения программы. Описываются условия, при которых данное ПС может нормально функционировать (минимальный или максимальный состав аппаратуры и ПС).

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

Сообщения пользователю. При эксплуатации программного средства, могут быть предусмотрены различные сообщения, которые поясняют действия пользователя, предотвращают ошибки и дают возможность исправить допущенные ошибки.

Заключение. В заключении приводятся основные выводы и перспективы дальнейшего развития представленного ПС.

В разделе «Список использованных источников» дается перечень всей литературы, которая была использована при разработке ПС и оформлении документации на него. Список использованных источников формируется в том порядке, в котором были ссылки на использованную литературу, с указанием издательства, года издания и количества листов в книге согласно СТП101-00 (Приложение З).

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