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

Пояснительная записка должна содержать следующие структурные элементы:

1. Титульный лист.

2. Задание на проектирование

3. Лист для замечаний нормоконтролера.

4. Реферат.

5. Обозначения и сокращения.

6. Содержание.

7. Введение

8. Основная часть.

9. Заключение.

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

11. Приложения.

2.3. Требования к структурным элементам
пояснительной записки

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

Лист для замечаний нормоконтролёра оставляют пустым. Он заполняется нормоконтролёром. Следует иметь в виду, что нормоконтролёр лишь констатирует наличие отклонений от требований ГОСТа в части технического исполнения пояснительной записки и не оценивает содержания работы.

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

Реферат должен занимать одну страницу и содержать следующее:

— сведения об объеме пояснительной записки, количестве иллюстраций, таблиц, приложений, использованных источников;

— перечень ключевых слов;

— текст реферата.

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

Текст реферата должен отражать:

— объект исследования или разработки;

— цель работы;

— метод или методологию проведения работы;

— результаты работы;

— основные технологические и технико-эксплуатационные характеристики разработанного программного продукта или технологии;

— степень внедрения;

— рекомендации по внедрению или итоги внедрения результатов работы;

— область применения;

— экономическую эффективность или значимость работы;

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

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

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

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

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

1. Предпроектные исследования.

2. Техническое задание.

3. Технорабочий проект.

4. Ввод в действие.

5. Экономическая часть.

6. Раздел по безопасности жизнедеятельности.

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

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

Техническое задание оформляется в соответствии с
ГОСТ 34.602.89, технорабочий проект — в соответствии с
РД 90-34.608-90.

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

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

Содержание экономической части и раздела безопасности жизнедеятельности должно соответствовать заданию на проектирование. Оно согласуется с консультантами по этим разделам проекта.

Заключение должно содержать:

— краткие выводы по результатам выполненной работы;

— оценку полноты решений поставленных задач;

— разработку рекомендаций и исходных данных по конкретному использованию результатов дипломного проектирования;

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

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

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

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

— листинги разработанных программ;

— примеры документов, формируемых в разработанной информационной системе;

— таблицы вспомогательных цифровых данных;

— иллюстрации вспомогательного характера;

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

2.4. Общие рекомендации по стилю
пояснительной записки

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

Как правило, объем пояснительной записки не должен превышать 80-100 страниц без учета приложений. При этом большая часть объема записки должна быть посвящена описанию выполненной работы по проектированию и реализации информационного и программного обеспечений. Разделы, посвященные экономической части и безопасности жизнедеятельности, не должны занимать более 1/4 объема основной части записки.

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

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

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

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

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

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

6. Способ и форма изложения материала должны облегчить понимание читателем того, какие из результатов, упоминаемых в работе, являются авторскими, а какие — продуктом чужого творчества или уже являются общепринятыми. При необходимости использования в проекте чужих результатов нужно указывать это с точной ссылкой на источник в соответствии с принятыми требованиями цитирования. В особенности это важно для проектов, в которых автор разрабатывал отдельные компоненты крупной системы. При описании таких проектов нужно четко выделять результаты собственной разработки и указать части, которые были разработаны ранее или другими исполнителями общего проекта. Не следует излишне «раздувать» записку и включать в нее материалы обзорного характера. Использование источников положительно характеризует работу и подчеркивает профессионализм автора. Однако реферирование источников не является целью дипломного проектирования, а объем проекта не является показателем его качества.

2.5. Правила оформления пояснительной
записки

В части оформления пояснительная записка должна соответствовать требованиям ГОСТ 7.32-2001 «Отчет о научно-исследовательской работе».

2.1.

2.2.

2.3.

2.4.

2.5.

Общие требования

Изложение текста и оформление пояснительной записки выполняют в соответствии с требованиями ГОСТ 7.32-2001, ГОСТ 2.105 и ГОСТ 6.38. Страницы текста пояснительной записки и включенные в нее иллюстрации и таблицы должны соответствовать формату А4 по ГОСТ 9327.

Пояснительная записка должна быть выполнена с использованием компьютера и принтера на одной стороне листа белой бумаги формата А4 через полтора интервала. Цвет шрифта должен быть черным, высота букв, цифр и других знаков — не менее 1,8 мм (кегль не менее 12). Текст пояснительной записки следует печатать, соблюдая следующие размеры полей: правое — 10 мм, верхнее — 20 мм, левое и нижнее — 20 мм. Разрешается использовать компьютерные возможности акцентирования внимания на определенных терминах, формулах, теоремах, применяя шрифты разной гарнитуры.

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

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

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

Сокращение русских слов и словосочетаний в пояснительной записке производится по ГОСТ 7.12.

Статьи к прочтению:

В чем разница между Докладными и служебными записками?

Похожие статьи: