Требования к функциональности приложений и оформлению текстов программ
Требования к оформлению пояснительной записки
Состав записки должен быть таковым:
Титульный лист
Содержание:
1. Введение
2. Техническое задание
3. Проектирование приложения
4. Руководство пользователя
5. Руководство программиста
6. Заключение
7. Список литературы
Объем записки не ограничивается. Язык записки: украинский, русский или английский.
Титульный лист.
Выбирайте титульный лист в соответствии с номером своей группы!
МІНІСТЕРСТВО ОСВІТИ І НАУКИ УКРАЇНИ
Національний аерокосмічний університет ім. М. Є. Жуковського
«Харківський авіаційний інститут»
Факультет літакобудування
Кафедра інформаційних технологій проектування
Курсовий проект
Сучасні технології та інструментарій програмування
(назва дисципліни)
на тему: «Тема курсового проекту»
Виконав: студент 5 курсу групи № 156
напряму підготовки (спеціальності)
7.05010102 “Інформаційні технології проектування”
(шифр і назва напряму підготовки (спеціальності))
???????????????_____________________
(прізвище й ініціали студента)
Керівник:
доцент, к.т.н. Овсяннік В.М.
(посада, науковий ступінь, прізвище й ініціали)
Національна шкала: __________
Кількість балів: _____
Оцінка: ECTS _____
Члени комісії:
_________ ______________
(підпис) (прізвище й ініціали)
_________ ______________
(підпис) (прізвище й ініціали)
_________ ______________
(підпис) (прізвище й ініціали)
Харків – 201_
МІНІСТЕРСТВО ОСВІТИ І НАУКИ УКРАЇНИ
Національний аерокосмічний університет ім. М. Є. Жуковського
«Харківський авіаційний інститут»
Факультет літакобудування
Кафедра інформаційних технологій проектування
Курсовий проект
Сучасні технології та інструментарій програмування
(назва дисципліни)
або
на тему: «Тема курсового проекту»
Виконав: студент 5 курсу групи № 156М
напряму підготовки (спеціальності)
8.05010102 “Інформаційні технології проектування”
(шифр і назва напряму підготовки (спеціальності))
???????????????_____________________
(прізвище й ініціали студента)
Керівник:
доцент, к.т.н. Овсяннік В.М.
(посада, науковий ступінь, прізвище й ініціали)
Національна шкала: __________
Кількість балів: _____
Оцінка: ECTS _____
Члени комісії:
_________ ______________
(підпис) (прізвище й ініціали)
_________ ______________
(підпис) (прізвище й ініціали)
_________ ______________
(підпис) (прізвище й ініціали)
Харків – 201_
МІНІСТЕРСТВО ОСВІТИ І НАУКИ УКРАЇНИ
Національний аерокосмічний університет ім. М. Є. Жуковського
«Харківський авіаційний інститут»
Факультет літакобудування
Кафедра інформаційних технологій проектування
Курсовий проект
Системне проектування складних програмних засобів
(назва дисципліни)
на тему: «Тема курсового проекту»
Виконав: студент 5 курсу групи № 157М
напряму підготовки (спеціальності)
8.05010103 “ Системне проектування”
(шифр і назва напряму підготовки (спеціальності))
???????????????_____________________
(прізвище й ініціали студента)
Керівник:
доцент, к.т.н. Овсяннік В.М.
(посада, науковий ступінь, прізвище й ініціали)
Національна шкала: __________
Кількість балів: _____
Оцінка: ECTS _____
Члени комісії:
_________ ______________
(підпис) (прізвище й ініціали)
_________ ______________
(підпис) (прізвище й ініціали)
_________ ______________
(підпис) (прізвище й ініціали)
Харків – 201_
Техническое задание
Структура ТЗ:
1. Назначение программного продукта, включающее полный перечень его функций.
2. Подробное описание входных данных с указанием источника (дисковый файл, ввод в диалоговом режиме, таблицы БД и т.п.), диапазонов возможных значений, единиц измерения.
3. Описание выходных данных (результатов).
4. Характер и структура интерфейса пользователя: эскизы экранных форм, описание меню приложения и инструментальных панелей, предполагаемых к разработке.
5. Технические и программные ресурсы, необходимые для разработки и эксплуатации программного продукта.
ТЗ разрабатывается в первую очередь (см. «График выполнения курсового проекта»), подписывается автором и преподавателем и впоследствии включается в пояснительную записку в качестве ее составной части.
Для разработки курсового проекта может быть использован практически любой язык программирования и любая среда разработки, согласованные с преподавателемеще на этапе утверждения темы. Если в качестве целевой ОС выбирается Windows, то приложение должно быть разработано таким образом, чтобы оно могло выполняться на кафедральных компьютерах с Windows XP SP3.
Проектирование приложения
На этом этапе должны быть выполнены перечисленные ниже работы и их результаты должны быть отражены в соответствующих разделах пояснительной записки.
Анализ предметной области (место приложения в ряду аналогичных программных продуктов, необходимость и актуальность его разработки и т.д.) и имеющихся прототипов.
Функциональный и структурный анализ решаемой задачи.
Математическая модель решаемой задачи, если таковая есть, и изложение алгоритма.
Руководство пользователя
Среда выполнения приложения, т.е. версия (и) операционной системы.
Ценные указания по развертыванию (инсталляции) приложения. Перечень файлов, необходимых для нормального функционирования приложения, с указанием их назначения. Если для работы приложения требуется наличие в системе каких-либо дополнительных программных продуктов, то их также необходимо указать. Здесь надо указать именно те файлы, которые необходимы для запуска готового приложения на выполнение, т.е. файлы с исходными текстами программ здесь указывать не надо. Если файлы приложения должны располагаться в определенных каталогах, то их структуру также необходимо указать.
Подробное описание интерфейса приложения, последовательность действий пользователя.
Использование системы помощи (Help).
Ограничения, возможные ошибки и действия пользователя при их возникновении.
Примеры использования приложения.
Руководство программиста
Полный перечень (исходных) файлов приложения с указанием их назначения. Без острой необходимости в перечень этих файлов не стоит включать откомпилированные файлы модулей и другие вспомогательные файлы (.obj, .pch, .sbr, .ncb, .pdb и т.п.).
Структура приложения на уровне компонентов и классов. Иерархия (собственных) классов, используемых в приложении.
Описание классов, включающее описание их атрибутов (член-данных) и методов. Описание класса должно, в обязательном порядке, начинаться с объявления тела класса, т.е. содержимого соответствующего (заголовочного) файла. Также должны быть сделаны описания «глобальных» данных и типов, т.е. описания, сделанные вне подпрограмм и классов, и описания пространств имен.
Заключение.
Выводы о соответствии разработанного приложения заданию.
Требования к функциональности приложений и оформлению текстов программ
Вот те десять заповедей разработчика, нарушение любой из которых является грехом и будет кем-нибудь покарано…
1. Приложение (проект) не должно иметь имя вроде Project, 1, ttt, МашаиМедведь и т.п. Другими словами, имя приложения должно нести смысловую нагрузку.
2. Приложение должно быть работоспособным и не должно прерываться при любых ошибках пользователя. Оно, в частности, не должно терять свою работоспособность при простом переносе его в другой каталог с соблюдением оговоренных в «Руководстве пользователя» требований к инсталляции приложения.
3. Приложение должно быть собрано так, чтобы оно было в максимальной степени мобильным и не требовало установки на целевой компьютер какого-либо дополнительного ПО. Это значит, в частности, что приложение должно быть работоспособно на компьютерах, установленных в ауд. кафедры.
4. В приложении должен быть использован механизм обработки исключительных ситуаций для предотвращения аварийного завершения приложения операционной системой и контроля ошибок пользователя.
5. Если приложение выполняет какую-либо операцию длительностью более 1-2 сек., надо, как минимум, изменять форму курсора мыши (например, на «песочные часы») для того, чтобы дать знать пользователю о том, что приложение еще работает, а не «висит». При выполнении длительной по времени операции приложение должно обрабатывать сообщения Windows и иметь управляющий компонент, предназначенный для прерывания длительной по времени операции. Для загрузки курсора «песочные часы» см., например, функцию CWinApp::DoWaitCursor().
6. Визуальные компоненты приложения должны иметь подсказки (hints).
7. Приложение должно иметь окно «О программе» (About) и файл справки. В окне About должна быть указана фамилия разработчика и группа. Файл справки должен иметь хотя бы два уровня: содержание и собственно подсказки. Файл справки можно разрабатывать с использованием любых доступных вам средств.
8. Файлы с исходными текстами программ должны иметь комментарии. Каждый файл приложения должен включать информацию о его назначении, авторе и дате разработки. Для каждой подпрограммы, в том числе методов классов, должно быть указано ее назначение и приведено описание параметров. Для полей и свойств классов также должно быть указано их назначение.
9. Формы приложения, если только это не противоречит их функциональности, должны быть изменяемыми по размерам. При изменении размеров формы должны также изменяться размеры тех ее компонентов, которые содержат или могут содержать большой объем информации. При масштабировании формы ее эстетическое восприятие не должно ухудшаться.
10. Каждое приложение должно сохранять текущие настройки пользователя в специальном .ini файле или реестре Windows (менее предпочтительно) и при очередном запуске приложения воссоздавать для пользователя ту конфигурацию и настройки приложения, которые были им сделаны в предыдущем сеансе работы.