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

23
Лабораторная работа №3. Составление пояснительной записки к
программному продукту по стандарту (ГОСТ 19.404-79)
Цель работы: Ознакомиться с процедурой составления пояснительной записки к программному продукту по стандарту (ГОСТ 19.404-79)
Основные теоретические сведения
Согласно данному стандарту пояснительная записка должна включать следующие разделы:

Введение.

Назначение и область применения.

Технические характеристики.

Ожидаемые технико-экономические показатели.

Источники, использованные при разработке.
Введение должно содержать наименование программы и/или обозначение темы разработки, а также документы, на основе которых ведется разработка.
При описании назначения и области применения указывают назначение программы, краткую характеристику области применения программы.
В разделе Технические характеристики содержатся:

постановка задачи на разработку программы, описание при- меняемых математических методов и различных ограничений, связанных с выбранным математическим аппаратом;

описание алгоритма и/или функционирования программы с обоснованием выбора схемы алгоритма решения задачи, воз- можного взаимодействия программы с другими программами;

описание и обоснование выбора метода организации входных и выходных данных;

описание и обоснование выбора состава технических и про- граммных средств на основе проведенных расчетов и анализов, распределение носителей данных, которые использует прог- рамма.
В качестве ожидаемых технико-экономических показателей
указывают показатели, обосновывающие преимущество выбранного варианта технического решения, а также при необходимости ожидаемые оперативные показатели.
При описании источников, использованных при разработке, необходимо привести перечень научно-технических публикаций, нормативно-технических документов и других научно-технических материалов, на которые есть ссылки в основном тексте.

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

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

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

27
АННОТАЦИЯ
В данном программном документе приведена пояснительная записка к программе «Mem.ехе», предназначенной для очистки и дефрагментации оперативной памяти ПК через заданные интервалы времени.
В данном программном документе, в разделе «Введение» указано наименование программы и условное обозначение темы разработки.
В разделе «Назначение и область применения» указано назначение программы и краткая характеристика области применения программы.
В данном программном документе, в разделе «Технические характеристики» содержатся следующие подразделы:

постановка задачи на разработку программы, с описанием применяемых математических методов и описанием допущений и ограничений, связанных с выбранным математическим материалом;

описание алгоритма и функционирования программы с обоснованием выбора схемы алгоритма решения задачи и возможные взаимодействия программы с другими программами;

описание и обоснование выбора метода организации входных и выходных данных;

описание и обоснование выбора состава технических и программных средств на основании проведенных расчетов и анализов.
В разделе «Ожидаемые технико-экономические показатели» указаны технико-экономические показатели, обосновывающие выбранного варианта технического решения, а также, ожидаемые оперативные показатели.
В данном программном документе, в разделе «Источники, использованные при разработке» указан перечень научно-технических публикаций, нормативно-технических документов и других научно- технических материалов, на которые есть ссылки в основном тексте.
Оформление программного документа «Руководство оператора» произведено по требованиям ЕСПД (ГОСТ 19.101-77 1)
, ГОСТ 19.103-77 2)
,
ГОСТ 19.104-78*
3)
, ГОСТ 19.105-78*
4)
, ГОСТ 19.106-78*
5)
, ГОСТ 19.404-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.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению
7)
ГОСТ 19.604-78* ЕСПД. Правила внесения изменений в программные документы, выполненные печатным способом

28
СОДЕРЖАНИЕ
АННОТАЦИЯ ......................................................................................... 27
СОДЕРЖАНИЕ ....................................................................................... 28
1. ВВЕДЕНИЕ .......................................................................................... 29
1.1. Наименование программы ........................................................... 29
1.2. Условное обозначение темы разработки ...................................... 29
2. НАЗНАЧЕНИЕ И ОБЛАСТЬ ПРИМЕНЕНИЯ ................................... 29
2.1. Назначение программы ................................................................ 29

29
1.
ВВЕДЕНИЕ
1.1.
Наименование программы
Наименование – «Программа очистки оперативной памяти».
1.2.
Условное обозначение темы разработки
Наименование темы разработки – «Разработка программы очистки оперативной памяти».
Условное обозначение темы разработки (шифр темы) – «А.В.00001»
2.
НАЗНАЧЕНИЕ И ОБЛАСТЬ ПРИМЕНЕНИЯ
2.1.
Назначение программы
Основное назначение программы очистки оперативной памяти
«Mem.exe» - повысить производительность системы.
Данная программа позволяет поддерживать бесперебойную работу ПК длительное время, предотвращать утечки памяти, засорение оперативной памяти неиспользуемыми DLL и программами, а также в итоге предотвращать зависание ПК
2.2.
Область применения программы
Программа предназначена к применению в профильных подразделениях АСУ ТП, на объектах, для автоматизации которых используется SCADa система Genesis32.
3.
ТЕХНИЧЕСКИЕ ХАРАКТЕРИСТИКИ
3.1.
Постановка задачи на разработку программы
После многократного открытия и закрытия программ, записи в базы данных, считываний из них, а также в процессе работы SCADa-системы и
ОС оперативная память значительно фрагментируется. В итоге команды будут обрабатываться на порядок медленнее. У процессора в кэш (L1 и L2) записывается определенная часть оперативной памяти еще до того, как будет произведено обращение к этой области памяти. Когда же настает черед «прокэшированных» команд или данных, то они читаются процессором из КЭШа, что во много раз быстрее, чем обращение к оперативной памяти. Если запущенная программа и ее данные оказались фрагментированными в памяти, происходит ситуация, когда в кэш попадают совсем не те данные, которые нужны, и процессору ничего не остается, как отыскивать нужное в оперативной памяти. Подобное снижение hit rate
КЭШа (число попаданий) способно снизить производительность, независимо от объема оперативной памяти.
Многие программы, в том числе и сама ОС, загружают в память множество библиотек (DLL) и не факт, что эти библиотеки будут обязательно использоваться. Поэтому необходимо подобные DLL выгружать в своп-файл. Если они вдруг понадобятся, то незамедлительно будут загружены ОС назад.

30
Действия по оптимизации и дефрагментации оперативной памяти производят программы сторонних разработчиков, такие как «FreeMemory» и
«CoolMEM». В ходе их тестирования было установлено, что данные программы, в режиме постоянного мониторинга ОЗУ и очистке памяти при превышении заданных пределов, значительно загружают операционную систему и в некоторых случаях, приводят к зависанию ПК. В ходе изысканий было установлено, что при использовании программы
«FreeMemory» (версии 1.7), при запуске еѐ командной строкой с параметрами «С А» (С – очистка памяти, А - очистить всю память), после выполнения всех процедур по очистке и дефрагментации ОЗУ, данная программа полностью выгружается из памяти компьютера. При этом зависаний ПК не происходит и не используются лишние ресурсы компьютера. Используя эти данные, была разработана программа «Mem.exe», которая каждый час, командной строкой с параметрами «С А» загружает программу «FreeMemory», для очистки ОЗУ.
Программа «Mem.ехе» работает под управлением ОС Windows 98 или
Windows Me.
3.2.
Описание алгоритма и функционирования программы
3.2.1. Описание алгоритма программы
Описание алгоритма программы приведено в п. «Алгоритм программы» программного документа «Описание применения».
3.2.2. Описание функционирования программы
Основной функцией программы «Mem.exe» является вызов из каталога C:\Program Files\FreeMemory\ программы стороннего разработчика
FreeMemory.exe с параметрами командной строки «С А» (С – очистка памяти, А - очистить всю память). Вызов программы производится по таймеру, каждый час, в ХХ.15.00 (в 15 минут каждого часа). Дополнительно программа Mem.exe проверяет наличие по указанному пути (C:\Program
Files\FreeMemory\) исполняемого модуля программы FreeMemory.exe, в случае его отсутствия, выдается сообщение «Файл FreeMemory.exe не найден, переустановите программу».
Основная задача вызываемой программы FreeMemory - повысить производительность системы.
Программа FreeMemory реализует следующие функции:

Очистка и дефрагментация оперативной памяти

Выгрузка ненужных DLL

Очистка КЭШа
Данные функции программы FreeMemory позволяют поддерживать бесперебойную работу ПК длительное время, предотвращать утечки памяти, засорение оперативной памяти неиспользуемыми DLL и программами, а также в итоге предотвращать зависание ПК

31
3.2.3. Возможные взаимодействия программы с другими программами
Программа «Mem.ехе» не предназначена для самостоятельной очистки и дефрагментации оперативной памяти, она только вызывает программу
«FreeMemory», поэтому для ее функционирования необходимо предустановленная в каталог «C:\Program Files\FreeMemory\» программа
FreeMemory.ехе (версии 1.7).
Программа FreeMemory должна быть установлена в каталог C:\Program
Files\FreeMemory\. Для установки данной программы достаточно скопировать перечисленные ниже файлы в указанную папку на компьютере пользователя. Каких-либо настроек после копирования программы FreeMemory не требуется.
Список необходимых файлов программы FreeMemory:

FreeMemory.exe
3635 2бай т

FreeMemory.hlp
4696 5бай т

FreeMemory.cnt
813 байт

File_id.diz
629 байт

Каталог \Plugin\ Setup\ Setup.dll 12 800 байт
3.3.
Описание и обоснование выбора метода организации входных и
выходных данных
3.3.1. Описание и обоснование выбора метода организации входных
данных
Программа «Mem.ехе» в ходе своей работы не использует никаких входных данных.
3.3.2. Описание и обоснование выбора метода организации выходных
данных
Программа «Mem.ехе» в ходе своей работы не создает никаких выходных данных.
3.4.
Описание и обоснование выбора состава технических средств
Программа «Mem.ехе» обладает низкими требованиями к аппаратной части ПК. Для непосредственной работы данной программы достаточно 1 Мб ОЗУ и дискового пространства. Но, исходя из выполняемых функций программой «Mem.ехе» необходимо более 100 Мб свободного дискового пространства, для сброса содержимого ОЗУ в файл подкачки.
Исходя из низких требований программы к аппаратной части ПК, можно заключить, что данная программа будет работать на любом современном компьютере.
3.5.
Описание и обоснование выбора состава программных средств
Программа очистки оперативной памяти «Mem.ехе» предназначена для работы под управлением операционной системы Windows 98 или