Как составить описание программного продукта

СОСТАВЛЕНИЕ
ПРОГРАММНОГО ДОКУМЕНТА «ОПИСАНИЕ ПРОГРАММЫ» В СООТВЕТСТВИИ С ГОСТ 19.402-78

Методические указания  по выполнению лабораторных работ, практических
заданий

по ПМ. 02. Разработка,
внедрение и адаптация программного обеспечения  отраслевой направленности

для студентов
специальности 09.02.05 Прикладная информатика (по отраслям)

СОДЕРЖАНИЕ

1.       
Введение

2.       
Программное обеспечение, рекомендуемое для проведения
лабораторных работ и практических занятий

3.       
Порядок выполнения работы

4.       
Лабораторная работа №1. Составление программного документа

«Описание программы» в соответствии с ГОСТ 19.402-78

5.       
Основные правила оформления программной документации…..

6.       
Критерии оценки

7.       
Приложение

Введение Данные методические указания составлены в соответствии с
рабочей программой ФГОС СПО по ПМ. 02. Разработка, внедрение и адаптация
программного обеспечения отраслевой направленности по специальности 09.02.05       Прикладная
        информатика          (по     отраслям). Разработанные методические
рекомендации можно использовать при изучении тем «Определение требований к
программному обеспечению и исходных данных для его проектирования», «Анализ
предметной области АИС с применением систем автоматизированного
проектирования», «Разработка программного обеспечения при объектном подходе»,
«Разработка пользовательских интерфейсов», «Составление программной
документации», «Разработка ПО на основе систем управления базами данных» ПМ.
02. Разработка, внедрение и адаптация программного обеспечения отраслевой
направленности.

Создание программной документации —
важный этап, так как пользователь начинает свое знакомство с программным
продуктом именно с документации. Для чего предназначен программный продукт, как
установить программный продукт, как начать с ним работать — вот одни из первых
вопросов, на      которые          должна       отвечать     программная        документация

(Installation Guide, Getting Started). Составлением
программной документации обычно занимаются специальные люди — технические
писатели (иногда программную документацию пишут сами программисты или
аналитики). 

Умение создавать программную
документацию определяет профессиональный уровень программиста. 

Грамотно составленный (точнее,
созданный) пакет программной документации избавит вас от многих неприятностей. 

Вообще программную документацию
можно разделить по отношению к пользователю на внутреннюю и внешнюю. Внешняя —
всевозможные руководства для пользователей, техническое задание, справочники;
внутренняя документация — та, которая используется в процессе разработки
программного обеспечения и недоступна конечному пользователю (различные
внутренние стандарты, комментарии исходного текста, технологии программирования
и т.д.) .

Когда программист-разработчик
получает в той или иной форме задание на программирование, перед ним, перед
руководителем проекта и перед всей проектной группой встают вопросы:

Что должно быть сделано, кроме собственно программы?

Что и как должно быть оформлено в виде документации?

Что передавать пользователям, а что — службе
сопровождения?

Как управлять всем этим процессом?

Что должно входить в само задание на
программирование?

Основу отечественной нормативной
базы в области документирования ПС составляет комплекс стандартов Единой
системы программной документации (ЕСПД).

Программное обеспечение, рекомендуемое для проведения
лабораторных работ и практических занятий

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.     Ответить
на контрольные вопросы

Лабораторная
работа №1. Составление программного документа

«Описание
программы» в соответствии с ГОСТ 19.402-78

Цель работы: Ознакомиться с
процедурой составления программного документа «Описание программы» в
соответствии с ГОСТ 19.402-78

Основные теоретические сведения

Данный стандарт определяет состав
и требования к содержанию программного документа «Описание программы». Описание
программы включает:

—   
Общие сведения.

—   
Функциональное назначение.

—   
Описание логической структуры.

—   
Используемые технические средства.

—   
Вызов и загрузка.

—   
Входные данные.

—   
Выходные данные.

В разделе Общие сведения указывают:

—   
обозначение и наименование программы;

—   
программное обеспечение, необходимое для функционирования
программы;

—   
языки программирования, на которых написана программа.

Раздел         Функциональное          назначение
         должен       отражать          классы решаемых задач и/или назначение
программы, сведения о функциональных ограничениях на применение.

При описании логической структуры должны
быть отражены:

—   
алгоритм программы;

—   
используемые методы;

—   
структура программы с описанием функций составных частей и связей
между ними;

—   
связи программы с другими программами.

В разделе Используемые
технические средства указывают типы ЭВМ и устройств, которые
используются при работе программы.

При описании раздела Вызов и
загрузка указывают способ вызова программы с соответствующего носителя
данных и входные точки в программу.

Раздел Входные данные отражает:

—   
характер, организацию и предварительную подготовку входных
данных;

—   
формат, описание и способ кодирования входных данных.

Раздел Выходные данные отражает:

—   
характер и организацию выходных данных;

—   
формат, описание и способ кодирования выходных данных.

Задания для выполнения

Составить описание программы в
соответствии с ГОСТ 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/

Пример
Описания программы по ГОСТ 19.402-78

                                                                                                     УТВЕРЖДАЮ

              Начальник
тех.отдела            _____________ ХХХХ Х.Х.

                                                                                                     ―_____‖____________200__

ПРОГРАММА ОЧИСТКИ ОПЕРАТИВНОЙ ПАМЯТИ

Описание программы

Лист  утверждения

А.В.00001-01 13 01-ЛУ

                                                                                                       Руководитель
разработки

                                                                                                             Начальник
ХХХХ

                                                                                                     ___________ХХХХХХ
Х.Х.

                                                                                                    ―_____‖____________200__

                                                                                                    Ответственный
исполнитель

                                                                                                     Начальник
гр. РиВ АСУТП  

ХХХХ

                                                                                                     ____________ХХХХХ
Х.Х.

                                                                                                    ―_____‖____________200__

                                                                                                                 Исполнитель

                                                                                                           Вед.
инженер ХХХХ

                                                                                                        _____________ХХХХХ

Х.Х.

                                                                                                    ―_____‖____________200__

2013

УТВЕРЖДЕНО

А.В.00001-01 13 01-ЛУ

ПРОГРАММА ОЧИСТКИ
ОПЕРАТИВНОЙ ПАМЯТИ

Описание программы

А.В.00001-01 13 01

Листов 12

2013

АННОТАЦИЯ

 В данном программном документе приведено описание
программы «Mem.ехе», предназначенной для очистки оперативной памяти ПК через
заданные интервалы времени. Для функционирования данной программы необходимо
предустановленная программа FreeMemory версии 1.7. Исходным языком программы
«Mem.ехе» является Visual Basic. Среда разработки, компилятор — Microsoft
Visual Basic 6.0 (локализованная, русская версия). 

Основной функцией программы
«Mem.exe» является вызов из каталога C:Program FilesFreeMemory программы стороннего
разработчика FreeMemory.exe с параметрами командной строки «С А» (С – очистка
памяти, А — очистить всю память). Вызов программы производится по таймеру,
каждый час, в ХХ.15.00 (в 15 минут каждого часа). Дополнительно программа
Mem.exe проверяет наличие по указанному пути (C:Program FilesFreeMemory)
исполняемого модуля программы 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.40278* ^[6]), ГОСТ 19.604-78* ^[7])).

СОДЕРЖАНИЕ

Аннотация
…………………………………………………………………………………………………..
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

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 FilesFreeMemory. Для
установки данной программы достаточно скопировать перечисленные ниже файлы в
указанную папку на компьютере пользователя. Каких-либо настроек после копирования
программы 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 (локализованная, русская версия).

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 FilesFreeMemory программы стороннего
разработчика FreeMemory.exe с параметрами командной строки «С А» (С – очистка
памяти, А — очистить всю память). Вызов программы производится по таймеру,
каждый час, в ХХ.15.00 (в 15 минут каждого часа). Дополнительно программа
Mem.exe проверяет наличие по указанному пути (C:Program FilesFreeMemory)
исполняемого модуля программы FreeMemory.exe, в случае его отсутствия, выдается
сообщение «Файл FreeMemory.exe не найден, переустановите программу».

Основная задача вызываемой
программы FreeMemory — повысить производительность системы. 

Программа FreeMemory реализует следующие функции:

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

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

—   
Очистка КЭШа 

Данные функции программы
FreeMemory позволяют поддерживать бесперебойную работу ПК длительное время,
предотвращать утечки памяти, засорение оперативной памяти неиспользуемыми DLL и
программами, а также в итоге  предотвращать зависание ПК.

2.3. Сведения о функциональных ограничениях на
применение

 Программа «Mem.ехе» не предназначена для работы под
управлением ОС Windows 2000 и Windows ХР, так как эти операционные системы
имеют свои, встроенные, менеджеры памяти и программа FreeMemory неэффективна в
данных операционных системах.

 Программа «Mem.ехе» не предназначена для
самостоятельной очистки и дефрагментации оперативной памяти, она только
вызывает программу

«FreeMemory», поэтому для ее функционирования
необходимо предустановленная в каталог «C:Program FilesFreeMemory» программа

FreeMemory.ехе (версии 1.7).

 Программа «Mem.ехе» не имеет видимого графического
интерфейса и не предоставляет пользователю возможности своего выключения.

 

 

 

3.2. Используемые методы

Программа «Mem.ехе» использует следующие методы:

1.     Me.Hide
– скрытие окна «формы» на экране. Программа не отображается на экране и в
системном лотке, но видна в списке задач. 

2.     Часы(х).Enabled
– запуск и остановка таймера.

3.     Shell
– запуск внешнего приложения с параметрами командной строки, в свернутом
состоянии.

3.3.  Структура программы с
описанием функций составных частей и связи между ними

Программа «Mem.ехе» состоит из
одной запускаемой формы и не имеет других составных частей.

3.4.  Связи программы с
другими программами 

Программа «Mem.ехе» в ходе своей работы запускает
программу

«FreeMemory», поэтому для ее функционирования
необходимо предустановленная в каталог «C:Program FilesFreeMemory» программа
FreeMemory.ехе (версии 1.7).

4.    
ИСПОЛЬЗУЕМЫЕ ТЕХНИЧЕСКИЕ СРЕДСТВА          В состав
используемых технических средств входит: IBM PC совместимый с процессором 80386
и выше, ОЗУ не менее 32 Мбайт, 16 МБ видеопамяти, наличие свободного места на
жестком диске 100 Мбайт.

5. ВЫЗОВ И ЗАГРУЗКА

 Загрузка и запуск программы осуществляется способами,
детальные сведения о которых изложены в Руководстве пользователя операционной
системы.

6. ВХОДНЫЕ ДАННЫЕ

 Программа «Mem.ехе» в ходе своей работы не использует
никаких входных данных.

7. ВЫХОДНЫЕ ДАННЫЕ

 Программа «Mem.ехе» в ходе своей работы не создает
никаких выходных данных.

ЛИСТ РЕГИСТРАЦИИ ИЗМЕНЕНИЙ
Номера листов (страниц)	Всего листов (страниц) в докум	№  документа	Входящий № сопрово дительного документа и дата	Подп.	Дата
Изм	изменен ных	заме ненных	новых	анулиро ванных

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

При  оформлении  текстовых  и  графических 
материалов,  входящих  в  программную документацию  следует  придерживаться 
действующих  стандартов.  Некоторые  положения  этих стандартов приведены
ниже. 

Оформление  текстового  и 
графического  материала.  Текстовые  документы  оформляют  на листах формата
А4, причем графический матерная допускается представлять на листах формата A3.
Поля на листе определяют в соответствии с общими требованиями: левое — не менее
30, правое —  не  менее 10, верхнее — не  менее 15, а  нижнее — не  менее 20
мм.  В  текстовых  редакторах  для оформления записки параметры страницы
заказывают в зависимости от устройства печати. При ручном оформлении документов
параметры страницы выбирают из соображений удобства. 

Нумерация  всех  страниц —
сквозная.  Номер  проставляется  сверху  справа  арабской  цифрой. Страницами 
считают,  как  листы  с  текстами  и  рисунками,  так  и  листы  приложений. 
Первой страницей считается титульный лист. Номер страницы на титульном листе не
проставляют. 

Наименование  разделов  пишут 
прописными  буквами  в  середине  строки.  Расстояние  между заголовками и
текстом, а также между заголовками раздела и подразделов должно быть равно: 

—   
при выполнении документа машинописным способом — двум
интервалам;  

—   
при выполнении рукописным способом — 10 мм; 

—   
при использовании текстовых редакторов — определяется
возможностями редактора. 

Наименования  подразделов  и 
пунктов  следует  размещать  с  абзацного  отступа  и  печатать вразрядку с прописной
буквы, не подчеркивая и без точки в конце. Расстояние между последней строкой
текста предыдущего раздела и последующим заголовком при расположении их на
одной странице должно быть равно: 

—   
при выполнении документа машинописным способом — трем интервалам; 

—   
при выполнении рукописным способом — не менее 15 мм; 

—   
при использовании текстовых редакторов — определяется
возможностями редактора. 

Разделы  и  подразделы  нумеруются 
арабскими  цифрами  с  точкой.  Разделы  должны  иметь порядковые номера 1,2, и
т. д. Номер подраздела включает номер раздела и порядковый номер подраздела, 
входящего  в  данный  раздел,  разделенные  точкой.  Например: 2.1, 3.5.
Ссылки  на пункты, разделы и подразделы указывают, используя порядковый номер
раздела или пункта, например, «в разд. 4», «в п. 3.3.4». 

Текст  разделов  печатают  через
1,5-2 интервала.  При  использовании  текстовых  редакторов высота букв и цифр
должна быть не менее 1,8 мм (шрифты №11-12). 

Перечисления следует нумеровать
арабскими цифрами со скобкой, например: 2), 3) и т. д. — с абзацного  отступа. 
Допускается  выделять  перечисление  простановкой  дефиса  перед  пунктом
текста или символом, его заменяющим, в текстовых редакторах. 

Оформление рисунков, схем
алгоритмов, таблиц и формул. В соответствии с ГОСТ 2.105-79 «Общие требования к
текстовым документам» иллюстрации (графики, схемы, диаграммы) могут быть 
приведены  как  в  основном  тексте,  так  и  в  приложении.  Все  иллюстрации 
именуют рисунками.  Все  рисунки,  таблицы  и  формулы  нумеруют  арабскими 
цифрами  последовательно (сквозная  нумерация)  или  в  пределах  раздела
(относительная  нумерация).  В  приложении — в пределах приложения. 

Каждый  рисунок  должен  иметь 
подрисуночную  подпись — название,  помещаемую  под рисунком, например: 

Рис.12. Форма окна
основного меню

На все рисунки, таблицы и формулы в
записке должны быть ссылки в виде: «(рис. 12)» или «форма окна основного меню
приведена на рис. 12». 

Если позволяет место, рисунки и
таблицы должны размещаться сразу после абзаца, в котором они упоминаются в
первый раз, или как можно ближе к этому абзацу на следующих страницах. 

Если рисунок занимает более одной
страницы, на всех страницах, кроме первой, проставляется номер рисунка и слово
«Продолжение». Например: 

Рис. 12. Продолжение

Рисунки следует размещать так,
чтобы их можно было рассматривать без поворота страницы. Если такое размещение
невозможно, рисунки следует располагать так, чтобы для просмотра надо было
повернуть страницу по часовой стрелке. В этом случае верхним краем является
левый край страницы. Расположение и размеры полей сохраняются. 

Схемы алгоритмов должны быть
выполнены в соответствии со стандартом ЕСПД. Толщина сплошной линии при
вычерчивании схем алгоритмов должна составлять от 0,6… 1 ,5 мм. Надписи на
схемах должны быть выполнены чертежным шрифтом, высота букв и цифр должна быть
не менее 3,5 мм. 

Номер 
таблицы  размещают  в  правом  верхнем  углу  или  перед  заголовком  таблицы, 
если  он  есть. Заголовок, кроме первой буквы, выполняют строчными буквами. 

Ссылки на таблицы в тексте
пояснительной записки указывают в виде слова «табл.» и номера таблицы.
Например: 

Результаты тестов
приведены в табл. 4.

 Номер формулы ставится с правой
стороны страницы в крутых скобках на уровне формулы. 

                Например:  
                 z: =sin (x)+In (y);        (12)

Ссылка  на  номер  формулы  дается 
в  скобках.  Например: «расчет  значений  проводится  по формуле (12)». 

Оформление  приложений.  Каждое 
приложение  должно  начинаться  с  новой  страницы  с указанием  в  правом 
углу  слова «ПРИЛОЖЕНИЕ»  прописными  буквами  и  иметь  тематический
заголовок.  При  наличии  более  одного  приложения  все  они  нумеруются 
арабскими  цифрами:  ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т. д. Например: 

ПРИЛОЖЕНИЕ
2  

Титульный лист расчетно-пояснительной записки

Рисунки  и  таблицы,  помещаемые 
в  приложении,  нумеруют  арабскими  цифрами  в  пределах каждого приложения с
добавлением буквы «П». Например: 

Рис. П. 12 — 12-й
рисунок приложения;

Рис. П .2 — 2-й
рисунок 1 -го приложения.

Если в приложении приводится текст
программы, то каждый файл оформляют как рисунок с наименованием файла и его
назначением, например: 

Рис. П2.4. Файл menuran.pas-
программа движения курсора основного меню.

Оформление списка литературы.
Список литературы должен включать все использованные источники. Сведения о
книгах (монографиях, учебниках, пособиях, справочниках и т. д.) должны
содержать:  фамилию  и  инициалы  автора,  заглавие  книги,  место  издания,  издательство, 
год издания. При наличии трех и более авторов допускается указывать фамилию и
инициалы только первого  из  них  со  словами «и  др.».  Издательство  надо 
приводить  полностью  в  именительном падеже: допускается сокращение названия
только двух городов: Москва (М.) и Санкт-Петербург (СПб.). 

Сведения о статье из периодического
издания должны включать: фамилию и инициалы автора, наименование  статьи, 
издания (журнала),  серии (если  она  есть),  год  выпуска,  том (если  есть),
номер издания (журнала) и номера страниц, на которых помещена статья.  

При ссылке на источник из списка
литературы (особенно при обзоре аналогов) надо указывать порядковый номер по
списку литературы, заключенный в квадратные скобки; например: [5].

Критерии оценки

Устное
обоснование результатов работы (ответ на контрольные вопросы):

Устное
обоснование ответа не более 5 минут.

Оценка
«отлично»
выставляется студенту, если:

1.    
Показывает
глубокое и полное знание и понимание всего объема  программного материала;
полное понимание сущности рассматриваемых понятий, явлений и закономерностей,
теорий, взаимосвязей.

2.    
Умеет составить
полный и правильный ответ на основе изученного материала; выделять главные
положения, самостоятельно подтверждать ответ конкретными примерами, фактами;
самостоятельно и аргументировано делать анализ, обобщать, выводы. Устанавливает
межпредметные (на основе ранее приобретенных знаний) и внутрипредметные связи,
творчески применяет полученные знания в незнакомой ситуации. Последовательно,
четко, связно, обоснованно и безошибочно излагает учебный материал: дает ответ
в логической последовательности с использованием принятой терминологии; делает
собственные выводы; формирует точное определение и истолкование основных
понятий, законов, теорий, правильно и обстоятельно отвечает на дополнительные
вопросы преподавателя. Самостоятельно и рационально использует наглядные
пособия, справочные материалы, учебник, дополнительную литературу,
первоисточники; применяет систему условных обозначений при  ведении записей, 
сопровождающих ответ; использует для доказательства выводы из наблюдений и
опытов.

3.    
Самостоятельно,
уверенно и безошибочно  применяет полученные знания в решении проблем на
творческом уровне; допускает не более одного недочета, который легко исправляет
по требованию преподавателя; имеет необходимые навыки работы с программами на
ПК.

Оценка
«хорошо»
ставится, если:

1.    
Показывает знания
всего изученного программного материала. Дает полный и правильный ответ на
основе изученных теорий; допускает незначительные ошибки и недочеты при
воспроизведении изученного материала, определения понятий, неточности при
использовании научных терминов или в выводах и обобщениях из наблюдений и
опытов; материал излагает в определенной логической последовательности, при
этом допускает одну негрубую ошибку или не более двух недочетов и может их
исправить самостоятельно при требовании или при небольшой помощи 

преподавателя;
в основном усвоил учебный материал; подтверждает ответ  конкретными примерами;
правильно отвечает на дополнительные вопросы учителя.

2.    
Умеет
самостоятельно выделять главные положения в изученном материале; на основании
фактов и примеров обобщать, делать выводы, устанавливать внутрипредметные
связи.  Применяет полученные знания на практике в видоизмененной ситуации,
соблюдает основные правила культуры устной и письменной речи, использует
научные термины.

3.    
Не обладает
достаточным навыком работы со справочной литературой, учебником,
первоисточниками (правильно ориентируется, но работает медленно). Допускает
негрубые нарушения правил оформления практических работ.

Оценка «удовлетворительно» ставится, если:

1.    
Усвоил основное
содержание учебного материала, имеет пробелы в усвоении материала, не
препятствующие дальнейшему усвоению программного материала; материал излагает
несистематизированно, фрагментарно, не всегда последовательно.

2.    
Показывает
недостаточную сформированность отдельных знаний и умений; выводы и обобщения
аргументирует слабо, допускает в них ошибки.

3.    
Допустил ошибки и
неточности в использовании научной терминологии, определения понятий дал
недостаточно четкие; не использовал в качестве доказательства выводы и
обобщения из наблюдений, фактов, опытов или допустил ошибки при их изложении.

4.    
Испытывает
затруднения в применении знаний, необходимых для решения задач различных типов,
при объяснении конкретных явлений на основе теории, или в подтверждении конкретных
примеров практического применения теории.

5.    
Отвечает  неполно
на вопросы преподавателя (упуская и основное), или воспроизводит содержание
текста учебника, но недостаточно понимает отдельные положения,  имеющие важное
значение в этом тексте.

6.    
Обнаруживает
недостаточное понимание отдельных положений при воспроизведении текста учебника
(записей, первоисточников) или отвечает неполно на вопросы преподавателя,
допуская одну — две грубые ошибки.

Оценка «неудовлетворительно» ставится, если:

1.    
Не усвоил и не
раскрыл основное содержание материала; не делает выводов и обобщений.

2.    
Не знает и не
понимает значительную или основную часть программного материала в пределах
поставленных вопросов или имеет слабо сформированные и неполные знания и не
умеет применять их к решению конкретных вопросов и задач по образцу.

3.    
При ответе (на
один вопрос) допускает более двух грубых ошибок, которые не может исправить
даже при помощи преподавателя.

4.    
Не может ответить
ни на один их поставленных вопросов.

5.    
Полностью не
усвоил материал.

Практическое
обоснование результатов работы:

Оценка
«отлично»
ставится, если студент:

—      творчески планирует выполнение
работы; 

—      самостоятельно  и  полностью 
использует  знания  программного материала; 

—      правильно и аккуратно выполняет
задание; 

—      умеет  пользоваться  справочной 
литературой,  наглядными пособиями, компьютером и другими средствами. 

выполнил работу без ошибок и
недочетов.  допустил не более одного недочета Оценка «хорошо»
ставится, если студент:

—      правильно планирует выполнение работы; 

—      самостоятельно использует знания
программного материала; 

—      в основном правильно и аккуратно
выполняет задание; 

—      умеет  пользоваться  справочной 
литературой,  наглядными пособиями, компьютером и другими средствами.

—      выполнил работу полностью, но допустил
в ней:

—      не более одной негрубой ошибки и
одного недочета.

—      не более двух недочетов.

Оценка
«удовлетворительно» ставится, если студент:

—      допускает ошибки при планировании
выполнения работы; 

—      не  может  самостоятельно 
использовать  значительную  часть знаний программного материала; 

—      допускает ошибки и неаккуратно
выполняет задание; 

—      затрудняется  самостоятельно 
использовать  справочную литературу, наглядные пособия, компьютер и другие
средства.  правильно выполнил не менее половины работы или допустил:

—      не более двух грубых ошибок или не
более одной грубой и одной негрубой ошибки и одного недочета;

—      не более двух- трех негрубых ошибок
или одной негрубой ошибки и трех недочетов;

—      при отсутствии ошибок, но при наличии
четырех-пяти недочетов.

Оценка
«неудовлетворительно» ставится, если студент:

—      не может правильно спланировать
выполнение работы; 

—      не может использовать знания
программного материала; 

—      допускает грубые ошибки и неаккуратно
выполняет задание; 

—      не может самостоятельно использовать
справочную литературу, наглядные пособия, компьютер и другие средства. 

—      допустил число ошибок недочетов
превышающее норму, при которой может быть выставлена оценка «3».

—      если правильно выполнил менее половины
работы.

—      не приступил к выполнению работы.  правильно выполнил не более 10% всех
заданий.

Документ «Описание программного обеспечения»

Документ «Описание программного обеспечения»

РД 50-34.698-90. Автоматизированные системы. Требования к содержанию документов: <…>.

УКАЗАНИЯ ГОСТ:
Настоящие методические указания распространяются на автоматизированные системы (АС), используемые в различных сферах деятельности (управление, исследование, проектирование и т. п.), включая их сочетание, и устанавливают требования к содержанию документов, разрабатываемых при создании АС.

Описание программного обеспечения

1. Структура документа:
2. ВВЕДЕНИЕ
3. 1 СТРУКТУРА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
4. 2 ФУНКЦИИ ЧАСТЕЙ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
5. 3 МЕТОДЫ И СРЕДСТВА РАЗРАБОТКИ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
6. 4 ОПЕРАЦИОННАЯ СИСТЕМА
7. 5 СРЕДСТВА, РАСШИРЯЮЩИЕ ВОЗМОЖНОСТИ ОПЕРАЦИОННОЙ СИСТЕМЫ
8. 5.1 Наименование и краткая характеристика средства
9. 5.2 Руководство по настройке средства
10. 5.3 Требования по настройке средства

ВВЕДЕНИЕ

УКАЗАНИЯ ГОСТ:
Во вводной части приводят основные сведения о техническом, информационном и других видах обеспечения АС, необходимые для разработки программного обеспечения или ссылку на соответствующие документы проекта АС.
ПРИМЕР СОДЕРЖАНИЯ:
АИС «Кадры» предназначена для комплексного информационно-аналитического обеспечения процессов федерального агентства «Государственные Кадры», в части исполнения следующих процессов:
…
…
…

Сведения о техническом обеспечении АС Кадры приведены в пояснительной записке к техническому проекту (п.3.8).
Сведения об информационном обеспечении АС Кадры приведены в документе «Описание информационного обеспечения системы».

1 СТРУКТУРА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

УКАЗАНИЯ ГОСТ:
В разделе «Структура программного обеспечения» приводят перечень частей программного обеспечения с указанием их взаимосвязей и обоснованием выделения каждой из них.
ПРИМЕР СОДЕРЖАНИЯ:
Наполнение этого раздела можно взять в ТЗ, пункте «4.1.1.1 Перечень подсистем, их назначение и основные характеристики».
Содержание необходимо переписать в императиве (не «В состав АС Кадры должны входить следующие подсистемы», а «В состав АС Кадры входят следующие подсистемы»).

2 ФУНКЦИИ ЧАСТЕЙ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

УКАЗАНИЯ ГОСТ:
В разделе «Функции частей программного обеспечения» приводят назначение и описание основных функций для каждой части программного обеспечения.
ПРИМЕР СОДЕРЖАНИЯ:
Наполнение этого раздела можно взять в ТЗ, пункте «4.2 Требования к функциям (задачам), выполняемым системой».
Содержание необходимо переписать в императиве (не «Модуль должен реализовывать следующие функции», а «Модуль реализует следующие функции»).

3 МЕТОДЫ И СРЕДСТВА РАЗРАБОТКИ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

УКАЗАНИЯ ГОСТ:
В разделе «Методы и средства разработки программного обеспечения» приводят перечень методов программирования и средств разработки программного обеспечения АС с указанием частей программного обеспечения, при разработке которых следует использовать соответствующие методы и средства.
ПРИМЕР СОДЕРЖАНИЯ:
Проектирование модели предметной области АС «Кадры» выполнялось с использованием программного средства Rational Rose Enterprise Edition.
Проектирование структур баз данных АС «Кадры» выполнялось с использованием программного средства Microsoft Visio 2003 Enterprise Architect.
Создание программного обеспечения АС «Кадры» и создание установочных пакетов выполнялось с помощью среды разработки Microsoft Visual Studio 2005 Team Server.
Управление изменениями требований к АС «Кадры» выполнялось с помощью программного средства Rational Rose RequisitePro.

4 ОПЕРАЦИОННАЯ СИСТЕМА

УКАЗАНИЯ ГОСТ:
В разделе «Операционная система» указывают:

1) наименование, обозначение и краткую характеристику выбранной операционной системы и ее версии, в рамках которой будут выполнять разрабатываемые программы, с обоснованием выбора и указанием источников, где дано подробное описание выбранной версии;
2) наименование руководства, в соответствии с которым должна осуществляться генерация выбранного варианта операционной системы;
3) требования к варианту генерации выбранной версии операционной системы.

ПРИМЕР СОДЕРЖАНИЯ:
Для выделенного сервера баз данных АС «Кадры» могут быть использованы следующие операционные системы:
— Microsoft Windows 2000 Server SP4;
— Microsoft Windows 2003 Server SP2.
Предпочтительным является использование операционной системы Microsoft Windows 2003 Server SP2.
Для клиентской части программного обеспечения АС «Кадры» могут быть использованы следующие операционные системы:
— Microsoft Windows 2000 Professional SP4;
— Microsoft Windows XP Professional SP2.
Предпочтительным является использование операционной системы Microsoft Windows XP Professional SP2.

5 СРЕДСТВА, РАСШИРЯЮЩИЕ ВОЗМОЖНОСТИ ОПЕРАЦИОННОЙ СИСТЕМЫ

ПРИМЕР СОДЕРЖАНИЯ:
В состав программного обеспечения АС «Кадры» не входят средства, расширяющие возможности операционной системы.

ПРИМЕР СОДЕРЖАНИЯ:
В состав программного обеспечения АС «Кадры» входят следующие средства, расширяющие возможности операционной системы:
— Программная библиотека доступа к функциям сервера СУБД.

5.1 Наименование и краткая характеристика средства

ПРИМЕР СОДЕРЖАНИЯ:
Библиотека доступа «БДУправ 1.0».

5.2 Руководство по настройке средства

ПРИМЕР СОДЕРЖАНИЯ:
Настройка не производится.

5.3 Требования по настройке средства

ПРИМЕР СОДЕРЖАНИЯ:
Требования по настройке средства не предъявляются.