Требования к построению текстового документа

Введение

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

- изучение отдельных разделов и вопросов учебного курса;

- подготовка к защите практических и лабораторных работ;

- написание рефератов;

- написание контрольных работ (для студентов заочной формы обучения);

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

- подготовка к зачетам и экзаменам;

- выполнение выпускных квалификационных работ.

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

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

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

Общие требования

Отчеты по лабораторным и практическим работам выполняются студентами в тетрадях и должны иметь следующую структуру:

- титульный лист;

- цель работы;

- перечень используемого оборудования и материалов;

- порядок выполнения работы;

- методика и описание проводимой работы;

- результаты работы и их обсуждение;

- вывод по работе;

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

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

Общая структура текстового документа:

- титульный лист;

- реферат или аннотация;

- содержание;

- введение;

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

- заключение;

- список литературы;

- приложения.

Текстовые документы (ТД) выполняются на одной стороне листа формата А4 (210х297 мм). Поля сверху и снизу 25 мм, слева – 30 мм, справа 10 мм. Машинный текст выполняется только черным цветом, шрифт «Times New Roman», интервал между строками – 1,5, размер шрифта – 14. Допускается уменьшать размер шрифта в таблицах и рисунках для удобства представления информации. Нумерация страниц – сквозная, в правом нижнем углу страницы. Для нумерации страниц применяют только арабские цифры.

 

Требования к построению текстового документа

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

Титульный лист является первым листом ТД. Примеры оформления титульных листов приведены в приложении А.

2.2 Содержание

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

Слово «Содержание» записывается в середине строки.

2.3 Наименование текстового документа

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

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

2.4 Введение

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

Слово «Введение» записывается в середине строки.

2.5 Реферат и аннотация

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

Аннотация – краткая характеристика ТД с точки зрения его назначения, содержания, вида, формы и других особенностей. Выполняется согласно требованиям ГОСТ 7.9.

Реферат и аннотация дают возможность установить основное содержание документа и используются в информационных системах для поиска документов и информации. Рекомендуемый объем реферата – 850 печатных знаков; аннотации – 500 печатных знаков.

2.6 Определения

Раздел включают в текстовый документ при необходимости. Он содержит определения, необходимые для уточнения или установления терминов, используемых в ТД, и начинается словами: «В настоящем документе применяют следующие термины».

2.7 Обозначения и сокращения

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

Допускается объединение разделов 2.6 и 2.7.

2.8 Основной текст документа

2.8.1 Требования к тексту документа

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

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

Примеры:

1 Провести исследования пяти образцов массой 500 г.

2 Отобрать 15 образцов для исследований.

 

В текстовых документах не допускается:

- применять обороты разговорной речи;

- применять разные термины для одного и того же понятия;

- подчеркивать текст;

- применять математический знак «минус» (-) перед обозначением отрицательных величин (следует писать слово «минус») за исключением таблиц, формул, рисунков;

- применять знак Æ для обозначения диаметра (следует писать слово «диаметр») за исключением рисунков.

2.8.2 Деление текста документа

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

Пример:

1 Правила оформления отчета

1.1 Общие требования

1.1.1 …

1.1.2 …

1.2 Технические данные отчета

1.2.1 …

1.2.2 …

Если раздел состоит из одного пункта, он тоже нумеруется.

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

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

Примеры:

1) …

2) …

3) …

а) …

б) …

в) …

- …

- …

- …

2.8.4 Заголовки

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

2.8.5 Построение таблиц

Таблицы применяют для наглядности и удобства сравнения показателей. Каждая таблица должна иметь номер и название, отражающее ее содержание. Знак «№» при этом не ставится. Название помещают над таблицей.

 

Пример:

Таблица ___ – _______________________

^{номер наименование таблицы}

Головка				Заголовки граф
					Подзаголовки
						Строки

Боковик Графы (колонки)

(графа для

заголовков)

 

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

Пример:

1) Данные отражены в таблице 1.

2) Рассмотрим следующие данные (таблица 1).

 

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

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

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

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

Примеры:

1) Таблица 1 – Химический состав хлеба

 

Наименование продукта	Содержание основных питательных веществ, %
Белки	Жиры	Углеводы
1 Хлеб «Дарницкий»
2 Хлеб «Пшеничный»

 

Продолжение таблицы 1.

Наименование продукта	Содержание основных питательных веществ, %
Белки	Жиры	Углеводы
3 Хлеб «Бородинский»
4 Хлеб «Алтайский»

2) Таблица 1 – Химический состав хлеба

 

Наименование продукта	Содержание основных питательных веществ, %
Белки	Жиры	Углеводы
1 Хлеб «Дарницкий»*
2 Хлеб «Пшеничный»

 

Продолжение таблицы 1.

 

3 Хлеб «Бородинский»
4 Хлеб «Алтайский»**
*............... **..................

 

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

Пример:

Таблица …

 

Наименование продукта	Содержание сухого вещества, %		Наименование продукта	Содержание сухого вещества, %

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

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

При отсутствии отдельных данных в таблице следует ставить прочерк (тире).

При наличии в документе небольшого по объему цифрового материала его желательно давать не таблицей, а текстом, располагая цифровые данные в виде колонок, например:

Содержание жира в исследуемых продуктах, %:

Молоко цельное …………………………3,60

Молоко обезжиренное …………………..0,05

Сливки …………………………………..10,00

2.8.6 Сноски

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

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

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

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

 

Пример:

В пищевой промышленности гвоздику используют при производстве колбасных и хлебобулочных изделий [15, 21].

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

2.8.8 Сокращения

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

- с. – страница;

- г. – год;

- гг. – годы;

- т.е. – то есть;

- т.д. – так далее;

- и др. – и другие;

- пр. – прочие;

- см. – смотри.

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

2.8.9 Графический материал

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

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

Пример:

 

1 – корпус; 2 – шибер; 3 – ящик для опилок; 4 – заслонка воздушная; 5 – дымоотвод; 6 – дверь; 7 – термометр

Рисунок 1 – Коптильный шкаф фирмы Josef Stegherr

 

Графический материал нумеруют арабскими цифрами сквозной нумерацией. Допускается нумерация графического материала в пределах одного раздела, номер раздела отделяется от порядкового номера рисунка точкой, например «Рисунок 1.2». Графический материал каждого приложения обозначают отдельной нумерацией с добавлением перед цифрой обозначения приложения, например «Рисунок В.2»

Рисунок, как правило, следует оформлять на одной странице (листе). Если рисунок не умещается на одной странице (листе), допускается переносить его на другую страницу. При этом наименование помещают на первой странице, поясняющие данные – на каждой странице, обозначается графический материал следующим образом: «Рисунок 1, лист 1. Рисунок 1, лист 2» и т.д.

2.8.10 Формулы

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

Допускается нумерация формул в пределах раздела, при этом номер раздела и порядковый номер формулы разделяют точкой, например: (3.1), (3.3).

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

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

Примеры:

1) Кислотность плазмы сливок вычисляют по формуле

(1)

где Кп – кислотность плазмы, °Т;

К_С – титруемая кислотность сливок, °Т;

Жд – жирность сливок, %.

2) Массовую долю связанной воды в мясе находят по формулам:

; (2)

, (3)

где В – массовая доля связанной влаги, % к мясу;

В₁ – массовая доля связанной влаги, % к общей влаге;

А – содержание воды в образце, мг;

8,4 – содержание воды в 1 см² влажного пятна, мг;

Б – площадь влажного пятна, см²;

М – масса образца фарша, мг.

 

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

2.8.11 Единицы физических величин

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

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

2.9 Оформление списка литературы

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

Сведения о нормативно-технической документации следует приводить в конце основного списка

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

2.10 Оформления приложения

Материал, дополняющий текст ТД, допускается помещать в приложениях. Приложения оформляют как продолжение документа на последующих его листах, как правило формата А4. В тексте ТД на приложения должны быть ссылки. Приложения располагаются в том порядке, в котором они упоминаются в тексте.

Приложения обозначаются заглавными буквами русского алфавита, начиная с А (за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ). Допускается обозначение приложений буквами латинского алфавита, за исключением букв I, О.

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

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

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

1. Крылова Г. Д. Основы стандартизации, сертификации, метрологии. – М.: ЮНИТИ-Дана, 1999; 2001. – 711 с.

2. ГОСТ7.1-84 СИБИД. Библиографическое описание документа. Общие требования и правила составления. – М.: Издательство стандартов, 1984. – 76 с.

3. СТП1.701-98 УСУД. Текстовые документы. Общие требования к построению и оформлению. – Впервые. Введен в действие 30.01.99. – НовГУ, 1998. – 50 с.

Приложение А

(рекомендуемое)