Файл: Пример Руководство Программиста.doc

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

СОДЕРЖАНИЕ

стр.

1 Назначение и условия применения программы 4

1.1 Назначение программы 4

1.2 Функции программы 4

Функция открытия и чтения файла “LoadFile” вызывается путем нажатия Файл->Открыть и загрузка данных из файла при выборе файла в диалоговом окне. 4

1.4 Требования к программному обеспечению 4

2 Характеристики программы 4

2.1 Средства проверки правильности выполнения программы 4

2.2 Функционирование программы после сбоев 4

3 Обращение к программе 4

3.1 Способы вызова программы с различных носителей данных 4

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

3.3 Способы передачи управления и параметров данных 4

3.4 Обращение к программе – приложению 5

4 Входные и выходные данные 5

4.1 Формат, характер и организация входных данных 5

4.2 Формат, характер и организация выходных данных 5

5 Сообщения 5

5.1 Сообщения программисту и действия по ним 5

6 Дополнительные материалы 5

6.1 Примеры 5

Производится открытие файлов путем нажатия Файл->Открыть и загрузка данных из файла при выборе файла в диалоговом окне. 5

6.2 Иллюстрации 6

Окно ввода (отображения) Ключ Окно вывода (отображения) 6

Главное меню Строка состояния процесса 6

1 Назначение и условия применения программы

1.1 Назначение программы

Описываемая программа предназначена для шифрования и дешифрования данных, хранящихся в файлах.

1.2 Функции программы

Функция открытия и чтения файла “LoadFile” вызывается путем нажатия Файл->Открыть и загрузка данных из файла при выборе файла в диалоговом окне.
При нажатии Шифрование->Зашифровать программа вызывает процедуру “Coding”, которая зашифровывает данные и выводит результат в окно для ввода текста.
При выборе в меню Шифрование->Расшифровать – программа вызывает процедуру “Recoding”, которая расшифровывает данные с выводом в результата в текстовое окно.
Запись данных в файл происходит путем нажатия Файл->Сохранить - вызове функции “SaveFile”и выборе в диалоговом окне документа для записи данных.

1.3 Использование оперативной памяти

Количество необходимой оперативной памяти определяется размером обрабатываемых данных, плюс к этому 1 МБ для загрузки самой программы и создания всех необходимых переменных и структур.

1.4 Требования к программному обеспечению

Операционная система Windows95 и выше.

2 Характеристики программы

2.1 Средства проверки правильности выполнения программы

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

2.2 Функционирование программы после сбоев

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

3 Обращение к программе

3.1 Способы вызова программы с различных носителей данных

Программа может вызываться с любых носителей.

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

Исполняемым файлом программы является файл "CodingGost.exe".

3.3 Способы передачи управления и параметров данных

Передача параметров производится в режиме диалога программы с пользователем.

3.4 Обращение к программе – приложению

С помощью программ файл - менеджеров зайти в каталог, в который установлена программа и запустить файл "CodingGost.exe".

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

4.1 Формат, характер и организация входных данных

Загрузка данных в виде текста или файла любого формата для (рас)зашифровывания.

4.2 Формат, характер и организация выходных данных

Cохранение (рас)зашифрованных данных в файл любого формата, либо простым отражением в текстовом поле.

5 Сообщения

5.1 Сообщения программисту и действия по ним

№ п/п	Сообщение	Описание	Действия
1	2	3	4
1.	“Отсутствуют данные для обработки!”	Системное окно сообщения с информацией, о том, что файл не открыт.	Загрузить файл.
2.	“Не задан ключ!”	Системное окно сообщения с информацией, о том, что ключ не задан.	Ввести ключ для шифрования в соответствующее поле.