Основные правила изложения текста

 

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

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

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

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

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

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

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

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

Абзацами выделяют примерно равные и обособленные по смыслу части текста.

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

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

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

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

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

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

1) применять математический знак минус (–) перед отрицательными значениями величин (следует писать слово «минус»);

2) применять знак «Æ» для обозначения диаметра (следует писать слово «диаметр»). При указании размера или предельных отклонений диаметра на чертежах, помещенных в тексте документа, перед размерным числом следует писать знак «Æ»;

3) сокращать обозначения единиц физических величин, если они употребляются без цифр;

4) применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно), ³ (больше или равно), £ (меньше или равно), ≠ (не равно), а также знаки № (номер), % (процент) и т. д. В тексте следует писать словами «номер», «процент» и т. д. Знаки №, §, % при нескольких числах не удваиваются и ставятся только один раз – до или после ряда чисел, например № 5, 6, 7; § 8 и 9; от 50 до 60%.

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

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

 

Примеры:

Провести испытания пяти труб, каждая длиной 5 м.

Отобрать 15 труб для испытаний на давление.

 

Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые следует записывать так: ¼", ½", но не

При невозможности выразить числовое значение в виде десятичной дроби допускается записывать его в виде простой дроби в одну строчку через косую черту, например 5/32; (50A – 4C)/(40B + 20).

Перед числами с размерностями не рекомендуется ставить предлог «в» или знак тире «–».

Единица физической величины одного и того же параметра в пределах записки должна быть постоянной. Если в тексте приводится ряд числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например 1,50; 1,75; 2,00 м.

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

 

Примеры:

1. От 1 до 5 мм.

2. От 10 до 100 кг.

3. От плюс 10 до плюс 40 °С.

 

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

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

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

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

Количественные числительные, обозначаемые цифрами, пишут без падежных окончаний, например «на 10 листах», «по результатам 15 экспериментов».

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

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

Примеры:

1 … диаметр окружности должен быть от 2,5 до 3,5 мм.

2 … рисунках 1–5.

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

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

Числовое значение показателя проставляют на уровне последней строки наименования показателя.

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

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

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

 

Пример

Предельные отклонения размеров профилей всех размеров, %:

по высоте…………………………………….±2,5

по ширине полки……………………………±1,5

по толщине стенки……………………….…±0,3

по толщине полки…………………….….…±0,3

 

 

Оформление иллюстраций и таблиц

 

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

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

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

Номер иллюстрации (таблицы) должен состоять из номера главы и порядкового номера иллюстрации (таблицы), разделенных точкой. Например: "рисунок 1.2" (второй рисунок первой главы), "таблица 2.5" (пятая таблица второй главы). Если в главах приведено лишь по одной иллюстрации (таблице), то их нумеруют последовательно в пределах в целом, например: "рисунок 1", "таблица 3".

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

Иллюстрации, как правило, имеют наименование и пояснительные данные (подрисуночный текст), располагаемые по центру страницы. Пояснительные данные помещают под иллюстрацией, а со следующей строки - слово "Рисунок", номер и наименование иллюстрации, отделяя знаком тире номер от наименования. Точку в конце нумерации и наименований иллюстраций не ставят. Не допускается перенос слов в наименовании рисунка. Слово "Рисунок", его номер и наименование иллюстрации печатают полужирным шрифтом, причем слово "Рисунок", его номер, а также пояснительные данные к нему - уменьшенным на 1-2 пункта размером шрифта.

 

Например:

(ИЗОБРАЖЕНИЕ ПРИНЦИПИАЛЬНОЙ СХЕМЫ)

1 – станина со столом; 2‑ уплотняемый шпон; 3 – направляющие линейки;
4 – плоские элементы с электронагревом

Рисунок 2.1 ‑ Принципиальная схема для уплотнения шпона

 

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

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

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

Цифровой материал, как правило, оформляют в виде таблиц в соответствии с рисунком 1.

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

 

–

Примечание – В графах (строках), обозначенных «*» запись слов (словосочетаний) начинают со строчной буквы.

Рисунок 1 – Оформление таблицы

 

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

― допускается применять в таблице шрифт на 1-2 пункта меньший, чем в тексте пояснительной записки;

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

― таблицу с большим количеством строк допускается переносить на следующий лист. При переносе части таблицы на другой лист ее заголовок указывают один раз над первой частью, слева над другими частями пишут слово "Продолжение". Если в пояснительной записке несколько таблиц, то после слова "Продолжение" указывают номер таблицы, например: "Продолжение таблицы 1.2";

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

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

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

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

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

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

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

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

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

При оформлении формул и уравнений необходимо соблюдать следующие правила:

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

― если формула или уравнение не умещаются в одну строку, они должны быть перенесены после знака равенства (=) или после знаков плюс (+), минус (-), умножения (х) и деления (:). При этом повторяют знак в начале следующей строки;

― ссылки на формулы по тексту дают в скобках;

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

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

Слово "Примечания" и их содержание печатаются шрифтом с размером на 1-2 пункта меньше размера шрифта основного текста.

 

 

Оформление сносок

 

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

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

Знак сноски ставят непосредственно после того слова, числа, символа, предложения, к которому дается пояснение, и перед текстом пояснения.

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

Пример – «… печатающее устройство2)…».

Нумерация сносок отдельная для каждой страницы.

Допускается вместо цифр выполнять сноски звездочками: *. Применять более четырех звездочек не рекомендуется.

 

 

Оформление библиографического указателя «Список использованных источников»

 

Список использованных источников включает сведения о всех источниках (учебниках, справочниках, монографиях и др. литературе, периодических изданиях, статьях из них, нормативно-технической, руководящей и законодательной документации, электронных информационных ресурсах), записанные в порядке появления ссылок на них в тексте. Источники в данном списке нумеруют по порядку арабскими цифрами. Описание каждого источника в списке следует записывать с абзацного отступа, руководствуясь требованиями ГОСТ 7.1-2003. Описание источника в списке включает его порядковый номер, который не отделяют точкой от текста описания.

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

 

 

Оформление ссылок

 

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

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

– «… технологическая схема производства, описанная в разделе 2…»;

– «… в пункте 2.4.1 настоящей записки обосновано применение оребренных труб…»;

– «… по пункту б) перечисления…»;

– «… результаты расчетов занесены в таблицу 4.1 …»;

– «… шпоночный паз вала, изображенного на рисунке 3.8, …»;

– «… в результате расчетов, проведенных по зависимости (5.3) …»;

– «… формы некоторых бланков статистической отчетности представлены в приложении Д …».

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

Примеры выполнения ссылок на источники, перечисленные в предыдущем абзаце:

– «… монография В. М. Рамма [4] …»;

– «… согласно стандарту [7], п. 3.4, …»;

– «… составы природного газа для различных магистральных трубопроводов приведены в таблице 4.11 справочника [12] …»;

– «… при расчете по формуле (11) из статьи [10] погрешность …»;

– «… схема фрезерного станка [6], рисунок 3.2 …».

 

 

Оформление перечня графического материала

 

ПЕРЕЧЕНЬ ГРАФИЧЕСКОГО (ИЛЛЮСТРАТИВНОГО) МАТЕРИАЛА следует приводить в виде текста после «Списка используемых источников», выполненного прописными буквами. В тексте указать порядковый номер, названия графического материала в соответствии с основной надписью.

 

 

Оформление приложений

 

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

Каждое приложение следует начинать с нового листа с указанием в правом верхнем углу слова "ПРИЛОЖЕНИЕ", напечатанного прописными буквами. Приложение должно иметь содержательный заголовок, который размещается с новой строки по центру листа с прописной буквы.

Приложения обозначают заглавными буквами русского алфавита, начиная с А (за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ), например: "ПРИЛОЖЕНИЕ А", "ПРИЛОЖЕНИЕ Б", "ПРИЛОЖЕНИЕ В". Допускается обозначать приложения буквами латинского алфавита, за исключением букв I и O.

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

ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ
ПРОГРАММНОЙ ДОКУМЕНТАЦИИ

Общие положения

 

Алгоритм – точное предписание исполнителю совершить определенную последовательность действий для достижения поставленной цели за конечное число шагов.

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

Программы подразделяют на следующие виды:

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

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

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

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

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

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

Различают следующие типы программных модулей:

- стандартные модули, входящие в язык программирования;

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

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

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

― описание применения;

― описание программы;

― руководство системного программиста;

― руководство программиста;

― руководство оператора;

― текст программы.

Примечание – Описание применения и руководства системного программиста, программиста и оператора являются эксплуатационными программными документами.

 

 

Описание применения

 

Текст документа включает следующие части:

― назначение программы;

― условия применения;

― описание задачи;

― входные и выходные данные.

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

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

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

В части «Описание задачи» должны быть указаны определения задачи и методы ее решения.

В части «Входные и выходные данные» нужно указать сведения о входных и выходных данных.

 

 

Описание программы

 

Описание программы содержит следующие части:

- общие сведения;

- функциональное назначение;

- описание логической структуры;

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

- вызов и загрузка;

- входные данные;

- выходные данные.

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

В части «Общие сведения» указывают:

- наименование программы;

- автора, дату создания, версию программы;

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

- языки программирования, на которых написана программа;

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

В части «Описание логической структуры» указываются:

- алгоритм программы;

- используемые методы и типовые проектные решения;

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

- связи программы с другими программами;

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

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

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

В части «Вызов и загрузка» описываются:

- способ вызова программы с соответствующего носителя данных;

- входные точки в программы.

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

В части «Входные данные» указывают:

- характер и организацию входных данных;

- описание предварительной подготовки входных данных;

- формат, описание и способ кодирования входных данных.

В части «Выходные данные» описывают:

- характер и организацию выходных данных;

- формат, описание и способ кодирования выходных данных;

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

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

В приложении к описанию программы можно приводить различные материалы, которые нецелесообразно включать в документ «Описание программы».