Правила оформления программной документации
Текстовые документы оформляются на листах формата А4, графический материал допускается представлять на листах формата А3.
Поля на листе: левое – не менее 30, правое – не менее 10, верхнее – не менее 15, нижнее – не менее 20 мм.
Нумерация страниц сквозная. Номера проставляются сверху справа арабской цифрой. Первой страницей считается титульный лист, на котором номер страницы не проставляется. Страницами считаются и листы с рисунками и приложениями.
Номера разделов пишутся прописными буквами в середине строки. Расстояние между заголовком и текстом – два интервала.
Номера подразделов и пунктов начинаются с абзацного отступа, вразрядку, с прописной буквы и без точки в конце.
Расстояние между последней строкой текста предыдущего раздела и последующим заголовком при расположении их на одной странице – три интервала.
Разделы и подразделы нумеруются арабскими цифрами с точкой. Ссылки на пункты, разделы и подразделы указываются в виде «в разд. 4», «в п. 3.3.4».
Текст разделов печатается через 1,5 интервала. Высота шрифта не менее №12.
Перечисления отображаются арабскими цифрами со скобкой, например: 2), 3) и т.д. Допускается выделять перечисления дефисом перед пунктом текста или символом, его заменяющим.
Все иллюстрации именуются рисунками. Все рисунки, таблицы и формулы нумеруются арабскими цифрами последовательно или в пределах раздела. В приложениях – в пределах приложения. Каждый рисунок имеет подпись – название снизу рисунка, например:
Рис. 23. Главное окно программного комплекса.
На все рисунки, таблицы и формулы в документе должны быть ссылки в виде: «рис. 23» или «блок- схема данного модуля приведена на рис. 31». Если позволяет место, рисунки и таблицы должны размещаться сразу за после абзаца, в котором они упоминаются в первый раз, или как можно ближе к этому абзацу на следующей странице. Если рисунок занимает более одной страницы, то на всех страницах, кроме первой, проставляется номер рисунка и слово «Продолжение». Рисунки следует размещать так, чтобы их можно было рассматривать без поворота страницы. В противном случае рисунки надо размещать так, чтобы для просмотра страницу надо было повернуть по часовой стрелке.
Схемы алгоритмов выполняются в соответствии с ЕСПД.
Номер таблицы размещается в правом верхнем углу или перед заголовком таблицы. если он есть. Ссылки на таблицы в тексте документа указываются в виде слов «табл.» и номера таблицы.
Номера формул ставятся с правой стороны в круглых скобках. Ссылка на номер формулы дается в скобках, например: «радиус окружности определяется по формуле (7)».
Каждое приложение должно начинаться с новой страницы с указанием в правом углу слова «ПРИЛОЖЕНИЕ» и меть тематический заголовок. При наличии более одного приложения все они нумеруются арабскими цифрами. Все рисунки и таблицы в приложении нумеруются арабскими цифрами в пределах каждого приложения с добавлением буквы «П», например:
Рис. П. 9
Структура пояснительной записки
В состав пояснительной записки входят:
титульный лист;
реферат;
содержание;
дерево функций проекта;
дерево модулей программной системы;
распределение функций системы по модулям;
структуры используемых данных;
видеоформы пользовательского интерфейса;
блок-схемы процедур, реализующих специфические алгоритмы обработки информации;
листинги модулей, максимально снабженные комментариями;
руководство системного программиста;
руководство пользователя;
текст справочной системы.
Титульный лист включает (рис. 1):
Шифр курсовой работы представляет собой номер кафедры, шифр специальности студента и его порядковый номер в списке группы, отделенные друг от друга точками.
Федеральное
государственное образовательное
учреждение
высшего
профессионального образования
«КАЛИНИНГРАДСКИЙ
ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ»
Кафедра
систем управления и вычислительной
техники
Курсовая
работа допущена
к защите руководитель
Курсовая
работа защищена
с
оценкой …………………
руководитель
<
НАЗВАНИЕ КУРСОВОЙ РАБОТЫ>
Курсовая
работа по дисциплине “Разработка
и стандартизация программных средств
и информационных технологий”
Пояснительная
записка
<
Шифр курсовой работы >
Нормоконтроллер
Проект
выполнил
………………………
студент
гр. …………
………………………
………………………
Рис. 1
Содержание включает наименование всех разделов и подразделов, пунктов, списка литературы и приложений с указанием номеров страниц. Аннотация и содержание в оглавлении не указываются. Подразделы и пункты указываются с отступами вправо.
Таблица 1
№ |
ФИО |
Тема |
1 |
|
«Антивирус». Программа запоминает содержимое указанной папки и длину файлов. При запуске она определяет появление новых файлов в данной папке, удаление существовавших и изменение размера у исполняемых файлов. Выводится информация об изменениях |
2 |
|
Планирование разработки информационной системы на основе сетевого графика "дуга-работа" |
3 |
|
«Обработка результатов экспертного опроса» при разработке программных систем |
4 |
|
«Обработка орграфа». Ввод орграфа из 5-10 вершин. Определение кратчайшего пути между двумя вершинами, отображение его на рисунке |
5 |
|
Информационная система «Сессия». Программа содержит ФИО студентов одной группы, сведения об итогах сдачи экзаменов и зачетов. Возможен просмотр общего списка группы, просмотр конкретного студента с его статистическими данными, расчет итоговых сведений по все группе, вывод задолжников, отличников и т.п. |
6 |
|
«Планирование разработки информационной системы» на основе сетевого графика "узел-работа" |
7 |
|
«Графический редактор» с возможность выбора инструмента (карандаш, линия, окружность), цвета (не менее 16 цветов) и толщины линии (не менее 5 вариантов). Созданный рисунок можно сохранить. |
8 |
|
Информационная система «Футбольный чемпионат». Список команд, занесение результатов встреч, отображение информации по каждой команде и итоговой таблицы |
9 |
|
«Расчет оптимальной топологии ЛВС» на основе ближайшей свободной вершины |
10 |
|
Информационная система «Приемная комиссия». Занесение количества поданных заявление каждый день по каждой специальности, отображение конкурса по конкретной специальности и таблицы конкурса на конкретную дату. |
11 |
|
«Обработка результатов экспертного опроса» при разработке программных систем с учетом значимости экспертов |
12 |
|
«Расчет оптимальной топологии ЛВС» методом "ветвей и границ" |
13 |
|
«Учебный график». Занесение и отображение графика учебных занятий на неделю. Автоматически подсчитывается и отображается общее число учебных и лекционных часов, время лабораторных и практических занятий. Отображение в двух режимах: общее с указание пар, предметов и аудиторий, - по дням, с указание преподавателей. ФИО преподавателей, название предметов и виды занятий берутся из фиксированных списков, которые могут редактироваться |
14 |
|
«Построитель графиков». На окне определенного размера строятся графики по введенным данным. Количество рядов от 1 до 5. Количество точек от 5 до 15. Цвет линии и ее тип предварительно выбирается из фиксированных наборов. Возможность ввода оглавления осей и названия всей диаграммы. Созданный график можно сохранить в виде графического файла. |
15 |
|
«Построитель круговых диаграмм». На окне определенного размера строится по введенным данным и названиям сегментов круговая диаграмма. Количество значений от 5 до 10. Для них задаются абсолютные значения, а программа определяет количество процентов. На диаграмме указываются названия сегментов. Созданная диаграмма может сохраняться в виде графического файла. Возможно выделение отдельного сегмента. |
17 |
. |
«Электронная картотека библиотеки». Возможность описания двух видов читателей: преподавателей и студентов. Отдельный каталог книг. Ведение списка взятой литературы по каждому читателю. Возможность просмотра, модификации и удаления информации с подтверждением |
18 |
|
«Информационная система «Соревнования по фигурному катанию». Картотека участников с фотографиями. Оценки за выступления с указанием итогового места. Просмотр сквозной с указанием итоговых показателей и по парам - с подробным отображением данных. Возможность редактирования картотеки |
19 |
|
Информационная система «Товарный магазин»: Список товаров с возможностью редактирования. Каждый день создается новая запись по каждому товару при его первой покупке. При дальнейших покупках в этот день увеличивается счетчик продаж. Возможность просмотра продаж по дням и по товарам с итоговыми показателями |
20 |
|
«Диспетчерская». Для 10 аудиторий создается расписание занятий с возможностью редактирования. Просмотр занятий по каждой аудитории и по каждой паре. В последнем случае графически отображается план этажа с указанием аудиторий и занятий в них |
21 |
|
«Расчет оплаты жилкомуслуг» (Список ответственных жильцов с возможностью редактирования: адрес, площадь, количество жильцов, льготы (30% на одного, 50% на одного, 50% на всю семью), показания электросчетчика в предыдущем месяце. Справочник тарифов с возможностью редактирования. Расчет стоимости ведется с предварительным вводом показания электросчетчика в текущем месяце. Просмотр сквозной жильцов с общей суммой оплаты или конкретного жильца с расшифровкой оплаты по каждому виду). |
22 |
|
«Решение задачи коммивояжера" методом "ближайшей свободной" с графической иллюстрацией |
23 |
|
«Информационная система туристической фирмы» с хранением информации о сотрудниках, туристических маршрутах и проведенных поездках за текущий год |
24 |
|
«Информационная система заказов авиабилетов»: просмотр информации о рейсах, местах, заказ билетов |
25 |
|
«Справочная система по помещениям вуза». Для каждого помещения указывается план и размеры. Для учебных аудиторий – количество мест, для лабораторий – назначение и принадлежность к кафедре. Для служебных помещений – целевое назначение |
26 |
|
«Система продажи билетов в драмтеатре» с планом зрительного зала (градация по ценам билетов) и индикацией проданных мест. Продажа учитывает даты спектаклей. |
27 |
|
«Справочная система занятости лабораторий кафедры»: план кафедры для каждой пары занятий и расписание занятий на день по каждой лаборатории. |
28 |
|
«Система тестирования» по определенному предмету. Десять вопросов выбираются случайным образом и не повторяются. В ответе надо выбрать из четырех один или несколько правильных ответов. Выводится итоговая оценка по тесту. |
29 |
|
«Система продажи билетов на междугородние автобусные рейсы» с планами автобусов и индикацией проданных мест |
30 |
|
Система тестирования сочетаемости цветов: тестируемое поле занимает 2/3 экрана. Исходно задается цвет фона и цвет текста. Случайным образом задается место вывода и выводимый текст (слово из 5 символов). Испытуемый должен повторить текст. Время между выводом на экран и концом ввода фиксируется. Задается количество повторений теста. Определяется среднее время задержки |
31 |
|
Электронный календарь: на экране отображается определенный месяц. При щелчке по определенной дате раскрывается список дел на этот день с указанием времени. Список можно просматривать, дополнять, корректировать. |
32 |
|
Информационная система «Сессия»: информация о сессии по группам и преподавателям. Один и тот же преподаватель не может принимать два и более экзаменов в один и тот же день. Между экзаменами у группы должно быть не менее 3 дней |
33 |
|
Игра «Биржа». Моделируется изменение цены акций у 20 фирм. У некоторых фирм стоимость акций меняется случайным образом в диапазоне 10% текущего значения. У других фирм наблюдается тренд по увеличению или уменьшению стоимости. Один шаг – один день. Исходно у игрока сумма в 10000 рублей. Игрок стремится увеличить сумму за определенный период |
34 |
|
Тренажер отработки реакции. Сверху нажатием клавиши «пробел» запускается падающий шарик. Надо щелкнуть мышью в момент совмещения шарика с линией. Скорость падения шарика может задаваться, а место его появления может генерируется случайным образом. Линия тоже двигается. Возможны два варианта: движение снизу и сверху. В первом случае также задается скорость перемещения линии, во втором – скорость перемещения линии в два раза меньше заданной скорости перемещения шарика, а начальное положение линии находится на 2/3 высоты экрана. Замеряется и выводится расстояние между линией и центром шарика в момент щелчка. Также рассчитывается среднее значение этой величины по серии экспериментов. Возможно задание теста из 10 попыток. |
35 |
|
Интерпретатор арифметических выражений на 10 переменных. Выражение может включать круглые скобки и пять арифметических операций |
36 |
|
Тренажер отработки реакции. На тестовом поле в случайном месте появляется окружность. Необходимо щелкнуть мышью по окружности. Время отображения окружности и ее диаметр регулируются. Учитывается количество попаданий мыши по окружности за определенное время. |
37 |
|
Игра «морской бой»с компьютером |
38 |
|
Игра в «крестики-нолики». Для двух участников. Поле размером 30х30. Компьютер определяет наличие пяти одинаковых символов в линию |
39 |
|
Визуализация охранной системы: три кольца защиты, во внутреннем кольце только одна дверь, в среднем две, во внешнем три. Каждая дверь открывается только при закрытых остальных. В праздничные и выходные дни для службы безопасности открываются только двери внешнего кольца |
40 |
|
Электронное табло: вводится текст, который в дальнейшем непрерывно отображается с различными видеоэффектами (движение по кольцу, двунаправленное движение, увеличение размера текста и т.п., не менее 10). Возможность совмещения видеоэффектов и/или программирование последовательности |
41 |
|
«Фауна области». Карта области и перечень диких зверей. Выбор животного приводит к показу ареала его обитания. При выборе точки указываются животные, указываются обитающие в данной местности животные. |
42 |
|
Игра «Ханойская башня» |
43 |
|
Визуальная иллюстрация сортировки перестановкой. Количество элементов массива в диапазоне 8 15. |
44 |
|
Визуальная иллюстрация сортировки методом «пузырька». Количество элементов массива в диапазоне 8 15. |