Документация базы данных "Список владельцев гаражного кооператива"
Смоленский промышленно - экономический колледж
Кафедра Математики и Информатики
Специальность: Программное обеспечение вычислительной техники и автоматизированных систем
КУРСОВОЙ ПРОЕКТ
По дисциплине: “Технология разработки программных продуктов”
на тему: Документация базы данных “Список владельцев гаражного кооператива”
Выполнил:
Принял:
Курсовой проект “ Список владельцев гаражного кооператива ”включает программу, разработанную на языке программирования Visual Basic версии 5.0.; программную документацию, эксплутационную документацию, требования к надежности. Программа, разработанная в данном курсовом проекте, представляет собой базу данных – “Гаражный кооператив” и включает сведения о владельце автомобиля, марке автомобиля, его госномере. В некоторых разделах пояснительной записки приводится комплекс документов в соответствии с ГОСТ.
Содержание
Введение
Программная документация
1.1 Техническое задание
1.1.1 Назначение разработки
1.1.2 Основание для разработки
1.1.3 Требования к программе и программному изделию
1.1.3.1 Требования к функциональным характеристикам
1.1.3.2 Требования к надежности
1.1.3.3 Условия эксплуатации
1.1.4 Требования к программной документации
1.1.5 Стадии и этапы разработки
1.2 Спецификация
1.3 Описание программы
1.3.1 Общие сведения
1.3.2 Функциональное назначение
1.3.3. Описание логической структуры
1.3.4 Используемые технические средства
1.3.5 Входные и выходные данные
1.3.6 Вызов и загрузка
1.4 Программа и методика испытаний
1.4.1 Объект испытаний
1.4.2 Цель испытаний
1.4.3 Требования к программе
1.4.4 Средство и порядок испытаний
1.4.5 Методы испытаний
1.5 Текст программы
Эксплуатационная документация
2.1 Ведомость эксплуатационных документов
2.2 Описание применения
2.2.1 Назначение программы
2.2.2 Условия применения
2.2.3 Описание задачи
2.2.4 Входные и выходные данные
2.3 Руководство оператора
2.3.1 Назначение программы
2.3.2 Условия выполнения программы
2.3.3 Минимальный состав аппаратных средств
2.3.4 Выполнение программы и сообщения оператору
Заключение
Литература
Приложение
Введение
Целью курсовой работы является закрепление и углубление теоретических знаний по дисциплине “Технология разработки программных продуктов” и приобретение практических навыков при разработке базы данных на языке программирования Visual Basic 5.0.
Основными задачами курсового проекта являются:
анализ возможных подходов и методов решения
разработка модели, необходимой для достижения поставленной цели
выбор наиболее эффективных алгоритмов
разработка программного обеспечения
анализ полученных результатов работы программного обеспечения
Данный курсовой проект представляет собой оттестированный программный продукт – база данных “Список владельцев гаражного кооператива”, программная и эксплуатационная документация для данного программного продукта.
1. Программная документация
1.1 Техническое задание (ГОСТ 19.201-78)
Программный документ – это документ, содержащий необходимые сведения, необходимые для разработки, изготовления, эксплуатации и сопровождения программного продукта.
Техническое задание включает назначение, области применения программы; технические, технико-экономические и специальные требования, предъявляемые к программе; необходимые стадии и сроки разработки; виды испытаний.
1.1.1 Назначение разработки
База данных, представленная в данной курсовой работе является списком владельцев гаражного кооператива и носит соответствующее название. Применяя данную программу, пользователь может узнать сведения о владельце гаражного кооператива, добавлять и удалять записи, производить поиск владельца по фамилии. Исходя из этого, к программе предъявляются соответствующие требования, технико-экономические показатели, стадии и этапы разработки.
1.1.2 Основание для разработки
Основанием для разработки данного курсового проекта является Приказ №3 по Смоленскому промышленно-экономическому колледжу от 1 октября 2009 года “О допуске к выполнению курсовой работы”.
1.1.3 Требования к программе и программному изделию
1.1.3.1 Требования к функциональным характеристикам
Программа должна корректно вызывать форму, которая соответствует функции расположенных на форме кнопок, выполнять все действия, возможные в данной программе.
Входные данные программы – это база данных, содержащая основные сведения о владельцах гаражного кооператива; пароль, вводимый пользователем для начала работы с программой; данные, вводимые для поиска, данные о новых владельцах.
Выходные данные программы – это информация, получаемая при работе с базами данных, результаты поиска по полю “Фамилия”, сообщения для пользователя.
1.1.3.2 Требования к надежности
При соблюдении условий эксплуатации в течение определенного периода времени программа безотказно выполняет свои функции. Контроль за входными и выходными данными, соблюдение условий эксплуатации программы - основное требование к обеспечению надежного функционирования программы.
Надежность является одним из важнейших факторов, определяющих общую производительность и эффективность систем.
Надежность программного продукта определяется, как свойство системы выполнить заданную функцию, сохраняя во времени значения установленных эксплуатационных показателей в заданных пределах, соответствующих заданным режимам и условиям использования, технического обслуживания, ремонта, хранения, транспортирования.
Свойство надежности проявляется в том, что система выполняет установленные перед ней задачи без проблем.
Если произойдет отказ, следует перезапустить программу, если же это не поможет, то обратиться к специалисту (инженеру, разработчику программного продукта).
1.1.3.3 Условия эксплуатации
С данным программным продуктом работает сотрудник, который должен обладать соответствующей квалификацией, т.е. иметь навыки работы на ПК, а работу с данным программным продуктом освоить очень легко, благодаря дружественному интерфейсу. Программа устанавливается на ПК и записывается на жестком диске (создается ярлык на рабочем столе), поэтому ни температура воздуха, ни относительная влажность, ни какие-либо другие погодные условия не могут помешать работе программы, кроме неполадок самого компьютера. Но так как она устанавливается с гибкого диска, то этот диск должен храниться в футляре при комнатной температуре в сухом месте.
1.1.4 Требования к программной документации
Программная документация включает:
Техническое задание (ГОСТ 19.201-78) – содержит требования, предъявляемые к программе и программному изделию, необходимые стадии и сроки разработки, виды испытаний;
Описание программы (ГОСТ 19.402-78) – содержатся сведения о логической структуре и функционировании ПО;
Тексты программ (ГОСТ 19.401-78) - записи программ с необходимыми комментариями;
Спецификация (ГОСТ 19.202-78) – указывается состав программы, документации на нее.
Программа и методика испытаний (ГОСТ 19.301-79) – требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля.
1.1.5 Стадии и этапы разработки
Стадии и этапы разработки программ и программной документации для вычислительных машин, комплексов и систем независимо от их назначения и области применения устанавливается по стандарту ГОСТ 19.102-17 ( дополнения к этому стандарту были внесены в 1987 и 1995 гг.)
Стадии и этапы разработки:
Техническое задание
Обоснование необходимости разработки программы.
Постановка задачи.
Сбор исходных материалов.
Обоснование необходимости проведения научно исследовательских работ.
Научно исследовательские работы
Определение структуры входных и выходных данных.
Предварительный выбор методов решения задач.
Определение требований к техническим средствам.
Обоснование принципиальной возможности решения поставленной задачи.
Разработка и утверждение технического задания.
Определение требований к программе.
Определение стадий, этапов, сроков разработки программы и документации для неё.
Выбор языков программирования.
Эскизный проект. Разработка эскизного проекта.
Предварительная разработка структуры входных и выходных данных
Уточнение методов решения задачи
Разработка общего описания алгоритма решения
3. Технический проект
Разработка технического проекта
Уточнение структуры входных и выходных данных
Разработка алгоритма решения задачи
Определение формы представления входных и выходных данных
Разработка структуры программы
Рабочий проект
4.1. Разработка программы
Программирование и отладка программы
4.2. Разработка программной документации
Разработка программных документов в соответствии с требованиями
4.3. Испытание программы
1.2 Спецификация (ГОСТ 19.202-78)
Обозначение |
Наименование |
Примечание |
А.В.00001-01 |
Компоненты - Список владельцев гаражного кооператива |
|
А.В.00001-01_12_01-1 |
Документация - Текст программы |
|
А.В.00001-01_13_01-1 |
Описание программы |
|
А.В.00001-01_20_01-1 |
Ведомость эксплуатационных документов |
|
А.В.00001-01_31_01-1 |
Описание применения |
|
А.В.00001-01_34_01-1 |
Руководство оператора |
|
А.В.00001-01_51_01-1 |
Программа и методика испытаний |
1.3 Описание программы (ГОСТ 19.401-78)
В документ включаются сведения о логической структуре и функционировании программы.
1.3.1 Общие сведения
В рамках курсового проекта мною была разработана программа “Список владельцев гаражного кооператива” (А.В.00001-01). Программа была написана на языке объектно-ориентированного программирования Visual Basic 5.0. Для работы программы необходимо иметь ПК, работающий под управлением операционной системы Windows 98, с установленным на нём программным пакетом Visual Basic 5.0.
1.3.2 Функциональное назначение
Программа предназначена для работы с базой данных, созданными в ACCESS. Связь осуществляется с помощью элемента DATE и его свойств. В базу данных можно добавлять и удалять записи, просматривать их, производить поиск.
1.3.3 Описание логической структуры
База данных «Список владельцев гаражного кооператива» состоит из трех форм. Основная таблица создана с помощью Access. на первой форме расположены элементы: Data (для связи с таблицами Access с помощью свойств DatabaseName и DataSource), Теxt (текстовые поля для отображения записей таблицы), Label (надписи для текстовых полей), Command (командные кнопки).
Командная кнопка «Добавить» - добавление записи. Программный код для данной функции:
Private sub> Command2_Click()
d = MsgBox("Добавить запись?", 1, " Сообщение")
If d = 1 Then
Data1.Recordset.AddNew
Else
Exit sub>
End If
End sub>
Командная кнопка «Удалить» - удаление записи. Программный код для данной функции:
Private sub> Command3_Click(){Процедура для кнопки «Удалить»]
b = MsgBox("Вы действительно хотите удалить запись?", 1, " Сообщение")
If b = 1 Then
Data1.Recordset.Delete
Data1.Recordset.MoveNext
Else
Exit sub>
End If
Кнопка «Таблица» - переход на форму 2.
Кнопка «Выход» - выход из программы.
На форме 2 расположены следующие элементы: DBGrid (для отображения данных в виде таблицы ), Data, Command.
Кнопка «Выход» - выход из программы.
Кнопка «Записи по одному» - переход на форму 1.
Кнопка «Поиск» - поиск записей по полю «Фамилия» имеет следующую процедуру:
Private sub> Command1_Click() {Процедура для кнопки «Поиск»}
Dim s As String
Dim i As Integer
s = InputBox("Введите фамилию ?", "Поиск")
Data1.Recordset.MoveFirst
If s = "" Then
MsgBox ("Вы нажали Отмену или ничего не ввели")
Exit sub>
End If
Где InputBox – функция ввода.
Третья форма используется для ввода пароля. Если пароль введен неправильно, появляется сообщение: “Неправильный пароль” и кн. ОК, по нажатию которой сообщений закрывается, пользователю предоставляется еще две возможности ввода пароля. После трехразового ввода неправильного пароля происходит выход из программы автоматически. При правильном вводе пароля появляется сообщение: “Правильный пароль” и кн. ОК, по нажатию форма пароля исчезает и появляется форма “Гаражный кооператив”. Программный код для кнопки «ОК»:
Private sub> Command1_Click()
If Text1.Text = "111" Then
MsgBox "Пароль правильный"
Unload Form3
Form1.Show
Else:
MsgBox "Пароль неправильный"
Text1.Text = ""
k = k + 1
If k = 3 Then End
End If
Endsub>.
1.3.4 Используемые технические средства
Минимальный перечень технических средств, обеспечивающих работу программы:
ПК на базе процессора Intel – 486 BX 4-100;
FDD 3,5 “1,44 Mb” (для установления программы);
1 Mb на HDD;
цветной монитор SVGA;
клавиатура;
манипулятор типа “мышь”.
1.3.5 Входные и выходные данные
Входные данные программы – это база данных, содержащая основные сведения о владельцах гаражного кооператива; пароль, вводимый пользователем для начала работы с программой; данные, вводимые для поиска, данные о новых владельцах. Выходные данные программы – это информация, получаемая при работе с базами данных, результаты поиска по полю “Фамилия”, сообщения для пользователя.
1.3.6 Вызов и загрузка
Вызов и загрузка программы осуществляется с помощью запускающего файла, ярлык для которого может располагаться на рабочем столе. Эта процедура занимает мало времени и равна нескольким секундам, конечно в соответствии с указанными для программы техническими средствами.
1.4 Программа и методика испытаний (ГОСТ 19.301-79)
1.4.1 Объект испытаний
Объектом испытаний является программа “Список владельцев гаражного кооператива” (А.В.00001-01). Программа будет полезна владельцам гаражного кооператива.
1.4.2 Цель испытания
Данные испытания проводятся для установления соответствия программы заданным требованиям и программным документам.
1.4.3 Требования к программе
Программа должна:
корректно осуществлять поиск по полю “Фамилия”
Выбранные командные кнопки должны выполнять соответствующие им команды.
1.4.4 Средство и порядок испытаний
Для испытания программы необходимо иметь ПК, работающий под управлением операционной системы Windows 98, с установленным на нём программным пакетом Visual Basic 5.0. или библиотекой программ.
1.4.5 Методы испытаний
Тест №1 (допустимые значения)
Ожидаемые входные данные: нажимаем кнопку «Поиск», в текстовое поле вводим фамилию и нажимаем кн. ОК. Указатель перемещается на соответствующую запись.
По нажатию кнопки “Поиск” появляется функция ввода с текстовым полем, куда вводится фамилия интересующего владельца, и кн. ОК и Отмена. В текстовое поле вводим модель Галимеев и нажимаем кн. ОК. Указатель перемещается на запись, у которой в поле “Фамилия” записано Галимеев.
Программа выполнила тест верно.
Тест №2 (недопустимые значения)
Ожидаемые входные данные: нажимаем кнопку «Поиск», в текстовое поле вводим фамилию и нажимаем кн. ОК. Нам выдается сообщение «Данной записи нет».
По нажатию кнопки “Поиск” появляется функция ввода с текстовым полем, куда вводится фамилия интересующего владельца, и кн. ОК и Отмена. В текстовое поле вводим фамилию Иванов и нажимаем кн. ОК. появляется сообщение: “Данной записи нет”.
Программа выполнила испытание верно, так как данного владельца в базе данных не существует.
Тест №3 (ограниченные значения)
Ожидаемые входные данные: нажимаем кнопку «Поиск», в текстовое поле вводим фамилию, стоящую в таблице первой, и нажимаем кн. ОК. Указатель перемещается первую запись.
По нажатию кнопки “Поиск” появляется функция ввода с текстовым полем, куда вводится фамилия, стоящая в таблице первым, и кн. ОК и Отмена. В текстовое поле вводим фамилию Сидоренков и нажимаем кн. ОК. Указатель перемещается первую запись на запись, у которой в поле “Фамилия” записано Сидоренков.
Программа выполнила тест верно.
1.5 Текст программы (ГОСТ 19.401 - 78)
Форма 1
Option Explicit {Объявление переменных}
Dim d As Integer
Dim b As Integer
Private sub> Command1_Click(){Процедура для кнопки «Выход»}
End
End sub>
Private sub> Command2_Click(){Процедура для кнопки «Добавить»]
d = MsgBox("Добавить запись?", 1, " Сообщение")
If d = 1 Then
Data1.Recordset.AddNew
Else
Exit sub>
End If
End sub>
Private sub> Command3_Click(){Процедура для кнопки «Удалить»]
b = MsgBox("Вы действительно хотите удалить запись?", 1, " Сообщение")
If b = 1 Then
Data1.Recordset.Delete
Data1.Recordset.MoveNext
Else
Exit sub>
End If
End sub>
Private sub> Command4_Click() {Переход на вторую форму}
Form2.Show
Form1.Hide
End Su
Private sub> Data1_Reposition() {Процедура для подсчета записей}
Data1.Caption = Data1.Recordset.AbsolutePosition
Data1.Caption = "Запись " & (Data1.Recordset.AbsolutePosition + 1) & " из " & Data1.Recordset.RecordCount
End sub>
Private sub> Form_Load() {Загрузка формы}
Data1.Refresh
Data1.Recordset.MoveLast
Data1.Recordset.MoveFirst
End sub>
Форма 2
Private sub> Command1_Click() {Процедура для кнопки «Поиск»}
Dim s As String
Dim i As Integer
s = InputBox("Телефон какой модели вы хотите найти ?", "Поиск")
Data1.Recordset.MoveFirst
If s = "" Then
MsgBox ("Вы нажали Отмену или ничего не ввели")
Exit sub>
End If
For i = 1 To Data1.Recordset.RecordCount
If Data1.Recordset.Fields(0) = s Then
Exit sub>
Else: Data1.Recordset.MoveNext
End If
Next i
MsgBox ("Данной записи нет")
Data1.Recordset.MoveFirst
End sub>
Private sub> Command3_Click() {Процедура для кнопки по одному»}
Form1.Show
Form2.Hide
End sub>
Private sub> Command4_Click(){Процедура для кнопки «Выход»}
End
End sub>
Private sub> Data1_Reposition(){Процедура для подсчета записей}
Data1.Caption = Data1.Recordset.AbsolutePosition
Data1.Caption = "Запись " & (Data1.Recordset.AbsolutePosition + 1) & " из " & Data1.Recordset.RecordCount
End sub>
Private sub> Form_Load() {Загрузка формы}
Data1.Refresh
Data1.Recordset.MoveLast
Data1.Recordset.MoveFirst
End sub>
Форма 3
Option Explicit {Объявление переменных}
Dim k As Integer
Private sub> Command1_Click(){процедура для кнопки «ОК» на форме пароля}
If Text1.Text = "Привет" Then
MsgBox "Пароль правильный"
Unload Form3
Form1.Show
Else:
MsgBox "Пароль неправильный"
Text1.Text = ""
k = k + 1
If k = 3 Then End
End If
End sub>
2. Эксплуатационная документация
2.1 Ведомость эксплуатационных документов (ГОСТ 19.507-79)
Эксплуатационный программный документ – это такой программный документ, который содержит сведения необходимые для обеспечения функционирования и эксплуатации программного продукта. Ведомость эксплуатационный документ включает перечень эксплуатационных документов на программу.
ДОКУМЕНТЫ НА ПРОГРАММУ
-
Обозначение
Наименование
Кол.экз.
Местонахождение
А.В.00001-01_31_01-1
Описание применения
1
Папка №1
А.В.00001-01_51_01-1
Руководство оператора
1
Папка №1
2.2 Описание применения (ГОСТ 19.502-78)
В данном эксплуатационном документе содержатся сведения о назначении, области применения программного обеспечения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств.
2.2.1 Назначение программы
Программа предназначена для работы с базой данных, созданными в ACCESS. Связь осуществляется с помощью элемента DATE и его свойств. В базу данных можно добавлять и удалять записи, просматривать их, производить поиск.
2.2.2Условия применения
Для работы программы необходимо иметь ПК, работающий под управлением операционной системы Windows 98, с установленным на нём программным пакетом Visual Basic 5.0. Программа проста в обращении, с ней может работать не только специалист в области программирования, но и простой пользователь.
Входные данные программы – это база данных, содержащая основные сведения о владельцах гаражного кооператива; пароль, вводимый пользователем для начала работы с программой; данные, вводимые для поиска, данные о новых владельцах.
Выходные данные программы – это информация, получаемая при работе с базами данных, результаты поиска по полю “Фамилия”, сообщения для пользователя.
Минимальный перечень технических средств, обеспечивающих работу программы:
ПК на базе процессора Intel – 486 BX 4-100;
FDD 3,5 “1,44 Mb” (для установления программы);
1 Mb на HDD;
цветной монитор SVGA;
клавиатура;
манипулятор типа “мышь”.
2.2.3Описание задачи
Программа должна обеспечивать:
просмотр, добавление и удаление записей
хранение данных
правильно производить поиск по полю “Фамилия”
выполнять действия, соответствующие выбранным пользователем командным кнопкам.
Все эти требования выполняются с помощью соответствующих программных кодов.
2.2.4.Входные и выходные данные
Входные данные программы – это база данных, содержащая основные сведения о владельцах гаражного кооператива; пароль, вводимый пользователем для начала работы с программой; данные, вводимые для поиска, данные о новых владельцах.
Выходные данные программы – это информация, получаемая при работе с базами данных, результаты поиска по полю “Фамилия”, сообщения для пользователя.
2.3 Руководство оператора (ГОСТ 19.505-79)
В данный документ вносят сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы.
2.3.1 Назначение программы
База данных “Список владельцев гаражного кооператива” позволяет просматривать данные, добавлять и удалять записи, осуществлять поиск по полю “Фамилия”.
2.3.2 Условия выполнения программы
С программой должен работать один пользователь ПК. Программа проста в обращении благодаря дружественному интерфейсу. На компьютере должна быть установлена операционная система Windows’95/98/2000 и Visual Basic 5.0. и библиотеки программ.
2.3.3 Минимальный состав аппаратных средств
Минимальный перечень технических средств, обеспечивающих работу программы:
ПК на базе процессора Intel – 486 BX 4-100;
FDD 3,5 “1,44 Mb” (для установления программы);
1 Mb на HDD;
цветной монитор SVGA;
клавиатура;
манипулятор типа “мышь”.
2.3.4 Выполнение программы и сообщения оператору
При запуске программы появляется форма с текстовым полем, для ввода пароля, и кнопкой ОК. Пароль для данной программы – слово “111”. Если пароль введен неправильно, появляется сообщение: “Неправильный пароль” и кн. ОК, по нажатию которой сообщений закрывается, пользователю предоставляется еще две возможности ввода пароля. После трехразового ввода неправильного пароля происходит выход из программы автоматически. При правильном вводе пароля появляется сообщение: “Правильный пароль” и кн. ОК, по нажатию форма пароля исчезает и появляется форма “Гаражный кооператив”.
Командная кнопка «Выход» - выход из программы.
Командная кнопка «Таблица» - переход на форму, где данные представлены в виде таблицы.
Переход к следующей, предыдущей, первой и последней записям осуществляется с помощью элемента Data в нижней части формы нажатием соответствующих кнопок.
Командные кнопка «Добавить» - добавление новой записи в базу данных. При выборе этой кнопки появляется сообщение: “Вы действительно хотите добавить запись?” и кн. ОК и Отмена, по нажатию которых таблица переходит в режим добавления и происходит выход из процедуры соответственно.
Командная кнопка «Удалить» - удаление записи. При выборе этой кнопки появляется сообщение: “Вы действительно хотите удалить запись?” и кн. ОК и Отмена, по нажатию которых происходит удаление выделенной записи и выход из процедуры соответственно.
На форме 2, представляющей данные в виде таблицы, навигация по набору данных осуществляется с помощью элемента Data и полос прокруток.
Командная кнопка “Выход” – выход из программы.
Командная кнопка “Записи по одному” - переход на форму “Гаражный кооператив”.
Командная кнопка “Поиск” - осуществляет поиск по полю “Фамилия”. По нажатию этой кнопки появляется функция ввода с текстовым полем, куда вводится фамилия, и кн. ОК и Отмена. При нажатии кн. ОК происходит поиск по полю «Фамилия». Если данная запись существует, то указатель перемещается на эту запись. В противном случае появляется сообщение: “Данной записи нет” и происходит выход из процедуры. Если при поиске вы ничего не ввели в текстовое поле и нажали любую из кнопок, появляется сообщение: “Вы ничего не ввели или нажали отмену” и кн. ОК, по нажатию которой происходит выход из процедуры.
Заключение
В ходе курсового проекта было разработано программное обеспечение, программная и эксплуатационная документация для него.
Проведено тестирование данного программного продукта. Были приобретены навыки по составлению и оформлению программной и эксплуатационной документации. Данная программа будет полезна владельцам гаражного кооператива. Полученные знания и умения помогут мне в дальнейшем при разработке дипломного проекта.
Список литературы
Шишкин В.В. – «Методические указания к курсовому проекту по дисциплине «Технология разработки программного продукта»
ГОСТ 7.1-84. Библиографическое описание документа. Общие требования и правили составления.
ГОСТ 7.9-95. Реферат и аннотация. Общие требования
Клеванский Н.Н., Алексеева Е.Ю. – “Курсовое проектирование”
Эхо Ю.В. – “Практической руководство для тех, кто пишет курсовые работы”
Стандарты Единой системы программной документации (