Техническая документация

Техническая документация содержит программные документы на разработанные программные средства. Список программных документов определен в техническом задании. Техническая документация на разработанные программные средства оформляется в соответствии с требованиями ЕСПД.

Программные документы должны быть сброшюрованы в следующей последовательности:

1. Спецификация на комплекс (в случае комплекса программ)

2. Спецификация на компонент

3. Текст программы (компонента)

4. Описание программы (компонента)

5. Руководство программиста (компонента)

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

При наличии нескольких компонентов пункты 2-6 повторяются необходимое количество раз.

 

Методические указания по распределению информации

Между главами дипломного проекта.

В этом разделе приводится примерное распределение информации между главами. В зависимости от конкретной задачи содержание глав может варьироваться.

Описание предметной области

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

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

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

Технология функционирования объекта. Описание функционирования объекта производится в нотации методологии функционального моделирования SADT, как подмножества стандарта IDF0 [1,2]. Эта нотация позволяет представить функции предприятия, функциональные связи и данные (информацию или объекты), которые связывают эти функции.

 

Постановка задачи

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

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

Входная информация. Идентификаторы (наименование документа), формы представления сообщений, сроки и частоту поступления, источник входной информации.

Математическое описание. Математическая модель, экономико-математическое описание процесса (или объекта). Перечень принятых допущений и оценки соответствия принятой модели реальному процессу в различных режимах и условиях работы (например, стационарный режим). В расчетных соотношениях (формулах) должны быть использованы обозначения приведенные в предыдущих разделах.

Описание алгоритма. Логика алгоритма и способы формирования результатов решения с указанием последовательности этапов. Указания о точности вычисления (при необходимости). Соотношения, необходимые для контроля достоверности вычислений. Алгоритмом должны быть предусмотрены все ситуации, которые могут возникнуть в процессе решения задачи.

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

Спецификации процессов. Описание логики процессов является конечной вершиной иерархии DFD [1,2]. Она должна формулировать основные функции процесса таким образом, чтобы в дальнейшем специалист, выполняющий реализацию проекта, смог выполнить их или разработать соответствующую программу.

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