Приложение Р. титульный лист для документированного приложения

Приложение А. требования к оформлению пояснительной записки

Текст пояснительной записки (ПЗ) КП оформляется в соответствии со стандартом БрГТУ [1]. Основные поло­жения следующие:

1. Структура пояснительной записки. Пояснительная записка к КП включает сле­дующие компо­ненты:

§ титульный лист пояснительной записки;

§ бланк задания на КП;

§ описание объекта автоматизации (исходные данные для КП).

§ содержание пояснительной записки КП;

§ текст пояснительной записки КП;

§ приложения к пояснительной записке КП.

Примерное типовое содержание пояснительной записки КП следующее:

 

Введение

1. стадия «разработка АРМ»

1.1. Описание исходных данных на создание АРМ

1.2. Формулирование требований на создание АРМ

2. стадия «реализация АРМ»

3. ПРОЦЕССЫ «реализация ИНФОРМАЦИОННОГО ЭЛЕМЕНТА АРМ»

3.1. Методика разработки и реализации БД

3.2. Разработка словаря данных

3.3. Разработка концептуальной модели БД

3.4. Разработка логической модели БД

3.5. Выбор средств реализации БД

3.6. Создание, загрузка и проверка БД

4. ПРОЦЕССЫ «реализация ПРОГРАММНОГО ЭЛЕМЕНТА АРМ»

4.1. Методика разработки и реализации программы

4.2. Выбор средств для реализации программы

4.3. Схема системного меню пользовательского интерфейса

4.4. Описание обобщенной объектной структуры программы

5. ПРОЦЕССЫ «интеграция и испытание АРМ»

5.1. Результаты интеграции элементов АРМ

5.2. Описание и анализ результатов испытания АРМ

Заключение

 

Список использованных источников

Список сокращений

 

ПриложениЯ:

А. техническое задание

Б. Макеты выходных и входных документов

В. Спецификация на АРМ

Г. Общее описание АРМ

Д. Описание применения АРМ

Е. иНСТРУКТЦИЯ ПО УСТАНОВКЕ И ПРОВЕРКЕ АРМ

К. ПРОГРАММА И МЕТОДИКА ИСПЫТАНИЙ АРМ

Л. массив данных для загрузки

М. инструкция по загрузке массива данных

н. текст ПРОГРАММЫ структуры База данных

о. текст программы АРМ

 

Разделы и подразделы.

§ Раздел состоит из подразделов и т.д. Новый раздел начинается с новой стра­ницы, с аб­зац­ного отступа. Если заголовок раздела/подраздела не помещается на одну строку, то он продолжается на следующей строке. Начало второй строки совпадает с началом первой буквы первой строки. На­звания разделов пишутся строчными буквами, слова в названии разделов не пе­реносятся. Номер раздела отделяется от названия раздела пробелом (точка не ставится). Заголовок подраздела содержит номер раздела, точку, номер подраз­дела, пробел. Начинается заголовок подраздела с прописной буквы с абзацного отступа.

§ Разделы «Введение», «Заключение», «Перечень используемых источников», «Перечень сокращений» и «ПриложениЯ» не нумеру­ются. Для остальных разделов используется сквозная нумерация, начиная с 1.

§ Расстояние между нумеруемым заголовком любого уровня и текстом – 3 межстрочных интер­вала (интервал после абзаца – 39 пт. для шрифта 13).Если между двумя заголовками текст отсутствует (например, между заголовками раздела и подраздела), то расстояние между ними 2 межстрочных интервала. Незаполненной нижняя часть листа может быть только пе­ред новым разделом. Допускается оставлять пустой нижнюю часть листа не бо­лее 3-4 см только в случае, когда следующим является заголовок под­раздела. Во всех ос­тальных случаях следует переносить текст с последующей стра­ницы и рисунок или таб­лицу располагать далее.

3. Рисунки в тексте записки. Все рисунки имеют сквозную нумерацию в рамках раздела. Ри­сунки могут располагаться в любом месте ПЗ, но обязательно после ссылки (например, «…структурная схема приведена на рисунке 3.1.» или «…(см. рисунок 3.1)»). Название разме­щается под рисунком, центрируется, точка в конце не ставится. Пример «Ри­сунок 3.1 – Схема программы», где 3 – это номер раздела, 1 – номер ри­сунка в раз­деле по по­рядку. Рисунки от­деляются от текста одной пустой строкой сверху и снизу (после подписи). Допускается выно­сить рисунок на отдельный лист и поворачивать его по часовой стрелке (в альбомной ориента­ции), чтобы верх находился около переплета. В этом случае подпись рисунка выполняется также в альбомной ориентации.

4. Таблицы в тексте записки. Таблица состоит из надписи, шапки и содержания таблицы. Надпись таблицы размещается над таблицей, центрируется, точка в конце не ставится. Пример «Таблица 3.1 – Описание сущностей», где 3 – это номер раздела, 1 – номер таблицы в разделе по порядку. Все таб­лицы имеют сквозную нумерацию в рамках раздела. Таблицы могут размещаться на нескольких страницах, в этом случае на первой странице делается обычный заголовок, а на последующих заголовок располагается по центру, но без названия (например, «Продолжение таблицы 3.1») [1]. Кроме того, в продолжении таблицы необходимо повторить шапку (названия граф). Допускается уменьшать шрифт текста в таблице, минимальное расстояние между строками таблицы – 8 мм, а также выносить таблицу на отдельный лист и поворачивать его по часовой стрелке. Не допускаются пустые графы в таблице. Если по смыслу не требуется указывать значение, то в этой графе нужно поставить прочерк. Таблицы отделяются от текста одной пустой строкой сверху (до заголовка) и снизу. На рисунки и таблицы, которые приведены в записке, ссылки обязательны.

5. Текст записки. Шрифт текста – Times New Roman, размер – 13, межстрочный ин­тер­вал – 1,2, аб­зацный отступ – 1,5. Текст в таблицах: шрифт текста – Arial Narrow, размер – 10, меж­строчный ин­тер­вал – 1. При использовании нумерованных и маркиро­ванных списков, а также их комби­нации в качестве маркеров следует применять тире, точку, квадрат, в качестве номера пункта списка – арабские цифры, русские и латинские символы, в качестве разделителя – точку, тире, скобку. Оформление вложенного списка должно отличаться от оформления списка верхнего уровня. Все единицы текста должны быть оформлены единообразно. Можно вклю­чать в текст ПЗ фрагменты программ, фай­лов, консольные команды и т.д. Их рекомендуется выносить на отдельные строки, отде­ляя от текста одной пустой строкой сверху и снизу. Начи­нать на строке их следует с аб­зацного отступа. Рекомендуется использовать шрифт Courier New. Ссылки на литера­туру в тексте содержит номер источника в списке использованных ис­точников в квад­ратных скобках (например, «…сжатие данных реализовано по алгоритму Лем­пеля-Зива [3].»). Запрещается применять обороты разговорной речи, техницизмы.

6. Список сокращениЙ. Раздел обязательный. Сокращения приводятся в алфавитном порядке. В списке сокращений приводятся только те сокращения, которые использованы в тексте ПЗ.

7. Список использованных источников. Раздел обязательный. Источники в данном списке следуют в порядке упоминания в тексте ПЗ. Ссылки на источники обязательны.

8. ПриложениЯ делятся на документированные (отдельные документы на АРМ или его компоненты – примерный перечень см. п.1.4, п.1.6, п.1.7) и не документиро-ванные (справочные и вспомогательные материалы – таблицы, рисунки и т.д.).

В целом, требо­вания к оформлению приложений сов­падают с требова­ниями оформ. ПЗ (см. выше), отличия сле­дующие:

§ Текст приложения располагается непрерывно (правило начало отдельного раз­дела с но­вого листа не используется).

§ Нумерация приложений – прописные буквы (см.п.1.7). Нумерация рисунков и таб­лиц ве­дется в рамках отдельного приложения. К нумерации добавляется номер приложе­ния. Напри­мер, «Рисунок А.1 – Макет документа ДДДД» - где, А – номер приложения, 1 – но­мер ри­сунка в приложении. Аналогичным образом нумеруются таблицы прило­жения.

Документированные приложения. Этот раздел имеет следующую структуру:

§ Титульный лист.

§ Аннотация документа (при необходимости).

§ Содержание (при необходимости).

§ Основные разделы (текст приложения).

Первым листом документированного приложения является титульный лист (макет приве­ден в приложении Р), отличительной особенностью которого является указание в виде верх­него колонтитула, выровненного вправо, номера приложения (например, «Приложение Б»). На титульном листе номер страницы не ста­вится. Следую­щая стра­ница (аннотация) имеет номер 2, который ставится по общим правилам в верхнем пра­вом углу.

В аннотации документа при­водится наименование, назначение и состав доку­мента.

В содержании указыва­ются разделы (подразделы и т.д.) с указанием страниц.

Не документированные приложения содержат номер, название приложения и текст при­ложения. Пример приведен в приложении С.

 

 

Приложение Р. титульный лист для документированного приложения

Пример макета титульного листа для документированного приложения ПЗ КП (при­ложение, кото­рое представляет собой отдельный документ) приведено на рис.Р.1.

	ПРИЛОЖЕНИЕ «Х» МИНИСТЕРСТВО ОБРАЗОВАНИЯ РЕСПУБЛИКИ БЕЛАРУСЬ БРЕСТСКИЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ КАФЕДРА «ИНТЕЛЛЕКТУАЛЬНЫЕ ИНФОРМАЦИОННЫЕ ТЕХНОЛОГИИ» «Название АРМ» «Вид документа» «Номер документа» Листов«количество листов» Руководитель «ФИО руководителя» Выполнил«ФИО студента» Консультант по ЕСПД«ФИО руководителя» «Год»

Рисунок Р.1 – Макет титульного листа для документированных приложений

 

Титульный лист оформляется на отдельной странице. На рис.Р.1 использованы следующие обозначения:

§ «Х» – номер приложения. Например, Приложение А.

§ «Название АРМ» – например, АРМ «Успеваемость».

§ «Вид документа» – например, Текст программы.

§ «Номер документа» – номер документа имеет следующий формат:

Поделиться:

Воспользуйтесь поиском по сайту: