Программы для ЭВМ оформляются в соответствии с требованиями Единой системы программной документации (ЕСПД) . ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов.
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.
Кратко алгоритм оформления программы и виды программных документов изображены на рисунке. Более подробно процесс оформления описан далее.
Программный документ - документ, содержащий сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ 19.101-77 , ГОСТ 19.103-77 , ГОСТ 19.104-78 , ГОСТ 19.105-78 , ГОСТ 19.106-78 , ГОСТ 19.604-78 (более подробное описание данных ГОСТов следует ниже) и ГОСТа для конкретного программного документа.
ГОСТ 19.106-78 устанавливает правила выполнения программных документов для печатного способа выполнения.
Важно отметить, что данный ГОСТ не распространяется на программный документ "Текст программы".
Материалы программного документа должны располагаться в следующей последовательности :
В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.
Форматирование текста:
В ГОСТе присутствует образец листа, где указаны поля, места для нумерации страниц и шифра.
Опираясь на ГОСТ 7.32-2001 «Отчет о научно-исследовательской работе» можно правильно оформить приложение к диплому. Мы изучили весь государственный стандарт и составили ряд правил к оформлению приложения в дипломе по госту. Дабы облегчить вам жизнь, мы систематизировали правила и выделили главное. Итак, оформление приложения в дипломе по ГОСТу.
Как же его осуществлять:
Приложение является неотъемлемой частью дипломной работы, хотя и необязательной. Согласно ГОСТ 7.32-2001 дипломная работа не обязательно должна быть наполнена приложениями. Но так требуют многие учебные заведения. Поэтому после прочтения правил оформления приложения в дипломе по госту, обязательно спросите у своего научного руководителя методические рекомендации, так как в каждом учебном заведении предъявляются свои требования.
Приложение может представлять собой не только графический материал (то есть иллюстрации, рисунки, схемы, диаграммы, графики), но и раздаточный материал. Позаботьтесь о том, чтобы весь ваш раздаточный материал был выполнен в едином стиле. Выбор формы представления дипломного материала (приложения) дипломник может определить сам. Это могут быть плакаты, ватманы формата А1 или же обычные стандартные листы формата А4. Информация в раздаточных материал должна быть представлена в виде таблиц, схем, рисунков, графиков, оформление которых выполняют согласно ГОСТ 7.32-2001.
После каждого рисунка следует надпись «Рисунок» и его порядковый номер, который проставляют арабскими цифрами. Перед каждой таблицей пишется слово «Таблица» и ставится нумерация арабскими цифрами. Некоторые учебные заведения требуют ставить надписи к рисункам или таблицам. Если ваша надпись состоит более, чем из одного предложения, то предложения между собой разделяют точкой.
Все материалы приложения систематизируют, детализируют определенные главы или выводы вашей дипломной работы. Приложения позволяют понять, как вы делали те или иные выводы, на что опирались, какой материал использовали, как смогли систематизировать полученные в ходе исследования знания. Приложения входят в научный инструментарий, использованный вами при написании дипломной работы. И государственная аттестационная комиссия обращает большое внимание на то, как вы смогли воспользоваться тем инструментом. Вы как специалист должны легко и уверенно владеть своим дипломным материалом. Это обстоятельство станет значительным для оценки диплома в целом.
Заканчивая оформление курсовой, важно не забыть о вложении приложений к работе. Зачастую они вкладываются сразу после списка литературы, то есть в самом конце. После них больше не должно быть никаких заключений, дополнений, глав курсовой и т.д. Приложения включают таблицы, документы, графики, схемы и другие подобные материалы, которые имеют солидный объем и содержат важную для курсовой информацию. Приложения могут занимать не один десяток страниц, поэтому неуместно их помещать непосредственно в тексте. Также в раздел "Приложения" выносят следующие документы:
Требования ГОСТа
Процесс оформление приложения в курсовой по госту не содержит огромного числа специфических требований, есть лишь несколько нюансов:
Приложения оформляются как продолжение курсовой студента. Обязательной является сквозная нумерация, которая объединяет приложения и основную часть работы. При этом в тексте курсовой должны присутствовать соответствующие ссылки на все приложенные дополнительные материалы. Также требуется добавлять приложения в том порядке, в каком они упоминаются в тексте работы.
Использование заголовков
Для обозначения приложений используются прописные буквы алфавита, начиная с А. Буква указывается после слова «Приложение». Если используется русский алфавит, исключаются следующие буквы: Ё, З, И, Й, О, Ч, Щ, Ъ, Ы, Ь. Если были использованы все буквы алфавита, оформление приложения в курсовой по госту допускает применение арабских цифр. Также приложения курсовой могут обозначаться прописными буквами латинского алфавита (кроме I и О). Данный тип обозначения помогает в тех случаях, когда используются иностранные источники. Если курсовая содержит лишь одно приложение, его обозначают «Приложение А».
Для каждого приложения требуется отдельная страница и никак иначе. Слово «Приложение» и его обозначение располагают в верхней части нового листа, посередине. Заголовок начинают с прописной буквы, а также его выделяют полужирным шрифтом. Страницы с приложениями обязательно включаются в общую нумерацию курсовой работы.
Если студент размещает все таблицы, графики, диаграммы исключительно в приложении, тогда нужно на странице прописывается заголовок "ПРИЛОЖЕНИЕ" и а затем размещается весь дополнительный материал в нужной последовательности. В обязательном порядке необходимо соблюдать нумерацию, а также сделать в тексте работы соответственные ссылки (табл. 1) или (рис. 1).
Также можно разбить приложения на отдельные разделы: ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т.д.. Ссылки в тексте на данные материалы будут выглядеть так: Данные эксперимента проставляются ответственным лицом на соответственных полях протокола (Приложение 2). Иногда приложения могут иметь оглавления: «Приложение 1. Пособие для проведения занятий»; «Приложение 2. Результаты опроса студентов».
Содержание приложения должно указываться в его наименовании, которое представляет из себя отдельную строку (или строки), располагающиеся симметрично относительно текста. Печатают их строчными буквами, начиная с прописной, а также выделяют полужирным шрифтом. Переносить слова в заголовках запрещается!
Текст каждого приложения можно делить на разделы, пункты, а также подразделы, если это необходимо. При этом важно соблюдать нумерацию в пределах каждого приложения (например, 5.3). Первая цифра указывает на порядковый номер приложения, а вторая на номер пункта, раздела и т.д.: Пример Г.2; Таблица В.5; Рисунок С.7.
Таблицы, формулы, документы в приложениях
Если тексте приложения имеются формулы, графические материалы, таблицы или уравнения, их необходимо пронумеровать в пределах соответственного приложения.
Если в курсовой использовано приложение типа документ (или копия документа), который имеет самостоятельное значение и оформлен должным образом, тогда его добавляют в оригинальном виде, без каких-либо изменений. Верхняя часть титульного листа данного документа должна содержать слово «Приложение», которое печатается посередине строки. Также страница должна иметь общую нумерацию с остальной частью курсовой работы.
Зачастую студенты не уделяют должного внимания приложениям, что является довольно серьезной ошибкой оформления курсовой. Данная часть работы позволяет более глубоко раскрыть изучаемую тему, а также дает возможность преподавателю понять, что студент готовился с особой тщательностью.
Что нужно знать для того, чтобы правильно оформить не только основную часть диплома, но и не забыть такие структурные элементы, как приложения?
Для чего они нужны? Как правильно оформить приложение в дипломе? Теперь обо всём этом подробнее.
Диплом, или, как ещё говорят, содержит результаты исследования, которое проводит студент - будущий специалист в определённой сфере. Предполагается, что с заданием он справляется самостоятельно. Однако на случай возникающих вопросов есть руководитель. Он может не только сориентировать по выбранной теме, но и ответить на вопрос о том, как оформить приложение в дипломе.
Заметим, что это одна из частей пояснительной записки, которая не всегда является обязательной. Дело в том, что есть ряд дисциплин или тем, который имеют преимущественно теоретический характер. Они могут не содержать в себе такой информации, которую следовало бы вынести в приложения.
Назначение их состоит в том, чтобы предоставить более полную информацию о проведённом в работе исследовании. Здесь могут содержаться различные данные, которые имеют отношение к теме. В основной части диплома их не располагают по той причине, что они могут загромождать работу. Поэтому большие таблицы или громоздкие схемы, отчётная документация или какие-либо другие материалы помещаются в конце диплома в виде отдельного раздела, который так и называется.
В дипломе есть несколько составных частей. Поскольку в наши задачи не входит их подробное рассмотрение, остановимся на них кратко.
Какого характера информация может содержаться в приложениях? Решение в этом случае студент должен принимать совместно с научным руководителем. Как правило, рекомендации по этому разделу определяет выпускающая кафедра, принимающая решение исходя из специфики своей научной деятельности.
Однако здесь следует помнить о том, что необходимо оформление приложения в дипломе по ГОСТу. Поэтому следует обратиться к изложенным в нём правилам. Для такого вида работ используется ГОСТ 7.32-2001. Здесь в пункте 5.12 есть информация о том, что приложения могут содержать те материалы, которые связаны с выполненным исследованием, но по ряду причин не включены в разделы основной части.
Пользуясь общепринятыми правилами написания диплома, заметим, что в приложения включаются материалы, выходящие за рамки предложенного формата изложения, которые позволяют лучше понять содержание работы и смысл всех действий, произведённых автором.
Как правило, сюда включают:
Здесь следует обратить внимание на то, как правильно оформить приложение в дипломе. Этому вопросу посвящён пункт 6.14 вышеупомянутого ГОСТа, который содержит ряд правил.
1. Приложение может быть оформлено как продолжение диплома. В этом случае информация располагается на последующих листах. Иногда может понадобиться отдельное издание. Для дипломной работы, как правило, бывает достаточно нескольких, но не более 10.
2. Обязательным является наличие в основной части работы ссылок на соответствующие приложения. На основе порядка упоминания их в пояснительной записке строится последовательность их расположения.
3. Каждое следующее приложение должно начинаться с новой страницы. Даже если приведённая схема или таблица занимают совсем немного места. Начинается оно со слова «Приложение», за которым следует его обозначение и название.
Далее на основе предложенных примеров можно будет лучше разобраться в том, как оформить приложение в дипломе. Перефразируя пословицу, скажем так: лучше хоть один раз увидеть, чем бесконечно слушать одно и то же.
Теперь несколько слов о тонкостях. Итак, как оформлять приложения в дипломе? По ГОСТу каждое из них имеет свой заголовок, который начинается с указания вида информации, представленной в нём. То есть если будет таблица или схема, то следует это слово, а за ним соответствующее название. Если размещаются другие материалы, то тогда с абзаца просто указывается заголовок.
Материалы приложений должны быть непосредственно связаны с положениями, изложенными в работе. Чтобы связать все воедино, необходимо знать, как оформлять ссылки на приложения в дипломе. Здесь нужно помнить следующее:
Все материалы оформляются в единой системе: слово «приложение» пишется одинаково на всех его листах. Делается это в полном соответствии с той кафедры, на которой будет защищаться диплом (Приложение А; ПРИЛОЖЕНИЕ А; ПРИЛОЖЕНИЕ 1 и т. д.). Таким же образом подаются и заголовки. Само слово «приложение» может располагаться по центру верхней строки или с правой стороны. Точка после него не ставится.
Несколько слов про расположение и обозначение этих элементов. Известно, что в ряде случаев без них обойтись невозможно.
Итак, если необходимо предоставить статистические данные, а таблица большая, то мы уже знаем, где следует её размещать. Поскольку уже есть некоторое представление о том, как оформлять приложения в дипломе.
Пример: «Приложение Г». Со следующей строки с абзаца «Таблица Г.1 - Результаты финансовой деятельности ООО «Заря» за 2014-2015 гг.». Если она большая, то на следующей странице указывают: «Продолжение таблицы Г.1», и делают так до её окончания. На том листе, где она заканчивается, нужно написать: «Окончание таблицы Г.1». В приведённом в примере приложении, обозначенном буквой «Г», могут быть не только табличные данные, но и сведения иной формы. В этом случае указывают: «Рисунок Г.2» или «Диаграмма Г.2».
Иногда требуется обозначение каждой страницы. Если, к примеру, приложение К имеет несколько рисунков, таблиц или схем, то нужно на первом указать, что это «Приложение К». На следующем - «Продолжение приложения К», на последнем - «Окончание приложения К».
Как уже было отмечено, все данные, представленные в работе, должны быть взаимосвязаны. Поэтому не будет лишним ещё раз напомнить, как правильно оформить приложения в дипломе.
Пример подается в кавычках, которые не нужно использовать в тексте: «Схема организационно-управленческой структуры ООО «Восток» находится в Приложении Б». На основе этого получаем следующее. ПРИЛОЖЕНИЕ Б. Следующей строкой - «Схема Б.1, которая имеет название «Организационно-управленческая структура ООО «Восток»». Учитывая, что такие изображения занимают немало места, их лучше разместить в соответствующем разделе. Тем более что расположить их там можно как в книжном, так и в альбомном формате.
Понятно, что наглядный пример позволяет получить более полное представление о том, как оформить приложение к диплому. Образец, приведённый ниже, позволит ещё раз убедиться в этом.
ПРИЛОЖЕНИЕ Д
Таблица Д.1 - Расчёт показателей, касающихся использования ресурсов ООО «Заря» за 2013-2015 гг.
Показатели | 2013-2014 гг. | 2014-2015 гг. | , % |
| 1. Выручка от реализации продукции в сопоставимых ценах, тыс. р. | 79705 | 83615 | 104,9 |
| 2. а) производственный персонал предприятия, чел. | 383 | 384 | 100,3 |
| б) оплата труда, тыс. р. | |||
| 3. Материальные затраты, тыс. р. | |||
| 4. а) основные производственные фонды предприятия, тыс. р. | |||
| б) амортизация, тыс. р. | |||
| 5. Оборотные средства предприятия, тыс. р. | |||
| 6. а) производительность труда (п.1: п.2а), тыс. р. | |||
| б) продукция на 1 рубль оплаты труда (п.1: п.2б), р. | |||
| 7. Материалоотдача (п.1: п.3), р./р. | |||
| 8. а) фондоотдача (п.1: п.4а), р./р. | |||
| б) амортизация (п.1: п.4б), р./р. | 9,592 | 9,881 | 103,1 |
| 9. Оборачиваемость оборотных средств (п.1: п.5), количество оборотов или р./р. | 4,978 | 5,147 | 103,3 |
Учитывая, что это заключительная часть диплома, все же не стоит легкомысленно относиться к ней. Ведь именно здесь содержится неоспоримое подтверждение умений студента - и как исследователя, и как практика.
Материалы, размещённые в приложениях, разъясняют отдельные положения разделов и могут служить подтверждением того, что автор работы, используя те или иные методики анализа, владеет ими и как будущий специалист заслуживает отличной отметки и присвоения ему соответствующей квалификации.
ГОСТ 2.105-95
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
ЕДИНАЯ СИСТЕМА КОНСТРУКТОРСКОЙ ДОКУМЕНТАЦИИ
Издание официальное
МЕЖГОСУДАРСТВЕННЫЙ СОВЕТ ПО СТАНДАРТИЗАЦИИ, МЕТРОЛОГИИ И СЕРТИФИКАЦИИ
ГОСТ 2.105-95 МЕЖГОСУДАРСТВЕННЫЙ С Т А Н Д А Р Т
Единая система конструкторской документации
ОБЩИЕ ТРЕБОВАНИЯ К ТЕКСТОВЫМ ДОКУМЕНТАМ
Unified syslem for design documentation General requirements for lex/ual documents
Дата введения 1996-07-01
1 ОБЛАСТЬ ПРИМЕНЕНИЯ
Настоящий стандарт устанавливает общие требования к выполнению текстовых документов на изделия машиностроения, приборостроения и строительства
ГОСТ 2.004-88 ЕСКД. Общие требования к выполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ
ГОСТ 2.104-68 ЕСКД. Основные надписи
ГОСТ 2.106-68 ЕСКД. Текстовые документы
ГОСТ 2.109-73 ЕСКД. Основные требования к чертежам
ГОСТ 2.301-68 ЕСКД. форматы
ГОСТ 2.304-81 ЕСКД. Шрифты чертежные
ГОСТ 2.316-68 ЕСКД. Правила нанесения на чертежах надписей, технических требований и таблиц
ГОСТ 2.321-84 ЕСКД. Обозначения буквенные
ГОСТ 2.503-90 ЕСКД. Правила внесения изменений
ГОСТ 6.38-90 УСД. Система организационно-распорядительной документации. Требования к оформлению документов
ГОСТ 7.32-91 Система стандартов по информации, библиотечному и издательскому делу. Отчет о научно-исследовательской работе. Структура и правила оформления
Издание официальное
ГОСТ 2.105-95
ГОСТ 8.417-81 ГСИ. Единицы физических величин
ГОСТ 13.1 802-80 Репрография. Микрография. Документы для съемки. Общие требования и нормы
ГОСТ 21.1101-92 СПДС. Основные требования к рабочей документации
ГОСТ 28388-89 Система обработки информации. Документы на магнитных носителях данных. Порядок выполнения и обращения
3 ОБЩИЕ ПОЛОЖЕНИЯ
3.1 Текстовые документы подразделяют на документы, содержащие, в основном, сплошной текст (технические условия, паспорта, расчеты, пояснительные записки, инструкции и т.п.), и документы, содержащие текст, разбитый на графы (спецификации, ведомости, таблицы и т.п.).
3.2 Текстовые документы выполняют на формах, установленных соответствующими стандартами Единой системы конструкторской документации (ЕСКД) и Системы проектной документации для строительства (СПДС).
Требования, специфические для некоторых видов текстовых документов (например эксплуатационных документов), приведены в соответствующих стандартах.
3.3 Подлинники текстовых документов выполняют одним из следующих способов:
Машинописным, при этом следует выполнять требования ГОСТ 13.1.002. Шрифт пишущей машинки должен быть четким, высотой не менее 2,5 мм, лента только черного цвета (полужирная);
Рукописным - чертежным шрифтом по ГОСТ 2.304 с высотой букв и цифр не менее 2,5 мм. Цифры и буквы необходимо писать четко черной тушью;
С применением печатающих и графических устройств вывода ЭВМ (ГОСТ 2.004).
На магнитных носителях данных (ГОСТ 28388).
3.4 Копии текстовых документов выполняют одним из следующих способов:
Типографским - в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом;
Светокопированием;
Микрофильмированием;
На магнитных носителях данных.
3.5 Вписывать в текстовые документы, изготовленные машинописным способом, отдельные слова, формулы, условные знаки ГОСТ 2.105-95 (рукописным способом), а также, выполнять иллюстрации следует черными чернилами, пастой или тушью.
3.6 Расстояние от рамки формы до границ текста в начале и в конце строк - не менее 3
мм .Расстояние от верхней или нижней строки текста до верхней или нижней рамки должно быть не менее 10-мм.
Абзацы в тексте начинают отступом, равным пяти ударам пишущей машинки (15 - 17 мм).
Пример выполнения текстового документа приведен в приложении А.
3.7 Опечатки, описки и графические неточности, обнаруженные в процессе выполнения документа, допускается исправлять подчисткой или закрашиванием белой. краской и нанесением на том же месте исправленного текста (графики) машинописным способом или черными чернилами, пастой или тушью рукописным способом.
Повреждения листов текстовых документов, помарки и следы не полностью удаленного прежнего текста (графика) не допускается.
После внесения исправлений документ должен удовлетворять требованиям микрофильмирования, установленным ГОСТ 13.1.002.
3.8 Для размещения утверждающих и согласующих подписей к текстовым документам рекомендуется составлять титульный лист и (или) лист утверждения в соответствии с разделом 6 настоящего стандарта.
Обязательность и особенности выполнения титульных листов оговорены в стандартах ЕСКД и СПДС на правила выполнения соответствующих документов.
4 ТРЕБОВАНИЯ К ТЕКСТОВЫМ ДОКУМЕНТАМ, СОДЕРЖАЩИМ, В ОСНОВНОМ, СПЛОШНОЙ ТЕКСТ
4.1 Построение,документа
4.1.1. Текст документа при необходимости разделяют на разделы и подразделы.
При большом объеме документа допускается разделять его на части, а части, в случае необходимости, на книги. Каждую часть и книгу комплектуют отдельно. Всем частям дают наименования и присваивают обозначение документа. Начиная со второй части, к этому обозначению добавляют порядковый номер, например:
ХХХХ.331П2.032ФО, ХХХХ.ЗЗП12.032Ф01, ХХХХ.331112.032Ф02, и т.д. Всем книгам дают наименование и присваивают порядковый номер….
Листы документа нумеруют в пределах каждой части, каждую часть начинают на листах с основной надписью по форме ГОСТ 2.104 и форме 3 ГОСТ Р 21.1101.
4.1.2. Разделы Должны иметь порядковые номера в пределах всего документа (часть, книги), обозначенные арабскими цифрами без точки и записанные с абзацевого отступа. Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой. В конце номера подраздела точки не ставится. Разделы, как и подразделы, могут состоять из одного или нескольких пунктов.
4.1.3 Если документ не имеет подразделов, то нумерация пунктов в нем должна быть в пределах каждого раздела, и номер пункта должен состоять из номеров раздела и пункта, разделенных точкой. В конце номера пункта точка не ставится, например:
1 Типы и основные размеры
1.2.г Нумерация пунктов первого раздела документа
2 Технические требования
2.2.г Нумерация пунктов второго раздела документа
Если документ имеет подразделы, то нумерация пунктов должна быть в пределах подраздела и номер пункта должен состоять из номеров раздела, подраздела и пункта, разделенных точками, например:
3 Методы испытаний
3.1 Аппараты, материалы и реактивы
3.1.2 Нумерация пунктов первого подраздела третьего
4.1.4 Если раздел или подраздел состоит из одного пункта, он также нумеруется.
4.1.5 Если текст документа подразделяется только на пункты, они нумеруются порядковыми номерами в пределах документа.
4.1.6 Пункты, при необходимости, могут быть разбиты на подпункты, которые должны иметь порядковую нумерацию в пределах каждого пункта, например: 4.2.1.1, 4.2.1.2, 4.2.1.3 и т.д.
4.1.7 Внутри пунктов или подпунктов могут быть приведены перечисления.
Перед каждой позицией перечисления следует ставить дефис
или при необходимости ссылки в тексте документа на одно из перечислений, строчную букву, после которой ставится скобка. Для дальнейшей детализации перечислений необходимо использовать арабские цифры, после которых, ставится скобка, а запись производится с абзацного отступа, как показано в примере.а) ____________
б) ____________
1) ______________
2) ______________
в) ____________
4.1.8 Каждый пункт, подпункт и перечисление записывают с абзацного отступа
.4.1.9 Разделы, подразделы должны иметь заголовки. Пункты, как правило, заголовков не имеют.
Заголовки должны четко и кратко отражать содержание разделов, подразделов.
Заголовки следует печатать с прописной буквы без точки в конце, не подчеркивая. Переносы слов в заголовках не допускаются. Если заголовок состоит из двух предложений, их разделяют точкой.
Расстояние между заголовком и текстом при выполнении документа машинописным способом должно быть равно 3,4 интервалам, при выполнении рукописным способом - 15 мм. Расстояние между заголовками раздела и подраздела - 2 интервала, при выполнении рукописным способом - 8 мм.
4.1.10 Каждый раздел текстового документа рекомендуется начинать с нового листа (страницы).
4.1.11 В документе (части, книге) большого объема на первом (заглавном) листе и, при необходимости, на последующих листах помещают содержание, включающее номера и наименования разделов и подразделов с указанием номеров листов (страниц).
Если документ разбит на части (книги), то в конце содержания первой части (книги) перечисляют обозначение и наименование (при наличии) остальных частей (книг). Содержание включают в общее, количество листов данного документа (части, книги).
4.1.12 В конце текстового документа перед листом регистрации изменений допускается приводить список литературы, которая была использована при его составлении. Выполнение списка и ссылки на него в тексте - по ГОСТ 7.32. Список литературы включают в содержание документа.
4.1.13 Нумерация страниц документа и приложений, входящих в состав этого документа, должна быть сквозная. Допускается вместо сквозной нумерации страниц применять нумерацию страниц в пределах каждого раздела документа следующим образом: 3 15
раздел страница
4.2 Изложение текста документов
4.2.1 Полное наименование изделия на титульном листе, в основной надписи и при первом упоминании в тексте документа должно быть одинаковым с наименованием его в основном конструкторском документе.
В последующем тексте порядок слов в наименовании должен быть прямой, т.е. на первом месте должно быть определение (имя прилагательное), а затем - название изделия (имя существительное);
при этом допускается употреблять сокращенное наименование изделия.
Наименования, приводимые в тексте документа и на иллюстрациях, должны быть одинаковыми.
4.2.2 Текст документа должен быть кратким, четким и не допускать различных толкований.
При изложении обязательных требований в тексте должны применяться слова "должен", "следует", "необходимо", "требуется, чтобы", "разрешается только", "не допускается", "запрещается", "не следует". При изложении других положений следует применять слова - "могут быть", "как правило", "при необходимости", "может быть", "в случае" и т.д.
При этом допускается использовать повествовательную форму изложения текста документа, например "применяют", "указывают" и т.п.
В документах должны применяться научно-технические термины, обозначения и определения, установленные соответствующими стандартами, а при их отсутствии - общепринятые в научно-технической литературе.
Если в документе принята специфическая терминология, то в конце его (перед списком литературы) должен быть перечень принятых терминов с соответствующими разъяснениями. Перечень включают в содержание документа.
4.2.3 В тексте документа не допускается :
Применять обороты разговорной речи, техницизмы, профессионализмы;
- применять произвольные словообразования;
Применять сокращения слов, кроме установленных правилами русской орфографии, соответствующими государственными стандартами, а также в данном документе;
Сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковиках таблицей в расшифровках буквенных обозначений, входящих в формулы и рисунки.
4.2.4 В тексте документа, за исключением формул, таблиц и рисунков, не допускается:
- применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово "минус");
Применять знак "0" для обозначения диаметра (следует писать слово "диаметр"). При указании размера или предельных отклонений диаметра на чертежах, помещенных в тексте документа, перед размерным числом следует писать знак "0";
Применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно), 2: (больше или равно), ^ (меньше или равно), -^ (не равно), а также знаки № (номер), % (процент);
Применять индексы стандартов, технических условий и других документов без регистрационного номера.
4.2.5 Если в документе приводятся поясняющие надписи, наносимые непосредственно на изготовляемое изделие (например, на планки, таблички к элементам управления и т.п.), их выделяют шрифтом (без кавычек), например ВКЛ., ОТКЛ.,. или кавычками - если надпись состоит из цифр и (или) знаков.
Наименования команд, режимов, сигналов и т.п. в тексте следует выделять кавычками, например, "Сигнал +27 включено".
4.2.6 Перечень допускаемых сокращений слов установлен в ГОСТ 2.316.
Если в документе принята особая система сокращения слов или. наименований, то в нем должен быть приведен перечень принятых сокращений, который помещают в конце документа перед перечнем терминов.
4.2.7 Условные буквенные обозначения, изображения или знаки должны соответствовать принятым в действующем законодательстве и государственных стандартах. В тексте документа перед обозначением параметра дают его пояснение, например "Временное сопротивление разрыву Стд".
При необходимости применения условных обозначений, изображений или знаков, не установленных действующими стандартами, их следует пояснять в тексте или в перечне обозначений.
4.2.8 В документе следует применять стандартизованные единицы физических величин, их наименования и обозначения в соответствии с ГОСТ 8.417.
Наряду с единицами СИ, при необходимости, в скобках указывают единицы ранее применявшихся систем, разрешенных к применению. Применение в одном документе разных систем обозначения физических величин не допускается.
4.2.9 В тексте документа числовые значения величин с обозначением единиц физических величин и единиц счета следует писать цифрами, а числа без обозначения единиц физических величин и единиц счета от единицы до девяти - словами.
1 Провести испытания пяти труб, каждая длиной 5 м.
2 Отобрать 15 труб для испытаний на давление.
4.2.10 Единица физической величины одного и того же параметра в пределах одного документа должна быть постоянной. Если в тексте приводится ряд числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например 1,50; 1,75; 2,00 м.
4.2.11 Если в тексте документа приводят диапазон числовых значений физической величины, выраженных в одной и той же единице физической величины, то обозначение единицы физической величины указывается после последнего числового значения диапазона.
1 От 1 до 5 мм.
2 От 10 до 1QD кг.
3 От плюс 10 до минус 40 "С.
4 От плюс 10 до плюс 40 "С.
Недопустимо отделять единицу физической величины от числового значения (переносить их на разные строки или страницы), кроме единиц физических величин, помещаемых в таблицах, выполненных машинописным способом.
4.2.12 Приводя наибольшие или наименьшие значения величин следует применять словосочетание "должно быть не более (не менее)".
Приводя допустимые значения отклонений от указанных норм, требований следует применять словосочетание "не должно быть более (менее)".
Например, массовая доля углекислого натрия в технической кальцинированной соде должна быть не менее 99,4 %.
4.2.13 Числовые значения величин в тексте следует указывать со степенью точности, которая необходима для обеспечения требуемых свойств изделия, при этом в ряду величин осуществляется выравнивание числа знаков после запятой.
Округление числовых значений величин до первого, второго, третьего и т.д. десятичного знака для различных типоразмеров, марок и т.п. изделий одного наименования должно быть одинаковым. Например, если градация толщины стальной горячекатаной ленты 0,25 мм, то весь ряд толщин ленты должен быть указан с таким же количеством десятичных знаков, например 1,50; 1,75; 2,00.
4.2.14 Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые следует записывать. ¼ "; ½"; (но не )
При невозможности выразить числовое значение в виде десятичной дроби, допускается записывать в виде простой дроби в одну строчку через косую черту, например, 5/32; (50А - 4С)/(40В+20).
4.2.15 В формулах в качестве символов следует применять, обозначения, установленные соответствующими государственными стандартами. Пояснения символов и числовых коэффициентов, входящих в формулу, если они не пояснены ранее в тексте, должны быть приведены непосредственно под формулой. Пояснения каждого символа следует давать с новой строки в той- последовательности, в которой символы приведены в формуле. Первая строка пояснения должна начинаться со слова "где" без двоеточия после него.
Пример - Плотность каждого образца р, кг/м
3 , вычисляют по формуле (1)где т - масса образца, кг;
V - объем образца, м 3 .
Формулы, следующие одна за другой и не разделенные текстом, разделяют запятой.
4.2.16 Переносить формулы на следующую строку допускается только на знаках выполняемых операций, причем знак в начале следующей строки повторяют. При переносе формулы на знаке умножения применяют знак "х".
4.2.17 В документах, издаваемых нетипографским способом, формулы могут быть выполнены машинописным, машинным способами или чертежным шрифтом высотой не менее 2,5 мм. Применение машинописных и рукописных символов в одной формуле не допускается.
4.2.18 Формулы, за исключением формул, помещаемых в приложении, должны нумероваться сквозной нумерацией арабскими цифрами, которые записывают на уровне формулы справа в круглых скобках. Одну формулу обозначают - (1).
Формулы, помещаемые в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например формула (В.1).
Допускается нумерация формул & пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой, например (3.1).
4.2.19 Порядок изложения в документах математических уравнений такой же, как и формул.
4.2.20 Примечания приводят в документах, если необходимы пояснения или справочные данные к содержанию текста, таблиц или графического материала.
Примечания не должны содержать требований.
4.2.21 Примечания следует помещать непосредственно после текстового, графического материала или в таблице, к которым относятся эти примечания, и печатать с прописной буквы с абзаца. Если примечание одно, то после слова "Примечание" ставится тире и примечание печатается тоже с прописной буквы. Одно примечание не нумеруют. Несколько примечаний нумеруют по порядку арабскими цифрами. Примечание к таблице помещают в конце таблицы над линией, обозначающей окончание таблицы.
Примечание - _______
Примечания
4.2.22 В текстовом документе допускаются ссылки на данный документ, стандарты, технические условия и другие документы при условии, что они полностью и однозначно определяют соответствующие требования и не вызывают затруднений в пользовании документом.
Ссылаться следует на документ в целом или его разделы к приложения. Ссылки на подразделы, пункты, таблицы и иллюстрации не допускаются, за исключением подразделов, пунктов, таблиц и иллюстраций данного документа.
При ссылках на стандарты и технические условия указывают только их обозначение, при этом допускается не указывать год их утверждения при условии записи обозначения с годом утверждения в конце текстового документа под рубрикой "ССЫЛОЧНЫЕ НОРМАТИВНЫЕ ДОКУМЕНТЫ" …..
4.3. Оформление иллюстраций и приложений
4.3.1 Количество иллюстраций должно быть достаточным для пояснения излагаемого текста. Иллюстрации могут быть расположены как по тексту документа (возможно ближе к соответствующим частям текста), так и в конце его. Иллюстрации должны быть выполнены в соответствии с требованиями стандартов ЕСКД и СПДС. Иллюстрации за исключением иллюстраций приложений, следует нуме-ровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается "Рисунок I".
Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например - Рисунок А.3.
Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой. Например – Рисунок 1.1.
Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово "Рисунок" и наименование помещают после пояснительных данных и располагают образом: Рисунок 1 - Детали прибора.
4.3.2 Если в тексте документа имеется иллюстрация, на которой изображены составные части изделия, то на этой иллюстрации должны быть указаны номера позиций этих составных частей в пределах данной иллюстрации, которые располагают в возрастающем порядке, за исключением повторяющихся позиций, а для электро- и радио элементов - позиционные обозначения, установленные в схемах данного изделия.
Исключение составляют электро- и радиоэлементы, являющиеся органами регулировки
или настройки, для которых (кроме номера позиции) дополнительно указывают в подрисуночном тексте назначение каждой регулировки и настройки, позиционное обозначение и надписи на соответствующей планке или панели.Допускается, при необходимости, номер, присвоенный составной части изделия на иллюстрации, сохранять в пределах документа.
Для схем расположения элементов конструкций и архитектурно-стро-ительных чертежей зданий (сооружении) указывают марки элементов.
Указанные данные наносят на иллюстрациях согласно ГОСТ 2.109.
4.3.3 На приводимых в документе электрических схемах около каждого элемента указывают его позиционное обозначение, установленное соответсгвующими стандартами, и при, необходимости, номинальное значение величины.
4.3.4 Материал, дополняющий текст документа, допускается помещать в приложениях. Приложениями могут быть, например, графический материал, таблицы большого формата, расчеты, описания аппаратуры и приборов, описания алгоритмов и программ задач, решаемых на ЭВМ и т.д.
Приложение оформляют как продолжение данного документа на последующих его листах или выпускают в виде самостоятельного документа.
4.3.5 Приложения могут быть обязательными и информационными.
4.3.6 В тексте документа на все приложения должны быть даны ссылки. Степень обязательности приложений при ссылках не указывается. Приложения располагают в порядке ссылок на них в тексте документа, за исключением информационного приложения "Библиография", которое располагают последним.
4.3.7 Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова "Приложение" и его обозначения, а под ним в скобках для обязательного приложения пишут слово "обязательное", а для информационного - "рекомендуемое" или "справочное".
Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой.
4.3.8 Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, 3, И, О, Ч, Ь, Ы, Ъ. После слова "Приложение" следует буква, обозначающая его последовательность.
Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и О.
В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами.
Если в документе одно приложение, оно обозначается "Приложение А".
4.3.9 Приложения, как правило, выполняют на листах формата А4. Допускается оформлять приложения на листах формата A3, А4х3, А4х4, А2 и А1 по ГОСТ 2.301.
4.3.10 Текст каждого приложения, при необходимости, может быть разделен на разделы, подразделы, пункты, подпункты, которые нумеруют в пределах каждого приложения. Перед номером ставится обозначение этого приложения.
Приложения должны иметь общую с остальной частью документа сквозную нумерацию страниц.
4.3.11 Все приложения должны быть перечислены в содержании документа (при наличии) с указанием их номеров и заголовков.
4.4 Построение таблиц
4.4.1 Таблицы применяют для лучшей наглядности и удобства сравнения показателей. Название таблицы, при его наличии, должно отражать ее содержание, быть точным, кратким. Название следует помещать над таблицей.
При переносе части таблицы на ту же или другие страницы название помещают только над первой частью таблицы.
Цифровой материал, как правило, оформляют в виде таблиц в соответствии с рисунком 1.
Таблица ______ - _______________
номер название таблицы
|
Заголовки граф Подзаголовки граф Строки (гориэонтальные |
||||||
Боковик Колонки
(графа для
заголовка)
Рисунок 14.4.2 Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией.
Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе одна таблица, она должна быть обозначена "Таблица 1" или "Таблица В.1", если она приведена в приложении В.
Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой.
4.4.3 На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово "таблица" с указанием ее номера.
4.4.4 Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф - со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе.
4.4.5 Таблицы слева, справа и снизу, как правило, ограничивают линиями.
Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.
Горизонтальные -и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей.
Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф.
Головка таблицы должна быть отделена линией от остальной части таблицы.
Высота строк таблицы должна быть не менее 8 мм.
4.4.6 Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а, при необходимости, в приложении к документу.
Допускается помещать таблицу вдоль длинной стороны листа документа.
4.4.7 Если строки или графы таблицы выходят за формат страницы, ее делят на части, помещая одну часть под другой или рядом, при этом в каждой части таблицы повторяют ее головку и боковик. При делении таблицы на части допускается ее головку или боковик заменять соответственно номером граф и строк. При этом нумеруют арабскими цифрами графы и (или) строки первой части таблицы.
Слово "Таблица" указывают один раз слева над первой частью таблицы, над другими частями пишут слова "Продолжение таблицы" с указанием номера (обозначения) таблицы в соответствии с рисунком 2.
Таблица ….
В миллиметрах
|
Внутренний диаметр шайбы |
Толщина шайбы |
||||||
|
нормальной |
|||||||
Продолжение таблицы …
.В миллиметрах
|
Номинальный диаметр резьбы болта, винта, |
Внутренний диаметр шайбы |
Толщина шайбы |
|||||
|
нормальной |
|||||||
Рисунок 2
Если в конце страницы таблица прерывается и ее продолжение будет на следующей странице, в первой части таблицы нижнюю горизонтальную линию, ограничивающую таблицу, не проводят.
Таблицы с небольшим количеством граф допускается делить на части и помещать одну часть рядом с другой на одной странице, при этом повторяют головку таблицы в соответствии с рисунком 3. Рекомендуется разделять части таблицы двойной линией или линией толщиной
Is.Таблица …
Рисунок 3
4.4.8 Графу "Номер по порядку" в таблицу включать не допускается. Нумерация граф таблицы арабскими цифрами допускается в тех случаях, когда в тексте документа имеются ссылки на
них , при делении таблицы на части, а также при переносе части таблицы на следующую страницу в соответствии с рисунком 4.Таблица …...
Размеры в миллиметрах
|
Условный проход Dy |
Масса, кг, не более |
||||
Рисунок 4
При необходимости нумерации показателей, параметров или других данных порядковые номера следует указывать в первой графе (боковике) таблицы непосредственно перед их наименованием в соответствии с рисунком 5. Перед числовыми значениями величин и обозначением типов, марок и т.п. порядковые номера не проставляют.
Таблица …..
Рисунок 5
4.4.9 Если все показатели, приведенные в графах таблицы, выражены в одной и той же единице физической величины, то ее обозначение необходимо помещать над таблицей справа, а при делении таблицы на части - над каждой ее частью в соответствии с рисунком 2.
Если в большинстве граф таблицы приведены показатели, выраженные в одних и тех же единицах физических величин (например в миллиметрах, вольтах), но имеются графы с показателями, выраженными в других единицах физических величин, то над таблицей следует писать наименование преобладающего показателя и обозначение его физической величины, например, "Размеры в миллиметрах", "Напряжение в вольтах", а в подзаголовках остальных граф приводить наименование показателей и (или) обозначения других единиц физических величин в соответствии с рисунком 4.
Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, установленными ГОСТ 2.321, или другими обозначениями, если они пояснены в тексте или приведены на иллюстрациях, например
D - диаметр, Н - высота, L - длина.Показатели с одним и тем же буквенным обозначением группируют последовательно в порядке возрастания индексов в соответствии с рисунком 4.
4.4.10 Ограничительные слова "более", "не более", "менее", "не менее" и др. должны быть помещены в одной строке или графе таблицы с наименованием соответствующего показателя после обозначения его единицы физической величины, если они относятся ко всей строке или графе. При этом после наименования показателя перед ограничительными словами ставится запятая в соответствии с рисунками 4 и 5.
4.4.11 Обозначение единицы физической величины, общей для всех данных в строке, следует указывать после ее наименования в соответствии с рисунком 5. Допускается при необходимости выносить в отдельную строку (графу) обозначение единицы физической величины
4.4.12 Если в графе таблицы помещены значения одной и той же физической величины, то обозначение единицы физической величины указывают в заголовке (подзаголовке) этой графы в соответствии с рисунком 6. Числовые значения величин, одинаковые для нескольких строк, допускается указывать один раз в соответствии с рисунками 4 и 6.
Таблица …..
Рисунок 6
Если числовые значения величин в графах таблицы выражены в разных единицах физической величины, их обозначения указывают в подзаголовке каждой графы.
Обозначения, приведенные в заголовках граф таблицы, должны быть пояснены в тексте или графическом материале документа.
4.4.13 Обозначения единиц плоского угла следует указывать не в заголовках граф, а в каждой строке таблицы как при наличии горизонтальных линий, разделяющих строки в соответствии с рисунком 7, так и при отсутствии горизонтальных линий в соответствии с рисунком 8.
Таблица …. Таблица ….
|
3њ 5¢ 30ќ |
6њ 30¢ |
3њ 5¢ 30ќ |
6њ 30¢ |
|
|
4њ 23¢ 50ќ |
8њ 26¢ |
4њ 23¢ 50ќ |
8њ 26¢ |
|
|
5њ 30¢ 20ќ |
10њ 30¢ |
5њ 30¢ 20ќ |
10њ 30¢ |
Рисунок 7 Рисунок 8
4.4.14 Предельные отклонения, относящиеся ко всем числовым значениям величин, помещенным в одной графе, указывают в головке таблицы под наименованием или обозначением показателя в соответствии с рисунком 9.
Таблица...
|
Диаметр резьбы d |
Условный диаметр шплинта d 1 |
||||
Рисунок 9
4.4.15 Предельные отклонения, относящиеся к нескольким числовым значениям величин или к определенному числовому значению величины, указывают в отдельной графе
….4.4.17 Заменять кавычками повторяющиеся в таблице цифры, математические знаки, знаки процента и номера, обозначение марок материалов и типоразмеров изделий, обозначения нормативных документов не допускается.
4.4.19 При указании в таблицах последовательных интервалов чисел, охватывающих все числа ряда, их следует записывать: "От... до... включ.", "Св. ... до... включ." ….
В интервале, охватывающем числа ряда, между крайними числами ряда в таблице допускается ставить тире …..
Интервалы чисел в тексте записывают со словами "от" и "до" (имея в виду "От... до... включительно"), если после чисел указана единица физической величины или числа, представляют безразмерные коэффициенты, или через дефис, если числа представляют порядковые номера.
1 ... толщина слоя должна быть от 0,5 до 20 мм.
2 7 - 12, рисунок 1 - 14
4.4.20 В таблицах при необходимости применяют ступенчатые полужирные линии,для выделения диапазона, отнесенного к определенному значению, объединения позиции в группы и указания предпочтительных числовых значении показателей, которые обычно расположены внутри ступенчатой линии, или для указания, к каким значениям граф и строк относятся определенные отклонения, ….
4.4.22 Цифры в графах таблиц должны проставляться так, чтобы разряды чисел во всей графе были расположены один под другим, если они относятся к одному показателю. В одной графе должно быть соблюдено, как правило, одинаковое количество десятичных знаков для всех значений величин.
4.4.23 При необходимости указания в таблице предпочтительности применения определенных числовых значений величин или типов (марок и т.п.) изделий допускается применять условные отметки с пояснением их в тексте документа.
Для выделения предпочтительной номенклатуры или ограничения применяемых числовых величин или типов (марок и т.п.) изделий допускается заключать в скобки те значения, которые не рекомендуются к применению или имеют ограничительное применение, указывая в примечании значение скобок …..
