Правила оформления изображений, таблиц, списков

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

Состав записки должен быть таковым:

 

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

Содержание

1. Введение

2. Техническое задание

3. Проектирование сервиса

4. Руководство пользователя

5. Заключение

6. Список литературы

 

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

 

Техническое задание

 

Структура ТЗ:

1. Назначение сервиса, включающее полный перечень его функций (регистрация пользователя, вывод рейтинга, сортировка продуктов и т.д.).

2. Характер и структура интерфейса пользователя: эскизы страниц сервиса (т.н. скрин-шоты – screen shots), описание меню приложения и инструментальных панелей, форм ввода и т.д.

3. Технические и программные ресурсы, необходимые для разработки и эксплуатации программного продукта (веб-сервер, версия языка, версия базы данных, поддерживаемые браузеры).

 

Проектирование приложения

 

На этом этапе необходимо спроектировать сервис, а именно:

· выполнить структурно-функциональный анализ предметной области, выявить сущности и их взаимосвязи;

· спроектировать структуру базы данных, описать таблицы и поля базы данных, их назначение;

· разработать структуру сервиса на уровне файлов (скриптов, шаблонов, css, javascript), классов, функций.

 

В структурно-функциональном анализе необходимо выделить сущности, которые участвуют в процессе функционирования вашего сервиса. Например: «пользователь», «билет», «самолет», «рейс», «город». Также опишите эти сущности: «Пользователь имеет ФИО, дату рождения, логин, пароль», «Рейс имеет дату вылета, город вылета, город приземления» и т.д. Опишите характер взаимосвязи этих сущностей. Например: «Пользователь может иметь множество забронированных билетов», «Самолет может совершать множество рейсов», «Рейс может иметь 1 город вылета и 1 город приземления» и т.д.

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

Структура сервиса должна включать перечень файлов и каталогов с описанием их назначения. Если это таблица стилей – то необходимо перечислить наиболее важные элементы, которые она описывает, например «стилизация заголовка страницы (#header), стилизация пунктов списка рейтинга (.item)» и т.д. Если это javascript файл, то необходимо указать какие действия в нем совершаются, привести перечень функций и их назначения, указать используемые библиотеки. Если это php-скрипт, то необходимо указать, что он «выводит на экран», точнее за генерацию какой страницы он отвечает (если отвечает), происходит ли в нем работа с базой данных, привести перечень разработанных в нем функций или классов и т.д.

Если использован какой-либо php-framework, то описывать его файлы не нужно, но необходимо указать, что Вы его использовали.

Руководство пользователя

 

Подробное описание интерфейса приложения, последовательность действий пользователя.

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

Примеры использования приложения.

Заключение

 

Выводы о степени соответствия разработанного приложения заданию.

 

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

 

Иллюстрации имеют название, которое должно располагаться после иллюстрации и после номера иллюстрации (рисунок 3.1).

Рисунок 3.1 – Эксцентриковый зажим

 

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

Обязательно следует сделать ссылку на рисунок перед ним, например: «На рисунке 2.3 показана зависимость параметра … от величины …», далее должен следовать рисунок.

 

Название таблицы начинается со слова «Таблица», затем после пробела идет порядковый номер таблицы, знак тире и непосредственное название таблицы с большой буквы. Точку в конце названия не ставят, название таблицы не подчеркивают, не используют жирный шрифт или курсив.

Между названием таблицы и основным текстом необходимо оставлять отступ не менее 10 мм, а между названием таблицы и самой таблицей – не менее 5 мм. После таблицы перед основным текстом также должен быть оставлен отступ не менее 10 мм. Порядковый номер таблицы должен состоять из номера раздела и порядкового номера таблицы в разделе, разделенных точкой и написанных арабскими цифрами без скобок, например: «Таблица 5.4 – Значения коэффициентов податливости соединения» обозначает заголовок четвертой по порядку таблицы в пятом разделе документа.

 

Таблица 3.2 – Обеспечение размера A_D методом селективной сборки

Группа	, мм	, мм	, мм	, мм	, мм	, мм	, мм
I	0.05	+0.125	0.005	+0.0125	0.004	-0.002	0.025
II	0.05	+0.075	0.005	+0.0075	0.004	-0.006	0.025
III	0.05	+0.025	0.005	+0.0025	0.004	-0.010	0.025
Примечание – Здесь (и далее по тексту) таблица приведена условно для иллюстрации

 

Пояснения после формулы начинают со слова «где» без двоеточия, например:

, (3.1)

где M_i – математическое ожидание;

t – масса матрицы, кг;

а = 3,5 – эмпирический коэффициент;

х – управляющий временной параметр, с;

s_Z – среднеквадратическое отклонение.

Перед уравнениями и формулами необходимо делать отступы не менее 10 мм. Если уравнение не помещается в одну строку, следует переносить его после знаков равенства (=), сложения (+), вычитания (–), умножения (х), деления (: или /), причем переносимую часть начинают с повтора соответствующего математического знака.

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

 

Ссылки на внешние литературные источники в тексте работы следует указывать в виде арабских цифр, соответствующих порядковым номерам этих источников в списке использованной литературы и заключенных в квадратные скобки, например: «в работах [4–7]…».