Файл: Составление программной документации.pdf

12
1. ОБЩИЕ СВЕДЕНИЯ
1.1. Обозначение и наименование программы
Программа очистки оперативной памяти «Mem» имеет следующие атрибуты:

Наименование исполняемого файла
- Mem.exe

Размер исполняемого файла
- 20 480 байт

«Иконка» исполняемого файла
-

Версия файла
- 1.2.0.3

Версия продукта
- 1.02.0003

Внутреннее имя
- Mem

Исходное имя файла
- Mem.exe

Название продукта
- Mem

Описание версии файла
- 1.02.0003

Производитель
- ХХХ

Язык
- English (United States)
1.2. Программное обеспечение, необходимое для функционирования программы
Системные программные средства, используемые программой
Mem.exe, должны быть представлены локализованной версией операционной системы Windows 98 или Windows Me.
Также для функционирования программы Mem.exe на ПК необходимо предустановленное программное обеспечение стороннего разработчика, программа FreeMemory (версии 1.7). Программа FreeMemory должна быть установлена в каталог C:\Program Files\FreeMemory\. Для установки данной программы достаточно скопировать перечисленные ниже файлы в указанную папку на компьютере пользователя. Каких-либо настроек после копирования программы FreeMemory не требуется.
Список файлов программы FreeMemory:

FreeMemory.exe
36 352 байт

FreeMemory.hlp
46 965 байт

FreeMemory.cnt
813 байт

File_id.diz
629 байт

Каталог \Plugin\ Setup\ Setup.dll
12 800 байт
1.3. Языки программирования, на которых написана программа
Исходным языком программирования для «Mem.ехе» является Visual
Basic. Среда разработки, компилятор - Microsoft Visual Basic 6.0
(локализованная, русская версия).

13
2. ФУНКЦИОНАЛЬНОЕ НАЗНАЧЕНИЕ
2.1. Классы решаемых задач
После многократного открытия и закрытия программ, записи в базы данных, считываний из них, а также в процессе работы SCADa-системы и ОС оперативная память значительно фрагментируется. В итоге команды будут обрабатываться на порядок медленнее. У процессора в кэш (L1 и L2) записывается определенная часть оперативной памяти еще до того, как будет произведено обращение к этой области памяти. Когда же настает черед
«прокэшированных» команд или данных, то они читаются процессором из
КЭШа, что во много раз быстрее, чем обращение к оперативной памяти. Если запущенная программа и ее данные оказались фрагментированными в памяти, происходит ситуация, когда в кэш попадают совсем не те данные, которые нужны, и процессору ничего не остается, как отыскивать нужное в оперативной памяти. Подобное снижение hit rate КЭШа (число попаданий) способно снизить производительность, независимо от объема оперативной памяти.
Многие программы, в том числе и сама ОС, загружают в память множество библиотек (DLL) и не факт, что эти библиотеки будут обязательно использоваться. Поэтому необходимо подобные DLL выгружать в своп-файл. Если они вдруг понадобятся, то незамедлительно будут загружены ОС назад.
Действия по оптимизации и дефрагментации оперативной памяти производят программы сторонних разработчиков, такие как «FreeMemory» и
«CoolMEM». В ходе их тестирования было установлено, что данные программы, в режиме постоянного мониторинга ОЗУ и очистке памяти при превышении заданных пределов, значительно загружают операционную систему и в некоторых случаях, приводят к зависанию ПК. В ходе изысканий было установлено, что при использовании программы «FreeMemory» (версии
1.7), при запуске еѐ командной строкой с параметрами «С А» (С – очистка памяти, А - очистить всю память), после выполнения всех процедур по очистке и дефрагментации ОЗУ, данная программа полностью выгружается из памяти компьютера. При этом зависаний ПК не происходит и не используются лишние ресурсы компьютера. Используя эти данные, была разработана программа «Mem.exe», которая каждый час, командной строкой с параметрами «С А» загружает программу «FreeMemory», для очистки ОЗУ.
2.2. Назначение программы
Программа «Mem.ехе» работает под управлением ОС Windows 98 или
Windows Me. Основной функцией программы «Mem.exe» является вызов из каталога C:\Program Files\FreeMemory\ программы стороннего разработчика
FreeMemory.exe с параметрами командной строки «С А» (С – очистка памяти, А - очистить всю память). Вызов программы производится по таймеру, каждый час, в ХХ.15.00 (в 15 минут каждого часа). Дополнительно

15

16

17

18
3.2. Используемые методы
Программа «Mem.ехе» использует следующие методы:
1. Me.Hide – скрытие окна «формы» на экране. Программа не отображается на экране и в системном лотке, но видна в списке задач.
2. Часы(х).Enabled – запуск и остановка таймера.
3. Shell – запуск внешнего приложения с параметрами командной строки, в свернутом состоянии.
3.3. Структура программы с описанием функций составных частей и связи между ними
Программа «Mem.ехе» состоит из одной запускаемой формы и не имеет других составных частей.
3.4. Связи программы с другими программами
Программа «Mem.ехе» в ходе своей работы запускает программу
«FreeMemory», поэтому для ее функционирования необходимо предустановленная в каталог «C:\Program Files\FreeMemory\» программа
FreeMemory.ехе (версии 1.7).
4. ИСПОЛЬЗУЕМЫЕ ТЕХНИЧЕСКИЕ СРЕДСТВА
В состав используемых технических средств входит: IBM PC совместимый с процессором 80386 и выше, ОЗУ не менее 32 Мбайт, 16 МБ видеопамяти, наличие свободного места на жестком диске 100 Мбайт.
5. ВЫЗОВ И ЗАГРУЗКА
Загрузка и запуск программы осуществляется способами, детальные сведения о которых изложены в Руководстве пользователя операционной системы.
6. ВХОДНЫЕ ДАННЫЕ
Программа «Mem.ехе» в ходе своей работы не использует никаких входных данных.
7. ВЫХОДНЫЕ ДАННЫЕ
Программа «Mem.ехе» в ходе своей работы не создает никаких выходных данных.
ЛИСТ РЕГИСТРАЦИИ ИЗМЕНЕНИЙ
Номера листов (страниц)
Всего листов
(страниц) в докум
№ документа
Входящий
№ сопрово дительного документа и дата
Подп. Дата
Изм изменен ных заме ненных новых анулиро ванных

19
Лабораторная работа №2. Составление программного документа
«Стадии разработки» в соответствии с ГОСТ 19.102-77
Цель работы: Ознакомиться с процедурой составления программного документа «Стадии разработки» в соответствии с ГОСТ 19.102-77
Основные теоретические сведения
Устанавливает стадии разработки программ и программной документации для вычислительных машин, комплексов и систем независимо от их назначения и области применения (таблице).
Стадии разработки, этапы и содержание работ
Стадия
разработки
Этап работы
Содержание работ
Техническое задание
Обоснование необходимости разработки программы
Постановка задачи.
Сбор исходных материалов.
Выбор и обоснование критериев эффективности и качества разраба- тываемой программы.
Обоснование необходимости прове- дения научно-исследовательских работ
Научно- исследовательские работы
Определение структуры входных и выходных данных.
Предварительный выбор методов решения задач.
Обоснование целесообразности применения ранее разработанных программ.
Определение требований к техничес- ким средствам.
Обоснование принципиальной воз- можности решения поставленной задачи
Разработка и утверждение технического задания
Определение требований к прог- рамме.
Разработка технико-экономического обоснования разработки программы.
Определение стадий, этапов и сроков разработки программы и доку- ментации на нее.
Выбор языков программирования.
Определение необходимости про- ведения научно-исследовательских

20 работ на последующих стадиях.
Согласование и утверждение техни- ческого задания
Эскизный проект
Разработка эскизного проекта
Предварительная разработка струк- туры входных и выходных данных.
Уточнение методов решения задачи.
Разработка общего описания алго- ритма решения задачи.
Разработка технико-экономического обоснования
Утверждение эскизного проекта
Разработка пояснительной записки.
Согласование и утверждение эскиз- ного проекта
Технический проект
Разработка технического проекта
Уточнение структуры входных и выходных данных.
Разработка алгоритма решения задачи.
Определение формы представления входных и выходных данных.
Определение семантики и синтаксиса языка.
Разработка структуры программы.
Окончательное определение конфи- гурации технических средств
Утверждение технического проекта
Разработка плана мероприятий по разработке и внедрению программ.
Разработка пояснительной записки.
Согласование и утверждение техни- ческого проекта
Рабочий проект
Разработка программы
Программирование и отладка программы
Разработка программной документации
Разработка программных документов в соответствии с требованиями
ГОСТ 19.101-77
Испытания программы
Разработка, согласование и утверж- дение программы и методики испы- таний.
Проведение предварительных госу- дарственных, межведомственных, приемо-сдаточных и других видов испытаний.
Корректировка программы и прог-

21 раммной документации по резуль- татам испытаний
Внедрение
Подготовка и передача программы
Подготовка и передача программы и программной документации для сопровождения и (или) изготовления.
Оформление и утверждение акта о передаче программы на сопровож- дение и (или) изготовление.
Передача программы в фонд алго- ритмов и программ
Допускается исключать вторую стадию разработки, а в технически обоснованных случаях — вторую и третью стадии. Необходимость проведения этих стадий указывается в техническом задании.
Допускается объединять, исключать этапы работ и (или) их содержание, а также вводить другие этапы работ по согласованию с заказчиком.
Задания для выполнения
1. Составить программный документ «Стадии разработки» в соответствии с ГОСТ 19.102-77 ЕСПД. Стадии разработки
2. Оформить работу в соответствии с ГОСТ 19.106—78. При оформлении использовать MS Office или OpenOffice.org.
3. Сдать и защитить работу.
Содержание и оформление отчета по лабораторной работе
Отчѐт должен содержать:
1. Титульный лист.
2. Аннотацию.
3. Содержание.
4. Основную часть, оформленную в соответствии с ГОСТ 19.102-77 ЕСПД.
Стадии разработки
5. Заключение (описание результатов работы).
Защита отчета по лабораторной работе заключается в предъявлении преподавателю полученных результатов (на экране монитора или у доски), демонстрации полученных навыков и ответах на вопросы преподавателя.
Контрольные вопросы
1. Назовите основные виды программной документации.
2. Охарактеризуйте каждый из них. В каких случаях их используют?
3. Что должно содержаться в программном документе «Стадии разработки»?

22
4. На кого рассчитан программный документ «Стадии разработки»?
5. В каких ситуациях вы используете программный документ
«Стадии разработки»?
Время, отведенное на выполнение лабораторной работы
Время, отводимое на выполнение лабораторной работы, определяется в соответствии с программой и календарно-тематическим планированием, а также сложностью программного продукта, на который разрабатывается программный документ «Стадии разработки».
Литература
1. ГОСТ 19.102-77 ЕСПД. Стадии разработки
2. ГОСТ 19.106—78. Требования к программным документам, выполненным печатным способом
3. Гагарина Л.Г, Киселев Д.В., Федотова Е.Л. Разработка и эксплуатация автоматизированных информационных систем: учеб. пособие / Под ред. Проф. Л.Г. Гагариной. – М.: ИД «ФОРУМ»:
ИНФРА-М, 2011-384с.: ил. – (Профессиональной образование)
4. Иванова Г.С. Технология программирования: Учебник для вузов. -
М.: Изд-во МГТУ им. Н.Э. Баумана, 2011. - 320 с.: ил.
5. Портал нормативных документов: http://www.opengost.ru/