Документирование материалов

2.2.1 Полному комплекту материалов ПЗ в целом присваивают обозначение, состоящие из записываемых с разделением точками аббревиатуры КП, кодировки кафедры ВиВ, порядкового номера темы курсового проекта (по учету кафедры) и добавленной через тире аббревиатуры ПЗ.

Обозначение полного комплекта материалов ПЗ в целом проставляют на титульном листе ПЗ (как это показано в примере, приведенном в приложении А).

2.2.2 Документу «Проектная разработка» присваивают обозначение, состоящие из обозначения полного комплекта материалов ПЗ в целом и добавленного к нему через точку индекса Р.

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

2.2.3 На первом листе структурного элемента «Оглавление» документа «Проектная разработка» помещают основную надпись по форме 5 приложения ГОСТ 21.101 с учетом указания второго абзаца 7.5.18 там же. Указанная форма основной надписи приведена на рисунке 3.

На последующих листах структурного элемента «Оглавление», а также на всех листах остальных структурных элементов документа «Проектная разработка» помещают основную надпись по форме 6 приложения ГОСТ 21.101 с учетом указания второго абзаца 7.5.18 там же. Указанная форма основной надписи приведена на рисунке 4.

2.2.4 Заполнение основных надписей производят по аналогии с примерами, приведенными в приложениях В и Г.

 

 

 

 

Рисунок 3

 

 

 

Рисунок 4

 

3 СОЗДАНИЕ ИНФОРМАЦИИ

Построение текста

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

С абзаца записывают:

– начало текста;

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

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

– текст подпункта или не имеющего заголовка пункта в введении, в содержательной части проектной разработки и в приложении (абзац начинают с нумерации подпункта или пункта);

– текстовое образование с заголовком пункта и подраздела содержательной части проектной разработки и в оглавлении (абзац начинают с нумерации пункта или подраздела);

– текстовое образование с заголовком раздела в содержательной части проектной разработки и в оглавлении (абзац начинают с нумерации раздела);

– заголовки, не имеющие нумерации перед наименованием в списке использованной литературе и в оглавлении;

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

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

Разделам присваивают порядковые номера, обозначаемые арабскими цифрами с добавлением к ним точки. Например: «2».

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

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

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

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

3.1.3 Расстояние между заголовками раздела, подраздела и пункта в содержательной части проектной разработки, а также между заголовками и последующим текстом на любых листах «Проектной разработки», назначают равным 15 мм (рекомендовано для случая выполнения текста рукописным способом). Кроме того, в содержательной части проектной разработки, расстояние от верха заголовков подразделов или пунктов до предыдущего текста принимают равным или большим 15 мм, а расстояние между строками текста – равным 8 мм (рекомендовано для случая выполнения текста рукописным способом).

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

 

Изложение текста

3.2.1 Общую текстовую информацию записывают кратко, чётко, не допуская различных толкований, в безличной форме. Например: «значение коэффициента принято...» или «значение

 

Рисунок 5

 

 

коэффициента принимается...». В обязательных требованиях используют слова, содержащие прямые указания (должен, необходимо) и производные от них. Числа с размерностью пишут цифрами, без размерности – словами. Например: «Зазор не более 3 мм» и «Покрытие красить краской на два раза».

В тексте используют термины и определения, установленные соответствующими стандартами, СНиПами, а при их отсутствии – общепринятые в научно-технической литературе.

Интервалы значений величин в тексте записывают словами «от» и «до» (например: «Толщина слоя должна быть от 0,5 до 2 мм»), или через тире (например: 7–12). Пределы размеров указывают от меньших к большим.

3.2.1.1 При написании текста не допускают:

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

– использование математических знаков, вместо слов, (например: + вместо «плюс»; – вместо «минус»; < вместо «меньше»; > вместо «больше»; = вместо «равно»), а также знаков № вместо «номер» и % вместо «процент»;

– применения аббревиатур стандартов, строительных норм и правил и других нормативно-технических документов (ГОСТ, ОСТ, СНиП и т.п.) без регистрационных номеров.

3.2.1.2В содержащейся в тексте информации обеспечивают:

– наличие (в содержательной части проектной разработки) ссылок на приводимые ниже или выше в тексте формулы, таблицы и графические иллюстрации, преимущественно путём использования сокращений слов «формула», «таблица», «рисунок» с указанием соответствующих номеров, например: «…по формуле 2.3 », «…в таблице 3.4 », «...на рисунке 2.5 »;

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

– наличие ссылок на помещаемые в пояснительной записке приложения, преимущественно путем использования слов «приведен», «приведено» с указанием обозначения приложения («…приведено в приложении А»).

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

«Потери напора в водомере определяются по формуле:

 

, (3.1)

где – гидравлическое сопротивление водосчетчика, принимается по приложению 4 [1];

– расчетный секундный расход, проходящий через водомер, л/с.»

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

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

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

 

 

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

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

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

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

Диагональное деление головки таблиц не допускают.

Высоту строк таблицы назначают не менее 8 мм. При необходимости, разбивку на строки не устраивают.

Схема построения таблицы приведена на рисунке 6.

3.3.2 Таблицы нумеруют арабскими цифрами. Номер таблицы составляют из номера раздела и (через точку) порядкового номера таблицы в разделе (например, 3.1).

3.3.3. Если таблица не умещается полностью в отведённом месте на одном листе, её разбивают на части, размещая первую часть на первом листе, а последующие части – на последующих.

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

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

3.3.5 При размещении таблицы на нескольких листах, заголовок (при его наличии) записывают только на первом листе (над первой частью таблицы).

 

 

 

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

 

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

(заголовки строк)

 

Рисунок 6

 

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

 

Заполнение таблиц

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

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

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

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