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

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

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

5.         Порядок проведения испытаний.

1)         Создание базы данных о поездах дальнего следования.

2)         Просмотр полученной информации.

3)         Осуществить поиск в базе данных по номеру поезда.

4)         Осуществить поиск в базе данных по названию станции назначения.

Текст программы

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

1.         Функция TREE *der (TREE *kr, SISTEMA word) – предназначена для формирования дерева. Если дерево пустое, записываем информацию в вершину. Выделяется память под новый элемент, сравнивается поступившая информация с информацией в узле. Если элементы одинаковы, включается счётчик.

2.         Функция void Crt_Der() – предназначена для записи в дерево информации и вывод дерева на экран.

3.         Функция void print_der (TREE *kr) – предназначена для печати дерева.

4.         Функция int Poisk_nom_p (TREE *d, int v) – предназначена для поиска по номеру поезда.

5.         Функция int Poisk_st (TREE *d, char s[20]) – предназначена для поиска по названию станции.

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

1.         Общие сведения.

Программа называется «Расписание ж/д 2007». Язык программирования, на котором написана программа – С++.

2.         Функциональное назначение.

Классы решаемых задач:

1)      Создание базы данных о поездах дальнего следования.

2)      Чтение базы данных.

3)      Поиск по номеру поезда.

4)      Поиск по названию станции назначения.

3.         Описание логической структуры.

             Функция void Crt_Der() – предназначена для записи в дерево информации и вывод дерева на экран.

3.2. Функция void print_der (TREE *kr) – предназначена для печати дерева.

             Функция int Poisk_nom_p (TREE *d, int v) – предназначена для поиска по номеру поезда.

3.4. Функция int Poisk_st (TREE *d, char s[20]) – предназначена для поиска по названию станции.

4.         Входные данные.

Должны быть введены такие данные как: номер поезда, станция назначения, время отправления:

Введите номер поезда: (-1 – выход) 2

Введите название станции: Moskva

Введите время отправления: 13.05

5.         Выходные данные.

Должны соответствовать входным данным:

Номер поезда 2

Станция назначения Moskva

Время отправления 13.05

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

1.         Назначение и область применения.

Применяется этот продукт может на ж/д вокзалах как оператором, так и простыми пользователями. Его название «Расписание ж/д 2007» говорит о назначении, т.е. о новой, улучшенной и простой работе для персонала.

2.         Технические характеристики.

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

В нашем случае мы используем для написания программы двоичное дерево поиска. Это самый подходящий метод. Бинарные деревья чаще всего применяются для представления множества данных, элементы которых ищутся по уникальному, только ему присущему ключу. В этом весь смысл.

Описание алгоритма и программы.

Программа начинает работать со специального меню, в котором описаны следующие пункты:

5)         Создание базы данных о поездах дальнего следования.

6)         Просмотр полученной информации.

7)         Осуществить поиск в базе данных по номеру поезда.

Осуществить поиск в базе данных по названию станции назначения.

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

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

Второй пункт предназначен для просмотра общей информации;

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

Четвертый пункт также предназначен для пользователя. В строке «Введите станцию назначения» вводится искомая станция назначения и после нажатия Enter программа осуществляет поиск по названию станции. В результате выдаются сведения о номере поезда и времени отправления. Если до станции назначения идут поезда и в разное время, то на экран выводятся все данные о поездах идущих до этой станции.

Пятый пункт предназначен для возврата к самой программе.

Выбор алгоритма произведен на основании метода «Двоичное дерево».

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

Преимущество выбранного варианта технического решения: удобная и облегченная работа для персонала.

4.         Источники, используемые при разработке.

Хусаинов Б.С. «Структуры и алгоритмы обработки данных. Примеры на языке Си: Учеб. пособие. – Финансы и статика, 2004. – 464 с.: ил.».

3. Эксплуатационная документация

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

При эксплуатации программа ведёт себя таким образом: