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

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

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

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

Пример – 1, 2, 3и т. д.

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

Пример – 1.1, 1.2, 1.3и т. д.

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

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

Пример:

1 Типы и основные характеристики

1.1

1.2 Нумерация пунктов первого раздела документа

1.3

2 Технические требования

2.1

2.2 Нумерация пунктов второго раздела документа

…

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

Пример:

3 Виды обеспечения ИС

3.1 Техническое обеспечение

3.1.1

3.1.2 Нумерация пунктов первого подраздела третьего раздела

3.1.3 документа

3.2 Математическое обеспечение

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

Пример – 1.1.1.1, 1.1.1.2, 1.1.1.3 и т. д.

После номера подпункта точку не ставят.

Разделы, подразделы должны иметь заголовки. Пункты и подпункты, как правило, заголовков не имеют.

В пояснительной записке рекомендуются не более двух уровней вложенности внутри раздела (раздел – подраздел – пункт), при этом для каждого уровня даётся заголовок. Подпункты заголовка не имеют и в содержание не выносятся.

Заголовки должны четко и кратко отражать содержание разделов, подразделов.

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

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

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

Заголовки разделов «Реферат», «Содержание», «Введение», «ЗАКЛЮЧЕНИЕ», «Список использованных источников» записываются прописными буквами, располагаются симметрично тексту (по центру) и не нумеруются.

Каждый раздел текстового документа рекомендуется начинать с нового листа (страницы). Пропуски строк внутри текста раздела не допускаются.

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

Титульный лист включают в общую нумерацию страниц отчета. Номер страницы на титульном листе не проставляют.

Иллюстрации и таблицы, расположенные на отдельных листах, включают в общую нумерацию страниц отчета. Иллюстрации и таблицы на листе формата АЗ учитывают как одну страницу.

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

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

Формулы и уравнения

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

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

Пример – Плотность каждого образца  кг/м³, вычисляют по формуле

, (3.1)

где т – масса образца, кг;

V – объем образца, м³.

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

Уравнения и формулы следует располагать в отдельной строке и выделять курсивом. Выше и ниже каждой формулы или уравнения должно быть оставлено не менее одной свободной строки.

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

Формулы, на которые есть ссылки в тексте, за исключением формул, помещаемых в приложении, рекомендуется нумеровать в пределах раздела. В этом случае номер формулы состоит из номера раздела, точки и порядкового номера формулы, например (3.1). Номер заключается в круглые скобки и ставится справа от формулы в последней (или единственной) строке, занимаемой формулой.

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

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

Номер группы формул объединённых фигурной скобкой проставляется аналогично дроби, то есть по средней линии группы.

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

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

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

При ссылке на формулу в тексте её номер ставят в том же виде, что и после формулы, например: … в формуле (3.6); … из уравнения (4.1) следует … .

Если ссылка на формулу находится внутри заключённого в круглые скобки текста, то круглые скобки лучше заменить на квадратные, например: [см. формулу (5.5)].

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

Перечисления

Внутри текста могут быть приведены перечисления (перечни, списки).

Перечисления могут состоять как из законченных, так и незаконченных фраз.

Незаконченные фразы пишутся со строчных букв и обычно обозначаются строчными буквами (за исключением ё, з, о, г, ь, и, ы, ъ) с круглой скобкой или арабскими цифрами с круглой скобкой без точки перед элементом перечня.

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

… ссылки на следующие виды объектов: 1)формулы, 2) рисунки, 3) таблицы.

Если перечень состоит из развёрнутых фраз со своими знаками препинания, то элементы перечня пишутся с новой строки и отделяются точкой с запятой. Например:

…модель может содержать четыре типа диаграмм:

1) контекстную диаграмму (в каждой модели только одна);

2) диаграммы декомпозиции;

3) диаграмму дерева узлов;

4) диаграмму «только для экспозиции».

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

… при нумерации страниц отчёта учитываются следующие правила:

1. Страницы нумеруются арабскими цифрами.

2. Титульный лист включается в общую нумерацию страниц отчёта. Номер страницы на титульном листе не ставится.

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

Вложенные перечисления оформляются, как показано в примере:

а) ___________

б) ___________

1) _____

2) _____

в) ___________

Каждое перечисление записывают с абзацного отступа.

Библиографические ссылки

Библиографическая ссылка содержит библиографические сведения о цитируемом, рассматриваемом или упоминаемом в тексте документа другом документе [4].

Объектами составления библиографической ссылки являются все виды опубликованных и неопубликованных документов на любых носителях (в том числе электронные ресурсы локального и удаленного доступа), а также составные части документов.

Ссылки на использованные источники следует приводить в квадратных скобках сразу после первого упоминания источника, например: «… система КОРВЕТ [5] предназначена …»; «… как сказано в [10] …»; «… модуль ХХХ реализует основные функции системы [12].».

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

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

В список использованных источников включают все источники, на которые есть ссылки в пояснительной записке. Список формируется в порядке появления ссылок в записке.

Библиографическое описание источника осуществляется в соответствии с ГОСТ 7.1 [5] и ГОСТ 7.82 [6].

Примеры библиографического описания:

Фрост Р., Дей Д., Ван Слайк К. Проектирование и разработка баз данных. Визуальный подход / Р. Фрост, Д. Дей, К. Ван Слайк; пер. с англ. А.Ю. Кухаренко. — М.: НТ Пресс, 2007. — 592 с.

Приемопередающее устройство: пат. 2187888 Рос. Федерация.

No 2000131736/09: эаявл. 18.12.00: опубл. 20.08.02. Бюл. Ne 23 (II ч.). 3 с.

Система стандартов безопасности труда : [сборник]. — М. : Изд-во стандартов, 2002. — 102, [1] с. : ил. ; 29 см. — (Межгосударственные стандарты). — Содерж.: 16 док.

Бегпик АГ. Обзор основных проектов зарубежных справочных служб: програм. обеспечение и технол. подходы использование Интернет-технологий в справочном обслуживании удаленных пользовате­лей: материалы семинара-тренинга. 23–24 иояб. 2004 г. I Рос. нац. б-ка. Виртуап. справ. служба. СПб.. 2004. Систем. требования: PowerPoint. URL: http://vss.nlr.ru/about/seminar.php (дата обращения: 13.03.2006).

Актуальные проблемы современной науки [Текст] : информ.-аналит. журн. / учредитель ООО «Компания «Спутник +». – 2001, июнь – . – М. : Спутник +, 2001– . – Двухмес. – ISSN 1680-2721. 2001, № 1–3..

Готовое библиографическое описание книг может быть взято с обратной стороны титульного листа книги или с карточки библиотечного каталога.

Правила использования знаков препинания в библиографическом описании и ссылке на первоисточник рассматриваются в ГОСТ 7.1 и ГОСТ 7.0.5.

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

· знак « ; » используется для выделения пунктов внутри перечислений;

· знак « : » используется для уточнения предыдущего элемента по типу Заголовок : Подзаголовок;

· знак « / » используется для выделения зоны описания ответственности, например Заголовок / сведения обо всех авторах и редакторе;

· знак « // » используется для сочетаний Составная часть // Целое, например Публикация на сайте // Сайт;

· знаки «[]» используются для выделения идентифицирующих признаков, которые явно не присутствуют в описываемом издании, но могут быть определены аналитическим путём, например [Дата создания сайта];

· знаки «()» используются в тех случаях, когда идентифицирующие признаки могут быть определены точно, например Конференция по информационным технологиям (Москва; 2007).

Использование пробелов в сочетании со знаками препинания «.», «,», «()», «[]» — по общим правилам оформления текста. Знаки « : », « ; », « / », « // » ограничиваются пробелами с двух сторон, например: V:V.

Каждая зона описания отделяется от другой сочетанием знаков «.V—V» (используется знак «длинное тире», набор см. в текстовом редакторе, например, ctrl + alt + gray- или Вставка/Специальные знаки). В списке использованных источников знак «. — » допускается заменять точкой.

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

· Фамилия и инициалы автора Название публикации [Электронный ресурс] // Название сайта : [Сайт]. [Дата публикации]. URL: http://путь до публикации (Дата обращения).

Например:

Алексей Федорчук Дистрибутивы Linux сегодня: определение и классификация [Электронный ресурс] // CITKIT[Сайт]. (Дата публикации: 18.11.2009). URL :http://citkit.ru/articles/1549/(Дата обращения: 20.11.2009).

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

Онтологии и тезаурусы: модели, инструменты, приложения [Электронный ресурс] : (Интернет-учебник) / Б.В. Добров, В.В. Иванов, Н.В. Лукашевич, В.Д. Соловьев // Интернет Университет информационных технологий [Сайт]. (Дата публикации: 05.11.2008). URL : http://www.intuit.ru/department/expert/ontoth/. Статус: бесплатный. (Дата обращения: 22.11.2009).

· Название сайта [Сайт]. [Дата создания]. URL : http://путь (Дата обращения).

Например:

Президент России [Сайт]. [2009]. URL : http://www.kremlin.ru/ (Дата обращения: 21.11.2009).

· Заголовок [Электронный ресурс] // название сайта [Сайт]. Системные требования и/или ограничения по доступности. URL : http://путь (Дата обращения).

Например:

Государственный научно-исследовательский институт информационных технологий и телекоммуникаций «Информика» [Электронный ресурс]. Системные требования: Microsoft Powerpoint.

URL : http://edu.of.ru/attach/17/16459.ppt (Дата обращения: 20.11.2009).

Ссылка может быть комплексной, то есть содержать несколько ссылок под одним номером. Например:

10. Гражданский кодекс Российской Федерации. Часть четвёртая от 18 дек. 2006 г. №230-ФЗ : принят Гос. Думой Федер. Собр, Рос. Федерации 24 нояб. 2006 г. : одобр. Советом Федерации Федер. Собр. Рос. Федерации 8 дек. 2006 г. : ввод. Федер. Законом Рос. Федерации от 18 дек. 2006 г. №231-ФЗ // Парламент. Газ. — 2006. — 21 дек. ; Рос. газ. — 2006. — 22 дек. ; Собр. законодательства Рос. Федерации. — 2006. — № 52, ч. 1, ст. 5496. — С. 14803–14949.

Все остальные варианты описания библиографических ссылок можно сформировать непосредственно по ГОСТ 7.0.5-2008.

Иллюстрации

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

Иллюстрации могут быть в компьютерном исполнении, в том числе цветные.

На все иллюстрации должны быть даны ссылки в пояснительной записке.

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

Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения, например: Рисунок А.3

Иллюстрации должны иметь наименование и могут иметь пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают ниже иллюстрации и пояснительных данных и располагают по центру следующим образом (рисунок 2.1):

Рисунок 2.1 – Схема системы

Если рисунок размещается на нескольких листах формата А4, то рекомендуется на каждом последующем листе писать, например, Рисунок 2.1 — Продолжение

На все иллюстрации должны быть даны ссылки в тексте записки. При ссылках на иллюстрации следует писать, например, «... в соответствии с рисунком 1.2 …» или «… на рисунке 2.4 …».

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

Таблицы

Таблицу располагают непосредственно после текста, в котором она упоминается, или на следующей странице. На все таблицы должны быть ссылки в тексте. Ссылка содержит слово «таблица» и её номер, например: «… приведены в таблице 1.4 …».

Нумерация таблиц выполняется в пределах раздела. Номер состоит из номера раздела и порядкового номера таблицы внутри раздела, записанного через точку. Номер таблицы в приложении состоит из обозначения приложения и порядкового номера таблицы внутри приложения, записанного через точку, например, Таблица В.2.

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

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

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

Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.

Графа № п/п в таблицу не включается.

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

Допускается помещать таблицу вдоль длинной стороны листа документа.

Допускается применять размер шрифта в таблице меньший, чем в тексте.

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

Титульный лист является первым листом пояснительной записки.

Титульный лист выполняется на листе формата А4 по форме, приведенной на рисунке 2.2.

Рисунок 2.2 — Форма титульного листа

В поле 1 заносится:

ФЕДЕРАЛЬНОЕ АГЕНТСТВО ПО ОБРАЗОВАНИЮ

Государственное образовательное учреждение высшего профессионального образования

«Ижевский государственный технический университет»

Кафедра АСОИУ

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

Пример (для дипломного проекта):

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА

к дипломному проекту

на тему «САПР мерительного инструмента»

Пример (для курсового проекта):

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА

к курсовому проекту

по курсу «Программное обеспечение САПР»

на тему «Расчет траектории движения инструмента»

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

В поле 4 заносятся личные подписи.

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

Пример:

Выполнил

студент гр. 5-78-5 С.В. Карпов

Руководитель

ст. преподаватель кафедры АСОИУ И.В. Иванов

Рецензент

доцент, к.т.н. В.Г. Петров

В поле 6 указывается город и год выпуска пояснительной записки.

Пример:

Ижевск 2010

Примеры оформления титульных листов приведены в приложениях А, Б и В.

Приложения

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

Каждое приложение начинается с новой страницы. В верхней части страницы по центру пишется слово «Приложение» и указывается его обозначение заглавной буквой русского алфавита, за исключением Ё, З, Й, О, Ч, Ь, Ы, Ъ, например, Приложение А. Допускается использование букв латинского алфавита, кроме I и O.

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

Приложение может быть обязательным или информационным, например:

Приложение Б

(обязательное)

Руководство пользователя САПР «ПРЕСС»

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

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

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