Шаблон_Руководство системного программиста (РСП) (1079898)
Текст из файла
7

Московский государственный технический университет им. Н.Э.Баумана
_________________________________________________________________
УТВЕРЖДАЮ: | |
Большаков С.А. | "__"_____________201Х Г. |
Комплексная лабораторная работа по дисциплине ПКШ
“Система классов улиц и домов”
Руководство системного программиста
(вид документа)
писчая бумага
(вид носителя)
7
(количество листов)
ИСПОЛНИТЕЛЬ: | |
студент группы ИУ5-ХХ | _____________________ |
Большаков С.А. | "__"_____________201Х г. |
Москва - 201Х
________________________________________________________________
СОДЕРЖАНИЕ
1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ 3
2. ТРЕБОВАНИЯ К СОСТАВУ И ПАРАМЕТРАМ ТЕХНИЧЕСКИХ СРЕДСТВ 3
3. ТРЕБОВАНИЯ К ПРОГРАММНОМУ ОБЕСПЕЧЕНИЮ 3
4. СОСТАВ ПРОГРАММНОГО ПРОДУКТА 3
5. УСТАНОВКА ПРОГРАММНОГО ПРОДУКТА 4
6. УДАЛЕНИЕ ПРОГРАММНОГО ПРОДУКТА 4
7. ЗАПУСК ПРОГРАММЫ 4
8. ЗАВЕРЕШНИЕ РАБОТЫ ПРОГРАММЫ 4
9. СООБЩЕНИЙ ОБ ОШИБКАХ И ИСКЛЮЧИТЕЛЬНЫЕ СИТУАЦИИ 5
10. УСЛОВИЯ ЭКСПЛУАТАЦИИ ПРОГРАММНОГО ПРОДУКТА 5
11. ПРОВЕРКА РАБОТОСПОСОБНОСТИ ПРОГРАММНОГО ПРОДУКТА 5
12. ПОДГОТОВКА К РАБОТЕ С ПРОГРАММНЫМ ПРОДУКТОМ 5
13. ОБЩИЕ ХАРАКТЕРИСТИКИ ПРОГРАММНОГО ПРОДУКТА 5
1 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ
Система классов домов и улиц предназначена для автоматизации работы с объектами улиц и домов в программных проектах и предметной области, где необходимо это учитывать. В частности, система классов предназначена для программирования задач включающих действия: оценки ремонта домов и улиц, подсчета числа жителей, квартир и этажей в домах. Система классов обеспечивает удобную работу с этими объектами, высокий уровень надежности программ, функциональных возможностей, а также сокращение сроков разработки и реализации программных продуктов, где необходимо использовать подобные объекты.
Данная система классов должна эксплуатироваться совместно системой программирования С++ (MS VS 2005/08/10/12). Для работы с данной системой классов может программист с основами и навыками объектно-ориентированного программирования.
В остальном требования к эксплуатации и условия к применению точно такие же, как к программной реализации языка С++, используемой совместно с данной системой классов.
(В данном разделе рассмотрено назначение и условия применения программного продукта)
2ТРЕБОВАНИЯ К СОСТАВУ И ПАРАМЕТРАМ ТЕХНИЧЕСКИХ СРЕДСТВ
Данная система классов должна использоваться на компьютерах следующей конфигурации:
3 IBM-совместимый компьютер с процессором 80486 и выше;
4 Не менее 1 Мбайт свободной оперативной памяти;
5 VGA-совместимый видеоадаптер и монитор;
6 Стандартная клавиатура;
7 Свободного места на жёстком диске не менее 200 Кбайт.
(В данном разделе приводятся требования к техническим характеристикам для работы программного обеспечения)
8 ТРЕБОВАНИЯ К ПРОГРАММНОМУ ОБЕСПЕЧЕНИЮ
Данный программный продукт требует наличия русификатора дисплея для корректного отображения символов русского алфавита или ОС обеспечивающей переключение кодовой страницы для русского шрифта.
Данная система классов должна эксплуатироваться совместно системой программирования С++ (MS VS 2005/08/10/12).
В остальном требования к программному обеспечению точно такие же как к программной реализации языка С++, используемой совместно с данной системой классов.
(В данном разделе приводятся требования к программному обеспечению для функционирования программного продукта)
9 СОСТАВ ПРОГРАММНОГО ПРОДУКТА
Программный продукт включает три основных модуля:
Название | Размер и тип | Описание | Примечание |
DZ_2kurs.h | 32,4 Кб, текстовый файл | Описания классов, методов и общих данных | Содержит все необходимые описания для использования программного продукта |
DZ_2kurs.cpp | 12,9 Кб, текстовый файл | Тестовая программа | Программа предназначена для проверки работоспособности системы классов и проведения приемно-сдаточных испытаний |
DZ_2kurs.exe | 114,7 Кб, исполнимый файл | Тестовая программа | Содержит все необходимое для автономного выполнения в режиме командной строки. |
(В данном разделе приводится перечень составляющих модулей программного продукта)
10 УСТАНОВКА ПРОГРАММНОГО ПРОДУКТА
Для того, чтобы установить данный программный продукт на компьютер следует произвести следующие действия:
-
Освободить на жестком диске как минимум 200 килобайт свободного пространства.
-
Вставить дискету или CD/DVD носитель с дистрибутивом программного продукта в дисковод или CD/DVD устройство.
-
Скопировать файлы. С помощью системной функции копирования файлы (или файл менеджера), которые перечислены в разделе 4 этого документа, с носителя на жесткий диск в нужные каталоги. Для испытаний любой доступный каталог (DZ_2kurs.exe). Для подключения в новый проект (DZ_2kurs.h) в ощий каталог заголовочных файлов или в специально созданный каталог для новой сборки тестового примера (DZ_2kurs.cpp, DZ_2kurs.h).
-
Прописать в установках каталогов для используемой на компьютере системы программирования С++ полный пути к директории, куда был установлен программный продукт (DZ_2kurs.h).
(В данном разделе по шагам рассматриваются действия для установки программного продукта)
11 УДАЛЕНИЕ ПРОГРАММНОГО ПРОДУКТА
Чтобы удалить данный программный продукт, надо с помощью системной функции удаления (или файл менеджера) удалить файлы, перечисленные в пункте 4 данного документа, из директорий, куда они были скопированы.
(В данном разделе рассматриваются действия для удаления программного продукта)
12 ЗАПУСК ПРОГРАММЫ
Для запуска программы тестового примера необходимо перейти в каталог, в который Вы скопировали данный программный продукт (см. пункт 5 этого документа) и запустить файл DZ_2kurs.exe.
(В данном разделе рассмотрены действия для запуска программы тестового примера)
13 ЗАВЕРЕШНИЕ РАБОТЫ ПРОГРАММЫ
Для завершения работы программы тестового примера необходимо выполнить пункт меню тестового примера, в котором предлагается завершить программу. В критических ситуациях можно принудительно завершить программу, нажав на крестик в правом верхнем углу окна.
(В данном разделе описаны действия для завершения работы программы тестового примера)
14 СООБЩЕНИЙ ОБ ОШИБКАХ И ИСКЛЮЧИТЕЛЬНЫЕ СИТУАЦИИ
В системе классов улиц и домов не предусмотрена обработка исключительных ситуаций и выдача диагностических сообщений. В программах, разработанных с включением этой системы классов, может быть предусмотрена обработка исключительных ситуаций и выдача сообщений об ошибках. Выдаваемые системные диагностические сообщения и возникающие системные исключительные ситуации описаны в документации на систему программирования (MS VS 2005/08/10/12).
(В данном разделе приводятся диагностические сообщения об ошибках и исключительных ситуациях, которые могут появиться при эксплуатации программного продукта)
15 УСЛОВИЯ ЭКСПЛУАТАЦИИ ПРОГРАММНОГО ПРОДУКТА
Требования к условиям эксплуатации программного продукта описаны в п. 5.3 документе “Техническое задание”.
(В данном разделе дается описание условий эксплуатации программного продукта)
16 ПРОВЕРКА РАБОТОСПОСОБНОСТИ ПРОГРАММНОГО ПРОДУКТА
Проверка работоспособности системы классов выполняется на основе документа “Программа и методика испытаний” и специальной программы тестового примера (DZ_2kurs.exe). В отдельных случаях оговоренных с заказчиком может быть продемонстрирована сборка программного продукта на основе тестового примера, для чего предоставляется среда системы программирования (MS VS 2005).
(В данном разделе описывается процесс проверки работоспособности программного продукта)
17 ПОДГОТОВКА К РАБОТЕ С ПРОГРАММНЫМ ПРОДУКТОМ
Для работы с системой классов в отдельных проектах необходимо прописать пути размещения файла с описаниями классов (DZ_2kurs.h), либо, что нежелательно, скопировать файл в каталог нового проекта и подключить его в исходный текст с помощью директивы include. В более старших версиях системы программирования MS VS, можно установить зависимости между подключаемыми файлами и основными модулями.
(В данном разделе рассмотрены вопросы подготовки использования программного продукта)
18 ОБЩИЕ ХАРАКТЕРИСТИКИ ПРОГРАММНОГО ПРОДУКТА
Система классов позволяет хранить списки домов на улицах.
Занимаемый объем на ЖД исходными текстами: 200 Кбайт
Занимаемый объем на ЖД для повторения сборки проекта: 45 Мбайт
Количество пользовательских классов: 2
Общее количество классов: 7
Язык программирования | С++ |
Компилятор, компоновщик | MS VS 2005/08/10/12 |
Файл проекта (*.vcproj) | DZ.vcproj |
Стандартные заголовочные файлы библиотеки MS VS 2005. | iostream, string.h, stdafx.h, conio.h |
(В данном разделе приводятся общие характеристики программного продукта)
7
Характеристики
Тип файла документ
Документы такого типа открываются такими программами, как Microsoft Office Word на компьютерах Windows, Apple Pages на компьютерах Mac, Open Office - бесплатная альтернатива на различных платформах, в том числе Linux. Наиболее простым и современным решением будут Google документы, так как открываются онлайн без скачивания прямо в браузере на любой платформе. Существуют российские качественные аналоги, например от Яндекса.
Будьте внимательны на мобильных устройствах, так как там используются упрощённый функционал даже в официальном приложении от Microsoft, поэтому для просмотра скачивайте PDF-версию. А если нужно редактировать файл, то используйте оригинальный файл.
Файлы такого типа обычно разбиты на страницы, а текст может быть форматированным (жирный, курсив, выбор шрифта, таблицы и т.п.), а также в него можно добавлять изображения. Формат идеально подходит для рефератов, докладов и РПЗ курсовых проектов, которые необходимо распечатать. Кстати перед печатью также сохраняйте файл в PDF, так как принтер может начудить со шрифтами.