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

Государственное бюджетное образовательное учреждение среднего профессионального образования
«Старооскольский педагогический колледж»
СОСТАВЛЕНИЕ ПРОГРАММНОЙ ДОКУМЕНТАЦИИ
Методические указания
по выполнению лабораторных работ, практических заданий
по ПМ. 02. Разработка, внедрение и адаптация программного обеспечения отраслевой направленности для студентов специальности 230701 Прикладная информатика (по отраслям)
Старый Оскол – 2013

2
Методические указания составлены в соответствии с рабочей программой
ФГОС СПО по ПМ. 02. Разработка, внедрение и адаптация программного обеспечения отраслевой направленности по специальности 230701
Прикладная информатика (по отраслям)
Составитель:
Гайдаржи А.А., преподаватель информатики
ГБОУ СПО «Старооскольский педагогический колледж»
Рецензент:
Панченко Л.А., преподаватель информатики
ОГАОУ СПО «Старооскольский техникум технологии и дизайна»
Рассмотрены на заседании ПЦК естественно-математических дисциплин
Протокол №__ от «____» ___________ 201_ г.
Председатель ПЦК __________________ /роспись/

3
СОДЕРЖАНИЕ
1. Введение………………………………………………………………
4 2. Программное обеспечение, рекомендуемое для проведения лабораторных работ и практических занятий……………………
5 3. Порядок выполнения работы……………………………………….
5 4. Лабораторная работа №1. Составление программного документа
«Описание программы» в соответствии с ГОСТ 19.402-78………
6 5. Лабораторная работа №2. Составление программного документа
«Стадии разработки» в соответствии с ГОСТ 19.102-77…………
19 6. Лабораторная работа №3. Составление пояснительной записки к программному продукту по стандарту (ГОСТ 19.404-79)……….
23 7. Лабораторная работа №4. Составление программного документа
«Руководство системного программиста» в соответствии с ГОСТ
19.503-79 ………………………………………………………………
33 8. Лабораторная работа №5. Составление программного документа
«Руководство программиста» в соответствии с ГОСТ 19.504-79...
44 9. Лабораторная работа №6. Составление программного документа
«Руководство оператора» в соответствии с ГОСТ 19.505-79…….
55 10. Лабораторная работа
№7.
Составление
Руководства пользователя…………………………………………………………... 82 64 11. Основные правила оформления программной документации…..
79 12. Критерии оценки………………………..…………………………… 82 13. Приложение…………………………………………………………. 85

4
Введение
Данные методические указания составлены в соответствии с рабочей программой ФГОС СПО по ПМ. 02. Разработка, внедрение и адаптация программного обеспечения отраслевой направленности по специальности
230701
Прикладная информатика
(по отраслям).
Разработанные методические рекомендации можно использовать при изучении тем
«Определение требований к программному обеспечению и исходных данных для его проектирования», «Анализ предметной области АИС с применением систем автоматизированного проектирования», «Разработка программного обеспечения при объектном подходе», «Разработка пользовательских интерфейсов», «Составление программной документации», «Разработка ПО на основе систем управления базами данных» ПМ. 02. Разработка, внедрение и адаптация программного обеспечения отраслевой направленности.
Создание программной документации — важный этап, так как пользователь начинает свое знакомство с программным продуктом именно с документации. Для чего предназначен программный продукт, как установить программный продукт, как начать с ним работать — вот одни из первых вопросов, на которые должна отвечать программная документация
(Installation Guide, Getting Started). Составлением программной документации обычно занимаются специальные люди — технические писатели (иногда программную документацию пишут сами программисты или аналитики).
Умение создавать программную документацию определяет профессиональный уровень программиста.
Грамотно составленный (точнее, созданный) пакет программной документации избавит вас от многих неприятностей.
Вообще программную документацию можно разделить по отношению к пользователю на внутреннюю и внешнюю. Внешняя — всевозможные руководства для пользователей, техническое задание, справочники; внутренняя документация — та, которая используется в процессе разработки программного обеспечения и недоступна конечному пользователю
(различные внутренние стандарты, комментарии исходного текста, технологии программирования и т.д.) .
Когда программист-разработчик получает в той или иной форме задание на программирование, перед ним, перед руководителем проекта и перед всей проектной группой встают вопросы:
Что должно быть сделано, кроме собственно программы?
Что и как должно быть оформлено в виде документации?
Что передавать пользователям, а что — службе сопровождения?
Как управлять всем этим процессом?
Что должно входить в само задание на программирование?
Основу отечественной нормативной базы в области документирования
ПС составляет комплекс стандартов Единой системы программной документации (ЕСПД).

5
Программное обеспечение, рекомендуемое для проведения
лабораторных работ и практических занятий
1. ОС Windows XP/7 и выше или ОС Linux
2. Пакет программ MS Office или OpenOffice.org
3. Веб-браузеры (IE7 и выше, Opera 22 и выше, Google Chrome 35 и выше, и др.)
4. Графические редакторы (GIMP и др.)
5. Система PascalABC
6. Cвободная среда разработки ПО Lazarus
7. Система моделирования и анализа бизнес-процессов Ramus или другая
8. Система тестирования MyTest
Порядок выполнения работы
Порядок выполнения работы состоит в следующем:
1. Познакомиться с темой и целью лабораторной работы / практического занятия.
2. Проработать основные понятия.
3. Внимательно прочитать задание.
4. Изучить порядок выполнения работы для конкретной лабораторной работы / практического занятия.
5. Познакомиться с примерами работы.
6. Выполнить задание лабораторной работы / практического занятия
7. Написать отчет по лабораторной работе.
8. Ответить на контрольные вопросы

6
Лабораторная работа №1. Составление программного документа
«Описание программы» в соответствии с ГОСТ 19.402-78
Цель работы: Ознакомиться с процедурой составления программного документа «Описание программы» в соответствии с ГОСТ 19.402-78
Основные теоретические сведения
Данный стандарт определяет состав и требования к содержанию программного документа «Описание программы». Описание программы включает:

Общие сведения.

Функциональное назначение.

Описание логической структуры.

Используемые технические средства.

Вызов и загрузка.

Входные данные.

Выходные данные.
В разделе Общие сведения указывают:

обозначение и наименование программы;

программное обеспечение, необходимое для функционирования программы;

языки программирования, на которых написана программа.
Раздел Функциональное назначение должен отражать классы решаемых задач и/или назначение программы, сведения о функциональных ограничениях на применение.
При описании логической структуры должны быть отражены:

алгоритм программы;

используемые методы;

структура программы с описанием функций составных частей и связей между ними;

связи программы с другими программами.
В разделе Используемые технические средства указывают типы ЭВМ и устройств, которые используются при работе программы.
При описании раздела Вызов и загрузка указывают способ вызова программы с соответствующего носителя данных и входные точки в программу.
Раздел Входные данные отражает:

характер, организацию и предварительную подготовку входных данных;

формат, описание и способ кодирования входных данных.
Раздел Выходные данные отражает:

характер и организацию выходных данных;

формат, описание и способ кодирования выходных данных.

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

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

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

10
АННОТАЦИЯ
В данном программном документе приведено описание программы
«Mem.ехе», предназначенной для очистки оперативной памяти ПК через заданные интервалы времени. Для функционирования данной программы необходимо предустановленная программа FreeMemory версии 1.7.
Исходным языком программы «Mem.ехе» является Visual Basic. Среда разработки, компилятор - Microsoft Visual Basic 6.0 (локализованная, русская версия).
Основной функцией программы «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 и программами, а также в итоге предотвращать зависание ПК.
Оформление программного документа «Описание программы» произведено по требованиям ЕСПД (ГОСТ 19.101-77 1)
, ГОСТ 19.103-77 2)
,
ГОСТ 19.104-78*
3)
, ГОСТ 19.105-78*
4)
, ГОСТ 19.106-78*
5)
, ГОСТ 19.402-
78*
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.402-78* ЕСПД. Описание программы
7)
ГОСТ 19.604-78* ЕСПД. Правила внесения изменений в программные документы, выполненные печатным способом

11
СОДЕРЖАНИЕ
Аннотация ................................................................................................................. 2
Содержание ............................................................................................................... 3
1. Общие сведения ................................................................................................... 4
1.1. Обозначение и наименование программы .............................................. 4
1.2. Программное обеспечение, необходимое для функционирования
программы ................................................................................................................ 4
1.3. Языки программирования, на которых написана программа ........... 5
2. Функциональное назначение ............................................................................ 5
2.1. Классы решаемых задач ............................................................................. 5
2.2. Назначение программы .............................................................................. 6
2.3. Сведения о функциональных ограничениях на применение ............. 6
3. Описание логической структуры .................................................................... 7
3.1. Алгоритм программы ................................................................................. 7
3.2. Используемые методы ................................................................................. 10
3.3. Структура программы с описанием функций составных частей и
связи между ними .................................................................................................... 10
3.4. Связи программы с другими программами ........................................... 10
4. Используемые технические средства .............................................................. 10
5. Вызов и загрузка ................................................................................................. 11
6. Входные данные .................................................................................................. 11
7. Выходные данные ............................................................................................... 11
Лист регистрации изменений ............................................................................... 12