Структура текстовых документов

Структурными элементами текстового документа являются:

1) титульный лист;

2) список исполнителей;

3) реферат;

4) содержание;

5) нормативные ссылки;

6) определения;

7) обозначения и сокращения;

8) введение;

9) основная часть;

10) заключение;

11) список использованных источников;

12) приложения.

Структурные элементы приведены в порядке размещения их в текстовом документе.

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

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

На титульном листе приводятся следующие сведения:

1) наименование вышестоящей организации;

2) наименование организации-исполнителя;

3) наименование работы;

4) тема;

5) должности, ученые степени и звания, фамилии и инициалы руководителей и исполнителя;

6) место и дата составления.

Подписи и даты подписания должны быть выполнены только черными чернилами или тушью.

Элементы даты приводят арабскими цифрами на одной строке в следующей последовательности: день, месяц, год. например, дату 10 апреля 2006 г. следует оформлять 10.04.2006.

Пример оформления титульного листа дипломного проекта (работы) представлен в приложении А, курсового проекта (работы) – в приложении Б, отчета по лабораторной, практической работе, по практике и т. п. – в приложении В.

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

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

Реферат должен содержать:

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

2) перечень ключевых слов;

3) текст реферата.

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

Текст реферата должен отражать:

– объект исследования или разработки;

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

– метод или методологию проведения работы;

– результаты работы;

– основные конструктивные, технологические и технико-эксплуатационные характеристики;

– степень внедрения;

– рекомендации по внедрению или итоги внедрения;

– область применения;

– экономическую эффективность или значимость работы;

– прогнозные предположения.

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

Пример составления реферата приведен в приложении Г.

Содержание включает введение, наименование всех разделов, подразделов, пунктов (если они имеют наименование), заключение и приложения с указанием номеров страниц, с которых начинаются эти элементы. В текстовом документе объемом не более 10 страниц содержание допускается не составлять.

Структурный элемент Нормативные ссылки содержит перечень стандартов, на которые в тексте дана ссылка.

Перечень стандартов начинают со слов: «В настоящем отчете использованы ссылки на следующие стандарты».

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

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

Перечень определений начинают со слов: «В настоящем отчете применяют следующие термины с соответствующими определениями».

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

Запись обозначений и сокращений приводят в порядке упоминания их в тексте, сопровождая необходимой расшифровкой и пояснениями.

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

Допускается определения, обозначения и сокращения приводить в объединенном структурном элементе Определения, обозначения и сокращения.

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

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

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

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

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

Данные о свойствах веществ и материалов приводятся в соответствии с ГОСТ 7.54, единицы физических величин – по ГОСТ 8.417.

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

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

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

Сведения об источниках приводятся в соответствии с требованиями ГОСТ 7.1. Примеры приведены в приложении Д.

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

В приложения могут быть включены:

1) материалы, дополняющие отчет;

2) промежуточные математические доказательства, формулы и расчеты;

3) таблицы вспомогательных цифровых данных;

4) протоколы испытаний;

5) описание аппаратуры и приборов, применяемых при проведении экспериментов, измерений и испытаний;

6) заключение метрологической экспертизы;

7) инструкции, методики, описания алгоритмов и программ задач, решаемых ЭВМ и разработанных в процессе выполнения работы;

8) иллюстрации вспомогательного характера;

9) акты внедрения результатов работы и др.

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

Правила оформления приложений представлены в пп. 1.2.7.

1.2 Правила оформления текстовых документов

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

текстовые документы оформляют в соответствии с требованиями ГОСТ 7.32, ГОСТ 2.105 и ГОСТ 6.30. Страницы текста и включенные в отчет иллюстрации и таблицы должны соответствовать формату А4. Допускается представлять иллюстрации, таблицы и распечатки с ЭВМ на листах формата А3.

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

Текстовые документы выполняют одним из следующих способов:

– с применением печатающих и графических устройств вывода ЭВМ (см. пп. 1.2.13);

– в виде исключения преподаватель имеет право разрешить студенту оформить отчет по лабораторной, практической работе, отчет по практике, курсовой проект (работу) в рукописном виде.

Текст отчета следует печатать, соблюдая следующие размеры полей: правое – не менее 10 мм, верхнее, нижнее и левое – не менее 20 мм.

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

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

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

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

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

При сокращении русских слов и словосочетаний следует руководствоваться ГОСТ 7.12.