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

Содержание введение 1.1. Наименование программного изделия 1.2. Область применения 1.3. Наименования разработчика и заказчика 2. ОСНОВАНИЕ ДЛЯ РАЗРАБОТКИ
2.1. Документ, на основании которого ведётся разработка 2.2. Организация, утвердившая этот документ, и дата его утверждения 2.3. Наименование темы разработки 3. НАЗНАЧЕНИЕ РАЗРАБОТКИ 3.1. Критерии эффективности и качества программы 3.2. Цели разработки программы 4. ТрЕБОВАНИЯ К ПРОГРАММЕ 4.1. Требования к функциональным характеристикам 4.1.1. Состав выполняемых функций 4.1.2. Организация входных и выходных данных 4.1.3. Временные характеристики, и размер занимаемой памяти 4.2. Требования к надежности 4.2.1. Требования к надежному функционированию 4.2.2. Контроль входной и выходной информации 4.2.3. Время восстановления после отказа 4.3. Условия эксплуатации 4.4. Требования к составу и параметрам технических средств 4.5. Требования к информационной и программной совместимости 4.5.1. Требования к информационным структурам на входе и выходе 4.5.2. Требования к методам решения 4.5.3. Требования к языкам программирования 4.5.4. Требования к программным средствам, используемым программой 4.6. Требования к маркировке и упаковке 4.7. Требования к транспортированию и хранению 5. ТРЕБОВЛНИЯ К ПРОГРАММНОЙ ДОКУМЕНТАЦИИ 6. ТЕХНИКО-ЭКОНОМИЧЕСКИЕ ПОКАЗАТЕЛИ 7. СТАДИИ И ЭТАПЫ РАЗРАБОТКИ 8. ПОРЯДОК КОНТРОЛЯ И ПРИЕМКИ 8.1. Виды испытаний 8.2.Общие требования к приёмке Приложение 1 Приложение 2 Приложение 3 1. ВВЕДЕНИЕ 1.1. Наименование программного изделия Полное наименование програмной разработки: "Программа складского учета "Хранитель"", в дальнейшем именуемая как "программа". Краткое название программы – "Хранитель". 1.2. Область применения Программа "Хранитель" предназначена для учета продаж, закупок и наличия товара на складах, а также получения статистики по проделанным операциям и вывода ее на принтер. 1.3. Наименования разработчика и заказчика Разработчик данного программного продукта - студент группы ИВТ-262 ВолГТУ Кудряшов П.П., в дальнейшем именуемый как "разработчик ". Заказчик программного продукта - кафедра САПР и ПК ВолГТУ, в лице преподавателя Садовниковой Н.П.
2. ОСНОВАНИЕ ДЛЯ РАЗРАБОТКИ 2.1. Документ, на основании которого ведётся разработка Работа ведётся на основании задания на курсовое проектирование по дисциплине «Технология программирования» 2.2. Организация, утвердившая этот документ, и дата его утверждения Задание утверждено на заседании кафедры САПР и ПК и выдано преподавателем кафедры Садовниковой Н.П. 2.3. Наименование темы разработки Наименование темы разработки – "Хранитель"
3. НАЗНАЧЕНИЕ РАЗРАБОТКИ Данная разработка является семестровой работой по дисциплине «Технология программирования» 3.1. Критерии эффективности и качества программы 1) Социальный фактор. Данная программная разработка очень проста в освоении и рассчитана не только на профессионалов, но и на рядовых пользователей, работающих под Windows. Удобный интуитивно понятный интерфейс в сочетании с мощной системой вспомогательных рисунков и всплывающих подсказок позволяют работать с программой без предварительной подготовки. 2) Соответствие текущему состоянию на рынке ПО данного профиля. В отличие от дорогих и сложных программ складского учета типа "1С-Склад" и ей подобных, программа "Хранитель" идеально подходит для представителей малого и среднего бизнеса, так как содержит все, что им необходимо, но не перегружена бесполезными и ненужными возможностями. Технология создания программы в визуальных средах программирования делает ее интерфейс универсальным и совместимым с операционными системами Windows 95/98/2000. 3) Экономические факторы. Программа представляет наилучшее соотношение цены и предоставляемых ей возможностей и несомненно займет свою нишу на рынке дешевых программ складского учета. Основными пользователями станут представители малого и среднего бизнеса, которые просто не могут заплатить за дорогие программы фирмы 1С и ей подобных. 3.2. Цели разработки программы Создание данной программы преследует ряд технико-экономических целей: 1) Создание программного продукта, необходимого для учета товаров на складах представителей малого и среднего бизнеса. 2) Создание дешевой альтернативы существующим в настоящее время дорогим программам складского учета типа 1С-Склад и им подобным. 3) Создание интуитивно понятной программы с удобным и универсальным Windows-интерфейсом для простого, но мощного и эффективного контроля за товарами.
4. ТРЕБОВАНИЯ К ПРОГРАММЕ 4.1. Требования к функциональным характеристикам 4.1.1. Состав выполняемых функций 1) Программа должна работать с произвольным количеством складов, иметь возможность вести статистику продаж (включает в себя стоимость проданного товара, а также последовательность операций, производимых с товаром) на складе и статистику продаж каждого из товаров в отдельности. 2) Программа должна иметь возможность автозаполнения некоторых полей (поля продавца и покупателя товара) для ускорения работы. 3) Программа должна предоставить возможность отслеживать перемещения товаров между складами. 4) Программа должна искать товар на складе или операцию, произведенную с ним по совокупности заданных пользователем полей. 5) Программа должна иметь возможность заменять названия товаров и валют на выбранном складе или складах по запросу пользователя. 6) Программа должна иметь возможность списания остатка товара с указанием лица, отдавшего такое распоряжение и суммы списания товара. 7) Программа должна иметь возможность выделения и копирования текстовых данных различных полей карточки товара в стандартный системный буфер обмена Windows с целью последующей вставки в любой документ, допускающий подобную операцию (например, документ Microsoft Word или Microsoft Excel). 8) Программа должна иметь возможность сортировки карточек товаров. 9) Программа должна иметь возможность использовать фильтр (специальная опция, позволяющая отображать не все карточки товаров, входящие в склад, а только те, которые удовлетворяют настройкам фильтра, например – отображать только товары стоимостью более 100 руб/ед), настраиваемый пользователем для отображения товаров и операций, удовлетворяющих параметрам фильтра. 10) Программа должна иметь возможность создания резервной копии в автоматическом режиме (раз в неделю) и по желанию пользователя (в любой момент времени, когда программа запущена). 11) Программа должна иметь возможность настройки пользовательского интерфейса (шрифтов и цветов), а также параметров работы (учет и процентная ставка НДС)
12) Внешний вид программы должен соответствовать макетам экранов, предоставленных в ПРИЛОЖЕНИИ 1. 13) Список управляющих и быстрых клавиш программы должен соответствовать ПРИЛОЖЕНИЮ 2. 14) Программа должна обеспечивать изменение уже имеющихся на диске баз данных, предварительно созданных данной программой, а также создание и сохранение новых.
15) Программа должна обеспечивать вывод на принтер базы данных товаров на складе с возможностью использования фильтра. 4.1.2. Организация входных и выходных данных Организация входных и выходных файлов должна соответствовать ПРИЛОЖЕНИЮ 3. В процессе работы программы входной информацией для программы должны являться: файлы баз данных, манипуляции мышью, а также коды клавиш, нажимаемых пользователем на клавиатуре ЭВМ, согласно режимам, определяемых выходной экранной информацией. Перечень допустимых клавиш представлен в ПРИЛОЖЕНИИ 2. 4.1.3. Временные характеристики, и размер занимаемой памяти Время реакции программы на нажатие любой из клавиш и манипуляции мышью не должно превышать 0,25 с, в случае соответствия системных ресурсов требованию к составу и параметрам технических средств. Реакция на команды меню, кроме Открытия, Сохранения, Поиска не должна превышать 2 с. Реакция на команды Открытия, Сохранения, Поиска зависит от размера файла данных и настроек поиска. Объем занимаемой оперативной памяти не должен превышать 8 Мбайт. 4.2. Требования к надежности 4.2.1. Требования к надежному функционированию Программа должна нормально функционировать при бесперебойной работе ЭВМ. При возникновении сбоя в работе аппаратуры, восстановление нормальной работы программы должно производиться после: перезагрузки операционной системы; запуска исполняемого файла программы; повторного выполнения действий, потерянных до последнего сохранения информации в файл на магнитном диске. Уровень надежности программы должен соответствовать технологии про­граммирования, предусматривающей: инспекцию исходных текстов программы; автономное тестирование модулей (методов) программы; тестирование сопря­жении модулей (методов) программы; комплексное тестирование программы 4.2.2. Контроль входной и выходной информации Программа должна контролировать выбор пользователя пункта меню "Выход" и предупреждать его о потере "не сохраненных изменений". 4.2.3. Время восстановления после отказа Время восстановления после отказа должно состоять из: времени переза­пуска пользователем операционной системы; времени запуска пользователем исполняемого файла программы; времени повторного ввода потерянных дан­ных. 4.3. Условия эксплуатации Программа должна храниться в виде двух маркированных дискетных ко­пий - эталонной и рабочей. Периодическая перезапись информации должна осуществляться согласно нанесенной маркировке. Условия хранения дискет должны соответствовать нанесенной на них маркировке. 4.4. Требования к составу и параметрам технических средств Программа должна корректно работать на следующем или совместимым с ним оборудовании: 1) ПЭВМ IBM PC модели 486 DX-100, 16Mb RAM или старше 2) Принтер Epson Stylus 800+ модели Р780В 4.5. Требования к информационной и программной совместимости 4.5.1. Требования к информационным структурам на входе и выходе Требования к информационным структурам на входе и выходе определены в пункте(см. п. 4.1.2.). 4.5.2. Требования к методам решения Требования к методам решения определены в подпункте (см. п п. 4.1.1.2.). Выбор остальных методов решения осуществляется разработчиком без согласования с заказчиком. 4.5.3. Требования к языкам программирования Разработка программы должна вестись на одном из следующих языков: 1) Microsoft Visual Basic v5.0 и выше. 2) Microsoft Visual C v5.0 и выше. 3) Borland Delphi v4.0 и выше. Выбор других языков нецелесообразен. 4.5.4. Требования к программным средствам, используемым программой Для работы программы необходима операционная система WINDOWS95 и более поздняя, драйвера мыши и принтера. 4.6. Требования к маркировке и упаковке Дискеты с эталонным и рабочим экземплярами программы должны иметь маркировку, состоящую из надписи EDIT, надписи "эталон" или "рабочая", даты последней перезаписи программы. Упаковка должна соответствовать условиям хранения дискеты. На упаковке должны быть указаны условия транспортирования и хранения дискеты. 4.7 Требования к транспортированию и хранению Условия транспортирования и хранения дискеты должны соответствовать разделу (см. подраздел 4.6.)
5. ТРЕБОВЛНИЯ К ПРОГРАММНОЙ ДОКУМЕНТАЦИИ Состав программной документации должен включать следующие доку­менты: 1) технический проект программы по ГОСТ 19.404-79 в машинописном исполнении, содержащий: а) раздел "ВХОДНЫЕ ДАННЫЕ" (Характер, организация и предварительная подготовка входных данных); б) раздел "ВЫХОДНЫЕ ДАННЫЕ" (Характер и организация выходных данных); в) раздел "ОПИСАНИЕ ЛОГИЧЕСКОЙ СТРУКТУРЫ"; г) раздел "ИСПОЛЬЗУЕМЫЕ ТЕХНИЧЕСКИЕ СРЕДСТВА" (Типы ЭВМ, на которых возможно выполнение программы; устройства ЭВМ, которые ис­пользуются при выполнении программы); д) раздел "ВЫЗОВ И ЗАГРУЗКА" (Виды носителей программы, их ис­пользуемый объем; способы вызова программы с соответствующих носителей данных; входные точки в программу (запуск программы); е) раздел "ПЛАН МЕРОПРИЯТИЙ ПО РАЗРАБОТКЕ И ВНЕДРЕНИЮ ПРОГРАММЫ" (План мероприятий разрабатывается для реализации програм­мы коллективом программистов из двух человек. Планом должны быть преду­смотрены контрольные временные точки реализации, например, через каждые десять дней или неделю, в течение которых происходит интеграция разработан­ных модулей, и тестирование уже разработанной части программы. Приводится состав тестов и принципы их подготовки для тестирования уже созданного фрагмента программы для каждой из контрольных точек). Раздел "ОПИСАНИЕ ЛОГИЧЕСКОЙ СТРУКТУРЫ" при технологии структурного программирования должен включать следующие материалы: 1) описание связей программы с другими программами; 2) описание внутренних массивов и переменных, которые используются в межмодульном обмене данными; 3) схема иерархии программы (Приводится рисунок или рисунки); 4) расшифровка наименований модулей (Приводится таблица с перечнем наименований модулей в алфавитном порядке с указанием выполняемой каждым модулем функции); 5) описание функционирования программы с учетом ее модульного деления (Приводится словесное описание выполнения программы с учетом вызовов модулей); 6) описание модулей программы (Подраздел заполняется на основе паспортов модулей). При технологии объектно-ориентированного программирования вместо I схемы иерархии модулей программы и описаний самих модулей программы должна быть приведена схема иерархии классов (объектов) программы с расшифровкой наименований методов и описаний самих методов.
2) описание программы по ГОСТ 19.402-78 на машинном носителе (дискете с маркировкой DESCRIBE), включающее: назначение программы; дата ее создания; Ф.И.О. разработчика, а также данные, позволяющие связаться с ним; минимальные требования к аппаратным ресурсам; руководство пользователя, содержащее описание всех задокументированных возможностей программы.
3) текст программы по ГОСТ 19.401-78 на машинном носителе (дискете с маркировкой SOURCE), представленный в виде текстового файла, содержащего исходный код на одном из языков, указанных в пункте 4.5.3. 4) руководство программиста по ГОСТ 19.504-79 на машинном носителе носителе (дискете с маркировкой PROG) в виде файла README.TXT, содержащий данные о технологии проектирования и программирования данной программы, а также о языке программирования, назначение программы и список литературы, содержащей теоретический материал, необходимый для создания программы.
6. ТЕХНИКО-ЭКОНОМИЧЕСКИЕ ПОКАЗАТЕЛИ Технико-экономические показатели должны определяться заказчиком без участия исполнителя.
7. СТАДИИ И ЭТАПЫ РАЗРАБОТКИ Разработка программы должна выполняться по следующим этапам: 1) разработка, согласование и утверждение технического проекта про­граммы с пояснительной запиской - 5 недель; 2) разработка рабочего проекта программы с комплексным тестированием - 6 недель; 3) приемка-сдача с исправлением обнаруженных недостатков в программе и программной документации - 2 недели. 4)внедрение.
8. ПОРЯДОК КОНТРОЛЯ И ПРИЕМКИ 8.1. Виды испытаний Проверка документации программы осуществляется самим заказчиком с привлечением сторонних экспертов, способных засвидетельствовать факт соответствия созданного программного продукта всем пунктам технической документации, включая техническое задание и технический проект. Испытания и тестирование программы должны проводиться в процессе создания программы самим разработчиком: 1. C использованием контрольных тестов, позволяющих добиться проверки правильности работоспособности и взаимной совместимости максимального числа функций и операторов программы или модуля при минимальных затратах временных и финансовых ресурсов. 2. Путем пошагового исполнения программы или модуля (и непрерывного контроля значений переменных) в соответствии с набором тестовых примеров и сравнения полученных в процессе тестирования значений с контрольными значениями тестовых примеров. 3. С привлечением сторонних неофициальных бета-тестеров, которые в процессе тестирования программного продукта должны сообщать разработчику все найденные ошибки и неточности в работе программы. и проверка документации должна проводиться. Испытания и тестирование программы должны проводиться после завершения создания программы заказчиком: 1. С использованием проверочных тестов, составляемых зказчиком заблаговременно. 2. В процессе начального этапа внедерения программы, путем тестирования программы в организации заказчика в рабочих условиях на протяжении срока в 1 неделю. 3. В организации заказчика с привлечением сторонних экспертов. 8.2.Общие требования к приёмке Приёмка программы должна осуществляться заказчиком. Программа должна считаться годной, если она удовлетворяет всем пунктам данного технического задания, что должно быть засвидетельствовано сторонними экспертами.
ПРИЛОЖЕНИЕ 1
Структура главного меню Главное меню Склад Выбрать… Создать… Открыть… Закрыть Сохранить… Сохранить все Печать… Выход Правка Копировать Вырезать Вставить Найти Заменить… Карточка Добавить Удалить Просмотр Новый приход Новый расход Списать остаток Сервис Сортировка по… Название Цена Остаток Фильтр Резервная копия Настройка Цвет Шрифт Параметры Статис-тика Товаров на складе… Продаж за… Неделю Месяц Последние… Продаж на складе… График продаж Помощь Справка О программе… Рис 1.
Рис 2. Рис 3. Рис 5. Рис 6. Рис 4. Рис 9. Рис 7. Рис 8. Рис 10. ЗАМЕЧАНИЯ: 1. На рисунках указаны формы в развёрнутом виде. 2. Данные формы иллюстрируют: Рис 1. Таблица товаров на складах Рис 2. Таблица перемещений товаров между складами Рис 3. Построение графиков расхода и дохода выбранных складов Рис 4. Меню "Склад" Рис 5. Меню "Правка" Рис 6. Меню "Карточка" Рис 7. Меню "Сервис" Рис 8. Меню "Статистика" Рис 9. Меню "Помощь" Рис 10. Карточка товара 3. Разработчиком может осуществляется добавление к указанным экранным элементам других элементов (в т.ч. меню, страниц, панелей и.т.п.), без согласования с заказчиком. 4. Другие экранные формы разрабатываются разработчиком без согласования с заказчиком. 5. По желанию заказчика могут быть добавлены дополнительные экранные элементы и возможности по согласованию с разработчиком 6. Удаление указанных элементов осуществляется по согласованию с заказчиком. 7. В процессе дальнейшей разработки данные формы могут быть незначительно усовершенствованы в целях улучшения качества программного продукта без согласования с заказчиком
ПРИЛОЖЕНИЕ 2 Основные клавиши Клавиша/Диапазон клавиш Описание А – Я, а – я, A – Z, a – z, точка, запятая, кавычки, круглые скобки Клавиши, используемые для ввода текстовой информации в карточку товара 0 - 9 Клавиши, используемые для ввода числовой информации в карточку товара Быстрые клавиши Клавиша/Диапазон клавиш Описание F1 Помощь по данному объекту F2 Сохранение данных F3 Загрузка данных F4 Печать данных о товарах на складе F5 Статистика по складу F10 Выход Ctrl+Ins Копировать Shift+Ins Вставить Ctrl+Del Удалить Shift+Del Вырезать PageUp Предыдущая страница PageDown Следующая страница Home Переместиться в начало End Переместиться в конец Delete Удалить следующий символ или запись BackSpace Удалить предыдущий символ Insert Режим вставки/замены
ПРИЛОЖЕНИЕ 3 Файлы данных: Входные и выходные файлы имеют следующий формат: Полное имя файла: указывается пользователем (длина до 255 символов) Тип файла: файл представлен в виде таблицы формата MSACCESS (*.mdb) Таблица: «Карточка» Поле Тип данных Комментарий Номер Номер товара на складе Наименование Текстовой Наименование товара Примечание Текстовой Примечание о товаре Ед.изм. Текстовой Единица измерения товара Дата Числовой Дата совершения операции Новый Логический Операция над товаром (приход, расход) Количество Числовой Количество товара, с которым произведена операция Цена Числовой Цена товара в момент совершения операции Сумма Числовой Сумма операции Валюта Текстовой Выбор денежного формата % НДС Числовой Процент НДС в момент совершения Сумма НДС Числовой Сумма НДС От кого получено Текстовой Наименование поставщика Кому отпущено Текстовой Наименование покупателя Примечание Текстовой Примечание о совершенной операции Статистика учета Табличный Таблица статистика учета операций с товаром, содержит поля: От кого получено (Текстовой), Кому отпущено (Текстовой), Приход (Числовой), Расход (Числовой), Цена (Числовой), Сумма операции (Числовой), Дата (Числовой), %НДС (Числовой), Сумма НДС (Числовой), Остаток (Числовой). Конфигурационные файлы: Файл содержащий настройки программы: Полное имя файла: config.mdb Тип файла: файл представлен в виде таблицы формата MSACCESS (*.mdb) Таблица: «Параметры»
Поле Тип данных Описание ИН Числовой Номер объекта Цвет Числовой Цвет объекта Шрифт Текстовой Название шрифта НДС Числовой Флаг учета НДС % НДС Числовой Процент НДС