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

40
Files\FreeMemory\) исполняемого модуля программы FreeMemory.exe, в случае его отсутствия, выдается сообщение «Файл FreeMemory.exe не найден, переустановите программу».
Основная задача вызываемой программы FreeMemory - повысить производительность системы.
Программа FreeMemory реализует следующие функции:

Очистка и дефрагментация оперативной памяти

Выгрузка ненужных DLL

Очистка КЭШа
Данные функции программы FreeMemory позволяют поддерживать бесперебойную работу ПК длительное время, предотвращать утечки памяти, засорение оперативной памяти неиспользуемыми DLL и программами, а также в итоге предотвращать зависание ПК.
1.3. Минимальный состав технических средств
Минимальный состав используемых технических средств:

IBM PC совместимый с процессором 80386 и выше

ОЗУ более 32 Мбайт

16 МБ видеопамяти и выше

наличие свободного места на жестком диске более 100 Мбайт.
1.4. Минимальный состав программных средств
Системные программные средства, используемые программой
Mem.exe, должны быть представлены локализованной версией операционной системы Windows 98 или Windows Me.
Также для функционирования программы Mem.exe на ПК необходимо предустановленное программное обеспечение стороннего разработчика, программа FreeMemory (версии 1.7).
1.5. Требования к персоналу (системному программисту)
Системный программист должен иметь минимум среднее техническое образование.
В перечень задач, выполняемых системным программистом, должны входить: а) задача поддержания работоспособности технических средств; б) задача установки (инсталляции) и поддержания работоспособности системных программных средств – операционной системы; в) задача установки (инсталляции) и поддержания работоспособности программы Mem.exe.
2. СТРУКТУРА ПРОГРАММЫ
2.1. Сведения о структуре программы
Программа «Mem.ехе» состоит из одной запускаемой формы.
2.2. Сведения о составных частях программы
Программа «Mem.ехе» состоит из одной запускаемой формы и не имеет составных частей.

41
2.3. Сведения о связях между составными частями программы
Программа «Mem.ехе» не имеет составных частей.
2.4. Сведения о связях с другими программами
Программа «Mem.ехе» в ходе своей работы запускает программу
«FreeMemory», поэтому для ее функционирования необходимо предустановленная в каталог «C:\Program Files\FreeMemory\» программа
FreeMemory.ехе (версии 1.7).
3. НАСТРОЙКА ПРОГРАММЫ
3.1. Настройка на состав технических средств
Программа «Mem.ехе» не требует каких либо настроек на состав технических средств.
3.2. Настройка на состав программных средств
Программа «Mem.ехе» не предназначена для самостоятельной очистки и дефрагментации оперативной памяти, она только вызывает программу
«FreeMemory», поэтому для ее функционирования необходимо предустановленная в каталог «C:\Program Files\FreeMemory\» программа
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 байт
4. ПРОВЕРКА ПРОГРАММЫ
4.1. Описание способов проверки
Работоспособность программы «Mem.ехе» проверяется описанными ниже способами:
1)
В 15 минут текущего часа, по системному времени ПК, с помощью любой программы, показывающей текущее значение свободной оперативной памяти (например GoolMEM), проследить за изменением размера свободной оперативной памяти. Вначале очистки, значение свободной оперативной памяти должно понизится до нуля. По окончанию очистки, размер свободной оперативной памяти должен стать больше того значения, которое было до начала очистки и дефрагментации оперативной памяти.
2)
До начала проверки, переименуйте файл FreeMemory.exe, в каталоге
«C:\Program Files\FreeMemory\». После этого, в 15 минут текущего часа,

42 по системному времени ПК, программа «Mem.ехе» выдаст сообщение об ошибке, описанное в разделе 5. «Сообщения системному программисту» данного программного руководства.
4.2. Методы прогона
4.2.1. Проверка работоспособности программы
1)
Проверьте наличие программы FreeMemory.exe по указаниям раздела
3.2. «Настройка на состав программных средств» данного программного руководства.
2)
При запущенной программе «Mem.ехе» запустите программу, показывающею текущее значение свободной оперативной памяти
(например GoolMEM).
3)
Запишите или запомните текущее значение свободной оперативной памяти.
4)
Дождитесь 15 и
минут текущего часа, по системному времени ПК или измените системное время так, чтобы в ближайшее время произошло срабатывание программы «Mem.ехе».
5)
В 15 минут текущего часа, по системному времени ПК начнется очистка и дефрагментация оперативной памяти. При этом значение свободной оперативной памяти должно понизится до нуля.
6)
После окончания очистки, размер свободной оперативной памяти должен стать больше того значения, которое было до начала очистки и дефрагментации оперативной памяти.
7)
Запишите разницу между значениями свободной оперативной памяти после очистки и до очистки. Это будет результат работы программы
«Mem.ехе».
8)
В случае, если вы меняли системное время, верните его первоначальное значение.
4.2.2. Проверка на сообщение об ошибке
1)
До начала проверки, переименуйте файл FreeMemory.exe, в каталоге
«C:\Program Files\FreeMemory\».
2)
При запущенной программе «Mem.ехе» дождитесь 15 и
минут текущего часа, по системному времени ПК или измените системное время так, чтобы в ближайшее время произошло срабатывание программы
«Mem.ехе».
3)
В 15 минут текущего часа, по системному времени ПК, программа
«Mem.ехе» должна выдать сообщение об ошибке, описанное в разделе
5. «Сообщения системному программисту» данного программного руководства.
4)
По окончанию проверки верните предыдущее наименование файлу
FreeMemory.exe, в соответствии с по указаниями раздела 3.2.
«Настройка на состав программных средств» данного программного руководства.

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

44
Лабораторная работа №5. Составление программного документа
«Руководство программиста» в соответствии с ГОСТ 19.504-79
Цель работы: Ознакомиться с процедурой составления программного документа «Руководство программиста» в соответствии с ГОСТ 19.504-79
Основные теоретические сведения
Руководство программиста должно содержать разделы:

Назначение и условия применения программы.

Характеристики программы.

Обращение к программе.

Входные и выходные данные.

Сообщения.
При описании назначения и условий применения программы
необходимо указать назначение и функции, выполняемые программой; условия, необходимые для выполнения программы: объем оперативной памяти, требования к составу и параметрам периферийных устройств; требования к ПО и т.д.
В разделе Характеристики программы необходимо привести опи- сание основных характеристик и особенностей программы: временных характеристик, режима работы, средств контроля правильности выполнения и самовосстанавливаемости программы и т.д.
Раздел Обращение к программе представляет собой описание процедур вызова программы (способов передачи управления и параметров данных и др.).
Раздел Входные и выходные данные должен содержать описание организации используемой входной и выходной информации и при необходимости ее кодирования.
При описании сообщений необходимо привести тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям.
Задания для выполнения
1. Составить руководство программиста в соответствии с ГОСТ 19.504-79
ЕСПД. Руководство программиста. Требования к содержанию и оформлению
2. Оформить работу в соответствии с ГОСТ 19.106—78. При оформлении использовать MS Office или OpenOffice.org.
3. Сдать и защитить работу.
Содержание и оформление отчета по лабораторной работе
Отчѐт должен содержать:
1. Титульный лист.
2. Аннотацию.

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

46
Ин в.
№ по дл
По дп ись и
да та
В
за м
. и нв.
№
Ин в.
№ ду бл
По дп ись и
да та
Пример Руководства программиста по ГОСТ 19.504-79
УТВЕРЖДАЮ
Начальник тех.отдела
_____________ Хххххх Х.Х.
―_____‖____________20__
ПРОГРАММА ОЧИСТКИ ОПЕРАТИВНОЙ ПАМЯТИ
Руководство программиста
Лист утверждения
А.В.00001-01 81 01-ЛУ
Руководитель разработки
Начальник ХХХХ
___________Хххххххх Х.Х.
―_____‖____________20___
Ответственный исполнитель
Начальник гр. РиВ АСУТП
ХХХХ
____________Ххххххх Х.Х.
―_____‖____________20___
Исполнитель
Вед. инженер ХХХХ
_____________Хххххх Х.Х.
―_____‖____________20___
2013

47
И
нв
. №
по
дл
.
П
одпи
сь
и
да
та
В
за
м
. ин
в.
№
И
нв
. №
ду
бл
.
П
одпи
сь
и
да
та
УТВЕРЖДЕНО
А.В.00001-01 81 01-ЛУ
ПРОГРАММА ОЧИСТКИ ОПЕРАТИВНОЙ ПАМЯТИ
Руководство программиста
А.В.00001-01 81 01
Листов 11 2013

48
АННОТАЦИЯ
В данном программном документе приведено руководство программиста по настройке и использованию программы «Mem.ехе», предназначенной для очистки и дефрагментации оперативной памяти ПК через заданные интервалы времени.
В данном программном документе, в разделе «Назначение и условия применения программы» указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.).
В разделе «Характеристика программы» приведено описание основных характеристик и особенностей программы (режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).
В данном программном документе, в разделе «Входные и выходные данные» приведено описание организации используемой входной и выходной информации.
В разделе «Сообщения» указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Оформление программного документа «Руководство программиста» произведено по требованиям ЕСПД (ГОСТ 19.101-77 1)
, ГОСТ 19.103-77 2)
,
ГОСТ 19.104-78*
3)
, ГОСТ 19.105-78*
4)
, ГОСТ 19.106-78*
5)
, ГОСТ 19.504-
79*
6)
, ГОСТ 19.604-78*
7)
).
1)
ГОСТ 19.101-77 ЕСПД. Виды программ и программных документов
2)
ГОСТ 19.103-77 ЕСПД. Обозначение программ и программных документов
3)
ГОСТ 19.104-78* ЕСПД. Основные надписи
4)
ГОСТ 19.105-78* ЕСПД. Общие требования к программным документам
5)
ГОСТ 19.106-78* ЕСПД. Общие требования к программным документам, выполненным печатным способом
6)
ГОСТ 19.504-79* ЕСПД. Руководство программиста. Требования к содержанию и оформлению
7)
ГОСТ 19.604-78* ЕСПД. Правила внесения изменений в программные документы, выполненные печатным способом

49
СОДЕРЖАНИЕ
АННОТАЦИЯ ........................................................................................................ 48
СОДЕРЖАНИЕ ..................................................................................................... 49 1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ .................. 50 1.1. Назначение программы ............................................................................ 50 1.2. Функции, выполняемые программой ...................................................... 50 1.3. Условия, необходимые для выполнения программы ............................ 51 1.3.1. Объем оперативной памяти ........................................................... 51 1.3.2. Требования к составу периферийных устройств ........................ 51 1.3.3. Требования к параметрам периферийных устройств ................. 51 1.3.4. Требования к программному обеспечению ................................. 51 1.3.5. Требования к персоналу (программисту) .................................... 52 2. ХАРАКТЕРИСТИКА ПРОГРАММЫ............................................................. 52 2.1. Описание основных характеристик программы .................................... 52 2.1.1. Режим работы программы ............................................................. 52 2.1.2. Контроль правильности выполнения программы ....................... 52 2.2. Описание основных особенностей программы ..................................... 52 3. ОБРАЩЕНИЕ К ПРОГРАММЕ ...................................................................... 53 3.1. Загрузка и запуск программы .................................................................. 53 3.2. Выполнение программы ........................................................................... 53 3.2.1. Выполнение функции проверки наличия вызываемой программы ...................................................................................... 53 3.2.2. Выполнение функции очистки и дефрагментации оперативной памяти .............................................................................................. 53 3.3. Завершение работы программы ............................................................... 53 4. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ .......................................................... 54 4.1. Организация используемой входной информации ................................ 54 4.2. Организация используемой выходной информации ............................. 54 5. СООБЩЕНИЯ ................................................................................................... 54 5.1. Сообщение об ошибке .............................................................................. 54
ЛИСТ РЕГИСТРАЦИИ ИЗМЕНЕНИЙ .............................................................. 54