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

Министерство путей сообщения российской федерации

петербургский государственный университет путей сообщения

Правила оформления пояснительных

записок к курсовым и дипломным

проектам

Санкт-Петербург

2002

АННОТАЦИЯ

В электронном руководстве анализируются  современные требования ГОСТ'ов и других нормативно-технических документов (по состоянию на 1.05.02) и поясняется специфика их применения  при оформлении пояснительных записок к курсовым и дипломным проектам.

СОДЕРЖАНИЕ

ВВЕДЕНИЕ…………………………………………………………………..……..….4

1. Общие положения……………………………………………………………6

1.1  Общие требования к стилю  и оформлению пояснительной

записки………………………………………………………………………………6

1.2. Требования к изложению текста пояснительной записки………..…..8

2. Содержание пояснительной записки………………....9

3. Стиль пояснительной записки………………………..…12

3.1. Структура текста  пояснительной записки………………………….…12

3.2. Оформление  заголовков фрагментов  пояснительной

записки………………………………………………………………………….…13

3.3. Стиль оформления  аннотации, введения, заключения, списка

использованных источников…………………………………………………..16

4. Оформление сносок, примечаний, иллюстраций, таблиц, ссылок, перечислений…………………..……...20

4.1. Оформление сносок…………………………………………………….…21

4.2. Оформление примечаний……………………………………………...…22

4.3. Оформление иллюстраций……………………………………….………23

4.4. Требования к оформлению таблиц……………………………….….…26

4.5. Правила оформления перечислений………………………………...…30

4.6. Требования к оформлению ссылок…………………………………..…31

4.7. Требования к оформлению формул и уравнений……………..……..31

5. Требования к оформлению приложений………..…..33

6. Рекомендации по “ стыковке”  текстовой и 

схемной  документации……….……………………………….……..34

6.1. Компоновка проекта программного направления…………….………34

6.2. Компоновка проектов схемотехнического направления……..………35

ЗАКЛЮЧЕНИЕ…………………………………………………………..….……..37

СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ………………….……38

ПРИЛОЖЕНИЕ 1. Титульный лист курсового проекта ………… ………..40

ПРИЛОЖЕНИЕ 2. Атрибуты схемной документации…………… ………..41

ВВЕДЕНИЕ

Качественно новый уровень современных средств вычислительной и информационной техники существенно изменил требования к технической и программной документации. Она содержит  сложные   графические обозначения, аббревиатуры и т.п., а правила ее оформления   все более согласуются с  Международными  стандартами (Стандарты IEEE, DINA, ISO …).

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

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

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

·  схемотехнического направления (специальность  "Информационные системы в технике и технологиях" (спец. 071900)). Объектом разработки в  них являются устройства (или их части).

·   программного направления (специальность  "Программное обеспечение ВТ и АС" (спец.2204)), в которых разрабатываются  программные   продукты.

Пояснительные записки к курсовым и дипломным проектам схемотехнического направления должны соответствовать требованиям ЕСКД, а  программного направления – требованиям ЕСПД. Требования таких систем в ряде положений различаются.   Такие различия хотя и формальны, но существенны. В тоже время специальности ПВТ и ИНФО взаимно интегрированы и предполагают изучение ряда дисциплин смежного направления.

Поэтому, целесообразно

o  где возможно, "жестко" не  дифференцировать  требования ЕСКД-ЕСПД по специальностям ИНФО, ПВТ;

o  использовать принцип  "рекомендуемое правило - допустимое правило" применительно к стилю оформления  текстовых документов разного направления.

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

1.  (!) –положение или требование, на которое следует обратить особое внимание;

2.  (Рек.ИНФО) – стиль оформления или положение, рекомендуемые для специальности ИНФО, допустимые для ПВТ;

3.  (Рек. ПВТ) – стиль оформления или положение, рекомендуемые для специальности ПВТ, допустимые для ИНФО;

4.  (Искл.ИНФО) -   стиль оформления, допустимый только (!) для специальности ИНФО;

5.  (Искл. ПВТ) -   стиль оформления, допустимый только (!) для специальности ПВТ;

6.  (MSW-стиль) – элемент стиля редактора Microsoft Word, который может быть использован при форматировании документа.

Например, (MSW-формат:шрифт:bold) – последовательность команд и опций редактора Microsoft Word, обеспечивающая форматирование текста полужирным шрифтом.