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

ВУЗ: Не указан

Категория: Не указан

Дисциплина: Не указана

Добавлен: 10.01.2024

Просмотров: 287

Скачиваний: 5

ВНИМАНИЕ! Если данный файл нарушает Ваши авторские права, то обязательно сообщите нам.

1   2   3   4   5   6   7   8   9   10

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


FreeMemory.exe с параметрами командной строки «С А» (С – очистка памяти, А - очистить всю память). Вызов программы производится по таймеру, каждый час, в ХХ.15.00 (в 15 минут каждого часа). Дополнительно

51 программа Mem.exe проверяет наличие по указанному пути (C:\Program
Files\FreeMemory\) исполняемого модуля программы FreeMemory.exe, в случае его отсутствия, выдается сообщение «Файл FreeMemory.exe не найден, переустановите программу».
Основная задача вызываемой программы FreeMemory - повысить производительность системы.
Программа FreeMemory реализует следующие функции:

Очистка и дефрагментация оперативной памяти

Выгрузка ненужных DLL

Очистка КЭШа
Данные функции программы FreeMemory позволяют поддерживать бесперебойную работу ПК длительное время, предотвращать утечки памяти, засорение оперативной памяти неиспользуемыми DLL и программами, а также в итоге предотвращать зависание ПК.
1.3. Условия, необходимые для выполнения программы
1.3.1. Объем оперативной памяти
Для выполнения своих функций, программе «Mem.exe» достаточно 1
Мб оперативной памяти. Но, исходя из того, что для функционирования операционной системы необходимо минимум 32 Мб оперативной памяти, то рекомендуется использовать программу «Mem.exe» на ПК, имеющем ОЗУ более 32 Мб.
1.3.2. Требования к составу периферийных устройств
Особых требований к составу периферийных устройств, программа
«Mem.exe» не предъявляет.
1.3.3. Требования к параметрам периферийных устройств
Никаких требований к параметрам периферийных устройств, программа «Mem.exe» не предъявляет.
1.3.4. Требования к программному обеспечению
Системные программные средства, используемые программой
Mem.exe, должны быть представлены локализованной версией операционной системы Windows 98 или Windows Me.
Программа «Mem.ехе» не предназначена для самостоятельной очистки и дефрагментации оперативной памяти, она только вызывает программу
«FreeMemory», поэтому для ее функционирования необходимо предустановленная в каталог «C:\Program Files\FreeMemory\» программа
FreeMemory.ехе (версии 1.7).
Программа FreeMemory должна быть установлена в каталог C:\Program
Files\FreeMemory\. Для установки данной программы достаточно скопировать перечисленные ниже файлы в указанную папку на компьютере пользователя. Каких-либо настроек после копирования программы FreeMemory не требуется.
Список необходимых файлов программы FreeMemory:

FreeMemory.exe
3635 2бай т

FreeMemory.hlp
4696 5бай т

52

FreeMemory.cnt
813 байт

File_id.diz
629 байт

Каталог \Plugin\ Setup\ Setup.dll 12 800 байт
1.3.5. Требования к персоналу (программисту)
Программист должен иметь минимум среднее техническое образование и должен быть аттестован минимум на II квалификационную группу по электробезопасности (для работы с конторским оборудованием)
В перечень задач, выполняемых программистом, должны входить: а) задача поддержания работоспособности технических средств; б) задача поддержания работоспособности системных программных средств – операционной системы; в) задача поддержания работоспособности программы Mem.exe.
2.
2. ХАРАКТЕРИСТИКА ПРОГРАММЫ
2.1. Описание основных характеристик программы
2.1.1. Режим работы программы
Режим работы программы Mem.ехе круглосуточный непрерывный.
Также программа Mem.ехе работает в режиме «Стелс». Данный режим позволяет максимально сберечь память ПК. Программа постоянно находится в памяти ПК, но не появляется на панели задач, что позволяет экономить ресурсы компьютера. В данном режиме работы происходит постоянный мониторинг системного времени и при достижении ХХ.15.00 (в 15 минут текущего часа) производится запуск программы FreeMemory.exe.
2.1.2. Контроль правильности выполнения программы
Работоспособность программы «Mem.ехе» проверяется описанными ниже способами:
1) В 15 минут текущего часа, по системному времени ПК, с помощью любой программы, показывающей текущее значение свободной оперативной памяти (например GoolMEM), проследить за изменением размера свободной оперативной памяти. Вначале очистки, значение свободной оперативной памяти должно понизится до нуля. По окончанию очистки, размер свободной оперативной памяти должен стать больше того значения, которое было до начала очистки и дефрагментации оперативной памяти.
2) До начала проверки, переименуйте файл FreeMemory.exe, в каталоге «C:\Program Files\FreeMemory\». После этого, в 15 минут текущего часа, по системному времени ПК, программа «Mem.ехе» выдаст сообщение об ошибке, описанное в разделе 5. «Сообщения» данного программного руководства.
2.2. Описание основных особенностей программы
Программа Mem.ехе не имеет пользовательского интерфейса и не предоставляет конечному пользователю возможности настройки и изменения своих параметров.


53
3.
ОБРАЩЕНИЕ К ПРОГРАММЕ
3.1. Загрузка и запуск программы
Загрузка и запуск программы «Mem.ехе» осуществляется способами, детальные сведения о которых изложены в Руководстве пользователя операционной системы.
3.2. Выполнение программы
3.2.1. Выполнение функции проверки наличия вызываемой программы
В 15 минут текущего часа, по системному времени ПК, программа
«Mem.ехе» производит проверку наличия вызываемой программы
«FreeMemory.exe» в каталоге «C:\Program Files\FreeMemory\».
Если программа «FreeMemory.exe» в данном каталоге присутствует, то выполняется функция «3.3.2. Выполнение функции очистки и дефрагментации оперативной памяти».
В случае, если программа «FreeMemory.exe» в каталоге «C:\Program
Files\FreeMemory\» отсутствует, имеет другое наименование (имя) или не существует каталога, указанного выше, то выдается сообщение об ошибке, описанное в п. «5.1. Сообщение об ошибке» и выполнения функции п.
«3.3.2. Выполнение функции очистки и дефрагментации оперативной памяти» не происходит.
3.2.2. Выполнение функции очистки и дефрагментации оперативной
памяти
Выполнение функции очистки и дефрагментации оперативной памяти происходит после выполнения п. «3.2.1. Выполнение функции проверки наличия вызываемой программы». В этом случае программа
«Mem.ехе» производит вызов из каталога C:\Program Files\FreeMemory\ программы стороннего разработчика FreeMemory.exe с параметрами командной строки «С А» (С – очистка памяти, А - очистить всю память).
При загрузке с данными параметрами программа FreeMemory производит:

Очистку и дефрагментацию оперативной памяти

Выгрузку ненужных DLL

Очистку КЭШа
3.3. Завершение работы программы
Программа «Mem.ехе» не имеет пользовательского интерфейса и не предоставляет конечному пользователю возможности стандартного завершения работы программы. Программа «Mem.ехе» может быть завершена только прямой выгрузкой из оперативной памяти ПК. Для этого необходимо выполнить следующие действия:

однократным, одновременным нажатием клавиш
«Ctrl+Alt+Delete» на клавиатуре ПК, вызвать окно «Завершение работы программы»;

в данном окне, в списке запущенных приложений (программ) выбрать программу Mem;

нажать клавишу «Enter» на клавиатуре ПК или кнопку

54
«Завершить задачу» в окне «Завершение работы программы», используя манипулятор «мышь».
4.
ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ
4.1. Организация используемой входной информации
Программа «Mem.ехе» в ходе своей работы не использует никаких входных данных.
4.2. Организация используемой выходной информации
Программа «Mem.ехе» в ходе своей работы не создает никаких выходных данных
5.
СООБЩЕНИЯ
5.1. Сообщение об ошибке
Программа «Mem.ехе» выдает сообщение об ошибке, показанное на рис. 1.
Рисунок 1. Сообщение об ошибке
ПРИЧИНА. Указанный в сообщении файл (FreeMemory.exe) не найден в каталоге C:\Program Files\FreeMemory\., или данный каталог не существует.
ДЕЙСТВИЯ ПРОГРАММЫ. Программа «Mem.ехе» не производит вызова программы FreeMemory, очистки и дефрагментации оперативной памяти не происходит.
ДЕЙСТВИЯ ПРОГРАМИСТА. Проверить по указанному пути наличие программы FreeMemory и в случае необходимости переустановить данную программу, как указано в п. «1.3.4. Требования к программному обеспечению» данного программного документа.
ЛИСТ РЕГИСТРАЦИИ ИЗМЕНЕНИЙ
Номера листов (страниц)
Всего листов
(страниц) в докум
№ документа
Входящий
№ сопрово дительного документа и дата
Подп.
Дата
Изм изменен ных заме ненных новых анулиро ванных


55
Лабораторная работа №6. составление программного документа
«Руководство оператора» в соответствии с гост 19.505-79
Цель работы: Ознакомиться с процедурой составления программного документа «Руководство оператора» в соответствии с ГОСТ 19.505-79
Основные теоретические сведения
Руководство оператора должно включать:

Назначение программы.

Условия выполнения программы.

Выполнение программы.

Сообщения оператору.
При описании назначений программы необходимо указать сведения о назначении программы и информацию, достаточную для понимания функций программы и ее эксплуатации.
Условия выполнения программы должны содержать условия, необходимые для выполнения программы: минимальный и/или максимальный состав аппаратурных и программных средств.
В разделе Выполнение программы необходимо указать после- довательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы; привести описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
При описании сообщений оператору приводят тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора: действия в случае сбоя, возможности повторного запуска программы и т.д.
Задания для выполнения
1. Составить руководство оператора в соответствии с ГОСТ 19.505-79
ЕСПД. Руководство оператора. Требования к содержанию и оформлению.
2. Оформить работу в соответствии с ГОСТ 19.106—78. При оформлении использовать MS Office или OpenOffice.org.
3. Сдать и защитить работу.
Содержание и оформление отчета по лабораторной работе
Отчѐт должен содержать:
1. Титульный лист.
2. Аннотацию.
3. Содержание.
4. Основную часть, оформленную в соответствии с ГОСТ 19.505-79 ЕСПД.

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