Основные правила оформления студенческих учебно-научных и творческих работ (стр. 2 из 7)

Оформление текста программ и программных документов

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

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

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

Формулы и уравнения

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

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

Пример

А=а:b, (1)

В=с:е. (2)

Одну формулу обозначают — (1).

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

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

Пример – Плотность каждого образца

, кг/м3, вычисляют по формуле:

,

где

- масса образца, в кг;

- объем образца, в м3.

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

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

Ссылки в тексте на порядковые номера формул дают в скобках. Пример - ... в формуле (1).

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

Порядок изложения математических уравнений такой же, как и формул.

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

Слово «Примечание» следует печатать с прописной буквы с абзаца и не подчеркивать.

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

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

2. Правила цитирования

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

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

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

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

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

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

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

М. Горький писал, что "в простоте слова - самая великая мудрость".

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

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

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

Если в приводимой цитате выделяются какие-то слова, то сразу же в скобках пишется "курсив мой" или "выделено мной" и инициалы автора работы.

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

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

3. Правила составления списка использованных источников

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

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

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

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

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

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

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

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

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

Расположение по видам источников– все документы делятся на группы (классы, разделы):

1. документы, формирующие методологическую базу исследования (труды корифеев науки);

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

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

б) программы, уставы, материалы съездов партий, тематические сборники партийных доку-ментов;

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

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

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