ИТМ_1 курс_заочникам / Описание проектных решений (правила оформления реферата)

Таблица 7 – Требования к наличию полей титульного листа отчета

Примечание: 9а – подписи студента и руководителя (преподавателя), 9б – подписи консультантов и рецензента

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

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

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

2.3 Реферат

Рефератсодержиткраткиесведенияоботчете, помогающие читателю выяснить, в чем состоит смысл описываемой работы. Чтобы ответить на этот вопрос, вы должны предельно четко и кратко изложить основные мысли и практические сведения отчета, использовав при этом объем порядка половины страницы. Реферат оформляется в соответствии со стандартом [1] и включает в себя следующую информацию.

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

22

2.5 Нормативные ссылки

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

В зависимости от широты применения все стандарты можноусловноразделитьначетырегруппы: международные(например, ИСО, МЭК), государственные – ГОСТ (в СНГ ГОСТы используются в качестве межгосударственных стандартов), отраслевые (корпоративные) и стандарты предприятия. Последние обычно разрабатываются на основе государственных и отраслевых стандартов и используются в пределах одного предприятия. Например, данное учебное пособие можно рассматривать как стандарт ИАТЭ на подготовку учебных отчетов.

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

2.6 Определения

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

24

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

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

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

Использование сокращений (аббревиатур) и условных обозначений значительно облегчает текст отчета, делая его более компактным и удобочитаемым. Помимо общеизвестных аббревиатур, таких как АСУ, ЭВМ, АЭС и других, Вы можете вводить и свои сокращения, отражающие наиболее часто повторяющиеся понятия вашей предметной области. Вводя такие сокращения, Вы должны дать их расшифровку непосредственно в тексте отчета при первом упоминании (например, «... особое место в человеко-машинных системах (ЧМС) занимает проблема

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

Перечень сокращений оформляется на отдельной странице и начинается с заголовка Обозначения и сокращения, напечатан-

25

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

2.8 Введение

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

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

Введение должно быть кратким, конкретным и не превышать объем 2-3 страниц. Совершенно необязательно начинать его с пространных литературных штампов, типа «... в наше время энергия мирного атома является одной из движущих сил на- учно-технического прогресса». Однако, если Вы затрагиваете в работе проблему надежности оператора АЭС – покажите во введении, что от надежности оперативного персонала (а не только оборудования) непосредственнозависяттакиеважнейшиерезультирующие свойства АЭС как безопасность и эффективность. Отметьте при этом, что АЭС относится к классу сложных чело- веко-машинных систем. Убедите читателя, что серьезное решение задач, связанных с анализом, прогнозированием и обеспече-

26

Рисунок 6 – Пример диаграммы влияния основных понятий отчета

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

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

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

27

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

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

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

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

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

29

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

мящемся к полноте и завершенности своего продукта.

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

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

Итак, мы определили четыре аспекта рассмотрения существа любой работы, составляющие основную часть отчета: ме-

тодология, метод, методика (алгоритм), результат (рисунок8).

Рисунок 8 – Последовательность изложения существа работы и соответствующие структурные элементы отчета

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

30