«С. П. Гололобова, Т. А. Иваньчева В помощь дипломнику Методическое пособие Новосибирск 2009 1 Составители: Гололобова С. П., Иваньчева Т. А. В помощь дипломнику Часть 1 Содержание пояснительной записки Пособие Впомощь ...»
НОВОСИБИРСКИЙ ГОСУДАРСТВЕННЫЙ УНИВЕРСИТЕТ
ВЫСШИЙ КОЛЛЕДЖ ИНФОРМАТИКИ
С. П. Гололобова, Т. А. Иваньчева
В помощь дипломнику
Методическое пособие
Новосибирск
2009
1
Составители: Гололобова С. П., Иваньчева Т. А.
В помощь дипломнику
Часть 1
Содержание пояснительной записки Пособие «Впомощь дипломнику» предназначено для студентов 4 курса СТФ и является методическим обеспечением учебно-производственной практики. Пособие состоит из 2-х частей.
Первая часть пособия знакомит студентов с общей технологией работы над дипломным проектом, взаимодействием с руководителем, грамотным вхождением в предметную область, а также работой над текстом пояснительной записки, содержанием отдельных частей пояснительной записки.
В первой части также даются рекомендации по составлению основных документов, необходимых для допуска к государственной защите дипломного проекта.
Вторая часть пособия знакомит студентов с требованиями, предъявляемыми к оформлению пояснительной записки к дипомному проекту.
Эти требования составлены в соответствии с государственными стандартами, предъявляемыми к составлению подобного рода документов.
Авторы пособия выражают благодарность Филипповой Л. И., которой принадлежит идея создания такого пособия, а также заведующему кафедрой «Информационных технологий» Куликову А. И. за ряд ценных замечаний.
Рецензент: профессор, д.ф.-м.н. В.П. Ильин Ответственный за выпуск: А. А. Юшкова © Новосибирский государственный университет, © Гололобова С. П., Иваньчева Т. А.
Содержание Введение.......................................... 1. Этапы работы над дипломным проектом........... 1.1.Взаимоотношения РУКОВОДИТЕЛЬ-СТУДЕНТ........ 1.2. Знакомство с областью деятельности и выбор темы.....
1.3. Подготовительный этап........................ .....
1.4. Разработка проекта ПС или ПТС.................... .
1.5. Реализация ПС или ПТС........................ ....
1.6. Отладка и тестирование ПС или ПТС.................
1.7. Руководство по эксплуатации..................... ...
1.8. Работа над текстом пояснительной записки............
2. Общие требования к структуре и содержанию ПЗ.... 3. Требования к структурным элементам............. 3.1. Титульный лист................................... 3.2. Содержание....................................... 3.3. Перечень сокращений, условных обозначений, символов, единиц и терминов................................. 3.4. Введение......................................... 3.5. Основная часть.................................... 3.5.1. Постановка задачи............................. 3.5.2. Алгоритм решения задачи...................... 3.5.3. Данные ПС или ПТС........................... 3.5.4. Отладка и тестирование программного средства.... 3.5.5. Руководство пользователя....................... 3.6. Заключение....................................... 3.7. Список использованных источников.................. 3.8. Приложения...................................... Список использованных источников................. Приложение 1..................................... Приложение 2..................................... Приложение 3..................................... 1. Общие требования к структуре................... Часть Содержание пояснительной записки Введение Данное методическое пособие создано с целью - помочь дипломнику при оформлении пакета документов, необходимых для государственной защиты дипломного проекта в Высшем колледже информатики НГУ. Пособие состоит из двух частей. В пособии рассматриваются общие требования, как к содержанию (часть 1), так и к оформлению (часть 2) следующих документов:
1. Пояснительная записка к дипломному проекту.
2. Отзыв руководителя на дипломный проект.
3. Отзыв рецензента на дипломный проект.
4. Техническое задание на дипломный проект.
В первой главе кратко описаны этапы работы над дипломным проектом. Одним из результатов работы на каждом этапе является документ в виде рабочих записок. На основе этих записок создается пояснительная записка. Во второй главе основное внимание уделено содержанию пояснительной записки к дипломному проекту, как основному документу пакета. Примерный вид и общие требования к содержанию отзыва руководителя и отзыва рецензента на дипломную работу приведены во второй части данного пособия (см. прил. 4 и прил. во второй части данного пособия). Заполнение технического задания на дипломный проект также приведено во второй части данного пособия (см. прил. 6 часть 2).
Обратить внимание: название дипломной работы должно быть одинаковым во всех документах и должно точно соответствовать названию дипломной работы, утвержденной приказом.
Оформление печатных работ научного характера должно соответствовать определенным требованиям, как по содержанию, так и по оформлению. В прошедшие годы были разработаны многочисленные стандарты на различные виды документации – Единая система программной документации (ЕСПД) [1-7], Единая система конструкторской документации (ЕСКД) и др. Имеются стандарты на библиографическое описание документов, стандарты на содержание и оформление научноисследовательских работ, и многие другие.
Большая часть стандартов, созданных в период существования СССР, уже устарела. И хотя реформа системы стандартизации России действует уже несколько лет, новые стандарты Российской Федерации по интересующей нас тематике не выпущены. Поэтому при оформлении печатных документов ориентируются на существующие стандарты, действие которых никто не отменял.
Защита дипломного проекта предусматривает подготовку пояснительной записки, которая по своей сути является отчетом о научно-исследовательской работе. Поэтому в правилах оформления будем ориентироваться на ГОСТ 7.32-91 (ИСО 5966-82) «ОТЧЕТ О НАУЧНОИССЛЕДОВАТЕЛЬСКОЙ РАБОТЕ. Структура и правила оформления», входящего в Систему стандартов по информации, библиотечному и издательскому делу [1,2].
1. Этапы работы над дипломным проектом Как правило, темой дипломного проекта в ВКИ НГУ является разработка и реализация программного или программно-технического средства (ПС или ПТС), либо компоненты большого проекта. У каждого ПС или ПТС предполагается модель жизненного цикла (ЖЦ), которая определяет последовательность выполнения и взаимосвязи процессов, действий и задач на протяжении ЖЦ. Модель ЖЦ зависит от задачи, масштаба, сложности проекта и специфики условий, в которых ПС создается и функционирует. Как Вам уже известно, используются каскадные, спиральные и итерационные модели [22] в различных сочетаниях. ЖЦ делится на этапы, каждый этап характеризуется своим набором работ и результатом. Поэтапные модели обладают таким преимуществом как промежуточный контроль результатов и возможность скорректировать проект на более ранней стадии работы. Для каждой модели разработаны технологии и методологии проектирования, создания и эксплуатации ПС. Приведем наиболее подходящие методологии для работы над дипломным проектом [8,9,21]:
– ISO/IEC 12207:1995 (российский аналог — ГОСТ Р ИСО/МЭК 12207-99). Он определяет структуру жизненного цикла, содержащую процессы, действия и задачи, которые должны быть выполнены во время создания ПС или ПТС. Каждый процесс разделен на набор действий, каждое действие — на набор задач. Каждый процесс, действие или задача инициируется и выполняется другим процессом по мере необходимости, причем не существует заранее определенных последовательностей выполнения. Связи по входным данным при этом сохраняются. Стандарт ГОСТ Р ИСО/МЭК 12207-99 не предлагает конкретную модель жизненного цикла. Его положения являются общими для любых моделей жизненного цикла, методов и технологий создания ПС. Он описывает структуру процессов жизненного цикла, не конкретизируя, как реализовать или выполнить действия и задачи, включенные в эти процессы.
– Rational Unified Process (RUP - рациональный унифицированный процесс) – совокупность понятий и принципов, позволяющих на основе объектно-ориентированного программирования, создавать ПС с использованием языка UML (Unified Modeling Language).
– Экстремальное программирование ( Extreme Programming, XP). В основе методологии лежит командная работа исполнителей, эффективная и непрерывная коммуникация между заказчиком и коллективом исполнителей в течение всего проекта по разработке ПС. Разработка ведется с использованием последовательно создаваемых и дорабатываемых прототипов. Прототип - действующий компонент ПС, реализующий отдельные функции или внешние интерфейсы. Каждая итерация соответствует созданию законченного фрагмента или версии ПС.
После каждого такого шага уточняются цели и характеристики проекта, оценивается качество полученных результатов, планируются работы следующей итерации. При выборе этой методологии работы над проектом начинаются с выделения наиболее важных компонент и функций создаваемого программного средства, быстро создается прототип ПС, на нём с участием заказчика (руководителя) оцениваются и уточняются постановки задач и принятые решения. Прототипы в дальнейшем могут выбрасываться или совершенствоваться в зависимости от выбранной стратегии. В первом случае реализации очень быстрые, но невысокого качества, во втором случае создание очередного прототипа происходит более медленно, но за счет его дальнейшего использования в конечном итоге время разработки ПС сопоставимо с первым вариантом. Данная методология не применима к тем задачам, для решения которых нужны надежность, устойчивость и безопасность работы ПС.
Как правило, разработка, создание и сопровождение ПС на современном этапе ведется с использованием отдельных элементов каскадной, спиральной моделей с элементами итерационной модели с применением, на отдельных этапах методологии, экстремального программирования.
Работу над дипломным проектом условно можно разделить на следующие этапы ( все этапы должны документироваться в рабочие записки и в дальнейшем стать основой для пояснительной записки ):
1. Знакомство с областью деятельности и выбор темы.
2. Подготовительный (изучение имеющегося материала по поставленной задаче и средств разработки).
3. Разработка проекта ПС или ПТС.
4. Реализация.
5. Отладка и тестирование.
6. Создание руководства по эксплуатации, руководства пользователя.
7. Сборка текста пояснительной записки из рабочих записок, его структурирование, редактирование и оформление.
Часть работы Вами уже сделана во время выполнения проекта по специализации, но имеет смысл проанализировать и поработать над Вашим текстом, чтобы использовать его для пояснительной записки. Ниже приведем возможную краткую расшифровку каждого этапа.
1.1. Взаимоотношения РУКОВОДИТЕЛь-СТУДЕНТ При работе над дипломным проектом руководитель, по существу, является заказчиком работ, и поэтому общение с ним должно быть близким к профессиональному со стороны студента. Ваш руководитель может быть в дальнейшем сам пользователем или же пользователями будут его коллеги. Ваша задача - получить у руководителя всю необходимую информацию и оговорить условия создания ПС или ПТС. Вы должны узнать, что является более пpиоpитетным для Вашего руководителя, например, внешнее оформление или скорость работы. Для этого нужно, чтобы у студента и руководителя были близкие понятия скорости, безопасности, дизайна, простоты использования и других характеристик ПС или ПТС, используемых при постановке задачи и способах её решения. На начальном этапе, помимо постановки задачи, Вы должны выяснить у руководителя, в зависимости от задачи, примерно такую информацию:
функции, которые должны быть реализованы;
какие данные являются входными, выходными, промежуточным;
основную цель создания ПС или ПТС;
аппаратное и программное обеспечение пользователя;
выбор средств разработки;
необходимость обеспечения безопасности ПС или ПТС и данных.
Для получения информации чаще всего используется личная беседа, в ходе которой студент записывает пожелания руководителя. Можно также попросить для изучения статьи, адреса Интернет-ресурсов, отчеты и т. п.
Можно использовать метод аналогий, т. е. изучить работу пользователя с информацией, например, с данными по археологии и, на основании этого, сформулировать функциональные требования. Помните, что ошибки общения с руководителем или пользователем на раннем этапе стоят очень дорого. При встрече с руководителем студент должен представить отчет или рабочие записки (устно или письменно) о проделанной работе за отчетный период и сформулировать конкретные вопросы и предложения по работе над дипломным проектом.
1.2. Знакомство с областью деятельности Тема дипломной работы предлагается руководителем и при его непосредственном участии происходит знакомство с областью деятельности.
Получать информацию студент может не только от руководителя, но и из книг, статей, электронных ресурсов. Вся получаемая информация может документироваться в виде конспектов следующих видов:
• Свободный конспект – это текст, сочетающий цитаты с собственным пересказом содержания отдельных разделов источника. Если в пояснительной записке будет использован пересказ из источника, то ссылка на источник обязательна.
• Цитата – точная копия текста из источника, с обязательной ссылкой на этот источник. Таким образом, будет сформирован список использованных источников.
• Текстуальный конспект – собрание цитат, которые передают основное содержание источника так же со ссылкой на источник.
• Тематический конспект – свободный конспект нескольких источников по темам и со ссылками на эти источники.
Результатом знакомства с областью деятельности должна стать рабочая записка с краткой характеристикой целей и основных этапов развития этой области, её современным состоянием решенных и нерешенных проблем, вкладом предшественников и выделенной Вами проблемой, требующей Вашего решения.
Тема дипломного проекта обсуждается с руководителем и должна кратко отражаться в названии пояснительной записки.
1.3. Подготовительный этап На подготовительном этапе рекомендуется:
• Сформулировать главную проблему, требующую решения, её современное состояние и актуальность её решения Вами, цель (для чего и для кого требуется решение проблемы);
• Если проблема сложная, то её нужно локализовать (ограничить) и разбить на отдельные задачи и подзадачи, которые нужно решить для достижения цели;
• Проанализировать имеющуюся информацию по теме, выбрать и обосновать инструментарий, необходимый для решения поставленных задач;
• Составить план работы, в котором определить последовательность решения задач, предложить альтернативные варианты по решению отдельных подзадач или всей задачи в целом.
Результатом этого этапа должны быть рабочие записки с развернутой постановкой проблемы, планом предложенного Вами предварительного решения проблемы, отраженным в содержании пояснительной записки (т.е. определение структуры пояснительной записки); а так же, краткая характеристика выбранных инструментов решения поставленных задач (программных и технических). В дальнейшем подготовка дипломной работы может идти в соответствии с планом, который отражается в содержании пояснительной записки.
1.4. Разработка проекта ПС или ПТС На данном этапе необходимо чётко сформулировать общие требования (бизнес-правила ) к создаваемому ПС или ПТС, функциональные требования и требования качества и надежности.
К общим требованиям относятся требования использования бесплатных инструментов, использования специфических или устаревших технических или программных средств, повышенное требование к конфиденциальности использования информации и т.п.
Функциональные требования – это требование заказчика на наличие у ПС или ПТС определенного набора функций, которые можно разбить по категориям пользователей с учетом специфики предметной области или по подзадачам.
Требования качества и надежности ПС или ПТС также должны быть сформулированы заказчиком исходя из потребностей и наличия средств. (см. Приложение 3 к части 1) Если Ваш дипломный проект является компонентой большого проекта, то, как правило, Вашей задачей будет преобразование входной информации в требуемую выходную и, соответственно, у Вас будут требования ко всему проекту и часть требований, касающихся Вашей компоненты.
Если имеется необходимость исследования алгоритмов (математических или программных) решаемых задач или подзадач, то они проводятся на данном этапе и результаты этого исследований описываются в рабочих записках. После этого можно приступить к проектированию создаваемого ПС или ПТС с учетом сформулированных требований, произведенных исследований, имеющихся в наличии средств разработки и временных характеристик. Результатом этого этапа могут стать рабочие записки с описанием последовательности предложенных Вами решений задач, обоснованием этих предложений (эффективнее, быстрее, проще, нагляднее, впервые), блок-схемы для решения отдельных подзадач и всей задачи в целом, описания классов, интерфейсов и т.п.
1.5. Реализация ПС или ПТС Реализация Вашего проекта в зависимости от выбранной модели ЖЦ может включать в себя промежуточные стадии, где фиксируются:
• Результаты выполнения работ на каждой стадии.
• Ключевые события – точки завершения работ по отдельным подзадачам и принятия решений на этих стадиях.
Стадия – часть процесса создания ПС, ограниченная определенными временными рамками и заканчивающаяся решением конкретной задачи (создание модели, программной компоненты, документа), в полном соответствии с заданными требованиями.
На каждой стадии могут выполняться несколько процессов, определенных в стандарте ГОСТ Р ИСО/МЭК 12207-99, и наоборот, один и тот же процесс может выполняться на различных стадиях. Соотношение между процессами и стадиями также определяется используемой моделью жизненного цикла ПС.
Результатом данного этапа, помимо реализованного программного средства должны быть рабочие записки с описанием алгоритма реализации общей задачи и подзадач, выделением значимых моментов реализации, а также может быть приведена структура и схема функционирования ПС или ПТС.
1.6. Отладка и тестирование ПС или ПТС Тестирование – процесс выполнения программы или подпрограммы с целью обнаружения допущенных в ней ошибок.
Отладка направлена на локализацию и устранение обнаруженной ошибки.
Тестирование должно быть организовано по следующим принципам (согласно Майерсу [11]):
– каждый тест должен включать описание ожидаемых результатов работы программы, чтобы можно было быстро выяснить наличие или отсутствие ошибок в ней;
– желательно, чтобы кроме автора тестирование проводили и другие (пользователи или разработчики, работающие над другими компонентами);
– результаты каждого теста должны быть документированы и детально изучены, чтобы не пропустить малозаметную на поверхностный взгляд ошибку в программе;
– тесты для неправильных (непредусмотренных) данных должны подбираться так же тщательно, как и для правильных (предусмотренных) входных данных;
– при анализе результатов каждого теста необходимо проверять, не делает ли программа того, что она не должна делать;
– следует сохранять использованные тесты (для повышения эффективности повторного тестирования программы после ее модификации или установки у заказчика);
– тестирование не должно планироваться исходя из предположения, что в программе не будут обнаружены ошибки (в частности, следует выделять для тестирования достаточные временные и материальные ресурсы).
При тестировании должны быть учтены требования качества и надежности к ПС или ПТС и подобраны соответствующие тесты.
Результатом тестирования, помимо оттестированного ПС или ПТС, должны быть рабочие записки с описанием тестов и результатов тестирования. При отладке можно фиксировать трудности, возникшие на этом этапе, например, замедленное исполнение в связи с устаревшим компьютером и т.п. При необходимости можно создать тест для проверки правильности работы ПС или ПТС.
1.7. Руководство по эксплуатации Руководство по эксплуатации и сопровождению ПС или ПТС может включать в себя алгоритм ввода в эксплуатацию и настройки на работу, проверки на правильную работу ПС или ПТС, а также, описание последовательности шагов, приводящих к реализации всех функциональных требований. Как правило, текст этого раздела является HELP-ом ПС или ПТС.
1.8. Работа над текстом пояснительной записки Работа над текстом пояснительной записки подробнее описана во второй и третьей главах. Эта работа сводится к объединению всех рабочих записок и структурированию текста, согласно оглавлению, редактированию текста, согласованию с руководителем и оформлению текста, согласно требованиям, изложенным во второй части данной работы. Суть пояснительной записки сводится к ясной и простой вещи: есть область деятельности, в которой есть проблема, которую Вы можете решить полностью или частично, и этот алгоритм решения проблемы нужно описать в основной части, затем проанализировать, все ли поставленные цели достигнуты и, после этого, сделать вывод о качестве Вашего решения.
2. Общие требования к структуре и содержанию ПЗ Структурными элементами пояснительной записки к дипломному проекту являются:
• титульный лист;
• содержание;
• перечень сокращений, условных обозначений и пр.;
• введение;
• основная часть;
• заключение;
• список использованных источников;
• приложения.
Жирным шрифтом выделены обязательные элементы.
Наименования всех структурных элементов, кроме титульного листа и основной части, служат заголовками структурных элементов пояснительной записки. Основная часть текстового документа, как правило, разбивается на два, три или более разделов. Этим разделам присваиваются порядковые номера, обозначенные арабскими цифрами с точкой (например: 1.ПОСТАНОВКА ЗАДАЧИ). Пример структуры (содержания) дан в приложении 1 к части 1.
Разделы основной части могут быть разделены на подразделы, те, в свою очередь, на пункты и, при необходимости, на подпункты и т. д.
Каждое такое разделение должно быть логически обоснованным.
К написанию содержательной части пояснительной записки следует отнестись очень серьезно и вдумчиво, т. к. именно пояснительная записка полностью отражает не только уровень и качество проделанной Вами работы, но также является характеристикой Вашего профессионального уровня.
Хотелось бы в целом затронуть общие ошибки, возникающие при написании содержательной части пояснительных записок (см. Приложение 7 к части 2):
1. Нелогичное изложение всего материала и нелогичность отдельных предложений.
2. Безграмотность не только в построении фраз, но и в написании отдельных слов.
3. Частое использование технических терминов без понимания их смысла, это очень опасно, т. к. за каждое слово в пояснительной записке придется ответить на защите дипломного проекта.
4. Бездумное переписывание готовых текстов, взятых из других источников, например, из Интернета или из работ других студентов, с присущими этим текстам ошибками.
5. Игнорирование требований к содержанию пояснительной 6. Несоответствие текста пояснительной записки с тем, что реально сделано в дипломном проекте.
7. Игнорирование требований к оформлению пояснительной записки.
Следует отметить, что приводимые далее требования к содержательной части пояснительной записки являются наиболее общими и относятся к описанию работ, связанных с разработкой программных или программно-технических средств. Студентам следует подходить к описанию своей работы вдумчиво, творчески и по согласованию с руководителем изменять или удалять разделы, пункты и подпункты, упомянутые в данном документе, или добавлять необходимые разделы, пункты и подпункты, которые не упомянуты в нижеследующем описании.
Замечание. Пояснительная записка прошивается, отзыв руководителя, рецензия и техническое задание не прошиваются, а вкладываются в диплом.
3. Требования к структурным элементам В тексте Вашей пояснительной записки помимо «титула» и «содержания» должны быть обязательно разделы с такими названиями:
• введение;
• заключение;
• список использованных источников.
Обязательной является и основная часть, которая озаглавливается Вами и может состоять из одного или нескольких разделов, см. нижеприведенный текст.
Следующие разделы являются не обязательными:
перечень сокращений, условных обозначений и пр.;
приложения.
3.1. Титульный лист На титульном листе должны быть указаны следующие сведения:
• официальное название учебного заведения;
• название выпускающей кафедры;
• наименование темы дипломного проекта;
• вид материала (дипломная работа с указанием присваиваемой квалификации);
• курс, группа, инициалы и фамилия студента;
• ученая степень, научное звание, инициалы и фамилия руководителя дипломного проекта, его должность и место работы;
• место и год выполнения проекта (подготовки пояснительной записки).
Титульный лист должен быть подписан студентом и руководителем, подпись руководителя должна быть заверена печатью.
Студенту следует обратить особое внимание на то, что наименование темы дипломного проекта должно быть сформулировано совершенно одинаково во всех документах, где оно упоминается, а именно:
• в приказе по ВКИ НГУ, • в бланке задания на дипломный проект, • на титульном листе пояснительной записки (ПЗ), • в отзыве руководителя, • в рецензии.
Пример оформления титульного листа приведен во второй части данного документа (см. Приложение 2 к части 2).
3.2. Содержание Содержание является обязательным и располагается на странице 2.
Пример оформления содержания дан в приложении 2 к части 1. Названия разделов, подразделов, пунктов, подпунктов и их последовательность должны точно соответствовать их написанию и расположению в тексте ПЗ. Оформление – см. во второй части данного пособия.
3.3. Перечень сокращений, условных обозначений, символов, единиц и терминов Принятые в ПЗ малораспространенные сокращения, условные обозначения, символы, единицы и специфические термины должны быть представлены в виде отдельного списка.
Если сокращения, условные обозначения, символы, единицы и термины повторяются в ПЗ менее трех раз, отдельный список не составляют, а расшифровку дают непосредственно в тексте ПЗ при первом упоминании.
3.4. Введение В этом разделе должна быть лаконично, но очень ясно описана предметная область, решаемая Вами проблема, кратко изложен алгоритм реализации, используемые программные средства, чтобы после прочтения «Введения» становилось очевидным, что и в какой области сделано Вами. Если поставленная задача связана не только с программированием, но и созданием технического средства с программной частью, то необходимо описать как техническую, так и программную части работы.
Объем раздела «Введение» не более полутора – двух листов печатного текста, оформленного в соответствии с требованиями. В этом разделе должны быть отражены следующие вопросы:
• тема дипломной работы;
• краткое описание предметной области, например, области сайтостроения, микроэлектроники, археологии, биологии и т.п.
• краткая формулировка проблемы (задачи);
• проблема – как часть большой разработки, в рамках какой системы/подсистемы выполняется данная подзадача, или это автономная задача;
• для кого предназначена работа и где может использоваться;
• актуальность (насколько она важна, современна) и новизна темы;
• для решения поставленной задачи – какие использовались (кратко) математические алгоритмы и/или способы реализации ПС или • перечислить виды проделанной работы, например, в следующем изучена новая предметная область, и указать какая именно область;
найдены и рассмотрены существующие аналоги, перечислить их;
составлены общие требования, требования качества и надежности, функциональные требования к ПС или ПТС;
исследованы возможные способы реализации, перечислить какие именно;
изучены новые технологии и программные средства, перечислить их;
разработана и реализована объектная модель, если она есть разработана и реализована база данных;
разработано и реализовано программное средство или программно-техническое средство;
разработан и реализован пользовательский интерфейс;
научился работать в группе разработчиков;
сделан анализ проделанной работы.
• перечислить используемые технические, операционные, программные средства и технологии. Пример приведен в приложении 2 к части 1.
В списке о проделанной работе перечислять только то, что действительно Вами сделано в Вашей дипломной работе.
Допускается добавление информации помимо перечисленной, если в этом возникает необходимость и этого требует специфика решаемой Вами задачи.
3.5. Основная часть Основная часть пояснительной записки должна детально раскрыть существо решенных Вами задач и алгоритмы решений. Основная часть может состоять из следующих разделов:
• Подробная постановка задачи, в этот раздел могут входить следующие подразделы:
более подробное описание предметной области;
подробная постановка задачи;
общие требования к ПС или ПТС;
функциональные требования;
требования качества и надежности;
имеющиеся аналоги;
используемые инструменты.
• Математические алгоритмы решения задач (если они есть) и описание методов реализации ПС или ПТС, в этом разделе могут быть следующие подразделы:
исследовательская часть;
математические алгоритмы;
методы реализации ПС или ПТС;
описание интерфейсов.
• Данные ПС или ПТС, в этом разделе могут быть следующие подразделы:
входные, выходные и промежуточные данные;
базы данных, если они есть;
созданные инструменты для работы с БД.
• Структура и схема функционирования ПС или ПТС.
• Отладка и тестирование ПС или ПТС.
• Руководство пользователя ПС или руководство по эксплуатации Описанные разделы и подразделы в соответствии с Вашей работой могут удаляться, объединяться или разбиваться на более мелкие пункты и подпункты 3.5.1. Постановка задачи В данном разделе более подробно описывается предметная область, постановка задачи дается в развернутом виде с требованиями заказчика, но сформулированными с Вашей профессиональной помощью, могут быть приведены имеющиеся аналоги и охарактеризованы выбранные для достижения цели программные средства. Вся приведенная здесь информация может быть описана в одном разделе или разбита на нижеприведенные подразделы.
3.5.1.1.Описание предметной области Задача может относиться к очень сложной предметной области, с новыми понятиями, со сложной терминологией, сложными взаимосвязями между объектами, поэтому необходимым является описание этой предметной области, решенных, нерешенных или частично решенных проблем, краткой истории развития, вкладом предшественников, описанием понятий и терминов, с которыми познакомился студент.
Описание предметной области должно затрагивать более широкий и важный, чем у Вашей задачи, круг проблем, например, если у Вас задача разработки и создания микроконтроллера с программной компонентой, то имеет смысл описать область микроэлектроники.
3.5.1.2.Постановка задачи Здесь четко и ясно должно быть сформулирована суть решаемой студентом задачи. Сам ли студент поставил задачу, (ведь часто руководитель только формулирует проблему или ставит задачу в общем) или задача поставлена руководителем. Является ли задача частью сложной большой системы или это автономная задача. Как правило, задачей дипломника является разработка и создание программного средства или технического средства с программной компонентой для решения задач физики, техники, биологии, генетики, геофизики, археологии и т. п. Задача в этом случае может состоять из двух составляющих:
• проблема предметной области, например, задача создания структуры данных для более удобного и быстрого поиска информации, техническая проблема и т. п.;
• задача по проектированию и созданию соответствующего программного средства.
Например, задача создания сайта по одной из проблемных областей может быть разбита на ряд следующих подзадач:
1. Создание дизайна и структуры сайта.
2. Структуризация контента сайта.
3. Реализация основных функций сайта.
4. Тестирование сайта на совместимость с наиболее распространенными браузерами.
5. Верстка страниц, то есть создание шаблонов страниц, опираясь на готовый дизайн.
6. Проектирование и реализация базы данных.
7. Разработка и реализация инструментальных средств для работы с БД.
3.5.1.3.Требования к ПС или ПТС При постановке задачи требования к ПС или ПТС могут быть следующие:
• общие или бизнес-правила;
• функциональные;
• качества и надежности.
К общим требованиям (бизнес-правилам) относятся требования по использованию бесплатных инструментов, использованию специфических или устаревших технических или программных средств, повышенные требования к конфиденциальности использования информации и т. п.
Одним из самых важных моментов при постановке задачи является определение функциональных требований, т. е., функций необходимых пользователю, которые нужно реализовать для достижения цели.
Пользователей можно разбить на типы (если есть в этом необходимость) и перечислить функции в соответствии с их предназначением для каждого типа. Если речь идет о требованиях к ПТС, то это могут быть требования как к программной, так и к технической компоненте.
Эти требования можно оформить в виде коротких и четких предложений, описывающих функции ПС или ПТС, либо в виде диаграмм прецедентов (Use case diagram) языка UML.
Приведем один из примеров функциональных требований для задачи создания сайта. Для простоты понимания перечень функций разбит на группы в соответствии с их предназначением.
«Гостевая часть» представляет следующие возможности:
• заполнение и просмотр гостевой книги;
• просмотр каталога.
«Пользовательская часть» состоит из следующих функций:
• аутоинтефикация пользователя;
• заполнение и просмотр гостевой книги;
• просмотр каталога;
• добавление, изменение статей информации.
«Администраторская часть» предоставляет следующие возможности:
• аутоинтефикация администратора;
• добавление, удаление и просмотр гостевой книги;
• добавление, удаление, изменение и просмотр каталога;
• изменение состояния пользователей.
Функции, обеспечивающие безопасность сайта, а также его стабильную работу:
• авторизация пользователей, посещающих сайт:
• динамическая генерация страниц, то есть реализация шаблонизатора;
• реализация стандартных алгоритмов для защиты от незаконного проникновения в «закрытую» зону сайта, то есть аутоинтефикация пользователей.
Приведем пример описания функциональных требований в виде диаграмм прецедентов (Use case diagram) языка UML (рис. 3.5.1):
Имеется очень много определений понятия качество, которые в нашем случае сводятся к набору программных, технических и эксплуатационных характеристик ПС или ПТС, отвечающих требованиям заказчика (руководителя) и удовлетворяющих его при применении. Просто и точно высокое качество определено Краером [20]: «Высокое качество – это когда к разработчику возвращается заказчик, а не продукция этого разработчика». Требования качества и надежности ПС или ПТС могут быть сформулированы заказчиком работ (руководителем) с Вашей помощью или их можно выбрать из списка ГОСТ 28195-89 [11] (см. Приложение 3 к части 1) и предложить заказчику, но взять только те качественные характеристики, которые необходимы и реальны для исполнения именно Вашего ПС или ПТС.
Необходимо помнить, что любое дополнительное требование отразится на проекте ПС или ПТС, затратах и времени реализации.
3.5.1.4.Имеющиеся аналоги ПС или ПТС В этом разделе необходимо описать известные аналоги создаваемых Вами средств. Если таких работ много, то тогда надо предоставить информацию о самых используемых и качественных на данный момент времени ПС или ПТС. Аналоги могут быть не для всего ПС или ПТС, а только какой-то его части, например, только технической части или программной компоненты.
3.5.1.5.Характеристика выбранных программных сред и средств В этом разделе необходимо описать выбранные студентом или востребованные заказчиком технические средства (устройства, если использовались), операционные средства (редко используемые операционные системы), программные средства, технологии, которые выбраны для решения данной задачи. Описать достоинства и недостатки используемых средств и обосновать необходимость использования именно этих программных сред, средств и технологий. В частности, одним из достоинств может являться низкая цена программного или технического средства или бесплатность программного обеспечения, а также Ваше хорошее знание этого программного обеспечения и т. п.
3.5.2. Алгоритм решения задачи В этом разделе необходимо описать используемые математические алгоритмы решения Вашей задачи (если они есть), методы реализации ПС или ПТС (со схемами) и исследовательскую часть, если она необходима для решения Вашей проблемы. Вся информация может быть описана как в одном разделе, так и разбита, например, на нижеприведенные подразделы.
3.5.2.1.Исследовательская часть Исследовательская часть заключается в изучении и сравнении имеющихся методов решения задачи, какие достоинства и недостатки есть в каждом из способов, как использовать достоинства и избежать недостатков в предлагаемом Вами методе решения задачи.
3.5.2.2.Математические алгоритмы В этом подразделе необходимо описать используемые математические алгоритмы решения задачи с формулами и со ссылками на источники. Оформление формул и ссылок приводится во второй части данного документа.
3.5.2.3.Алгоритмы реализации ПС или ПТС Для описания алгоритма реализации ПС или ПТС могут использоваться два способа описания алгоритмов:
• Словесный, в виде последовательности шагов по реализации с описанием классов, интерфейсов, процедур, можно с программным кодом, реализующим наиболее интересные алгоритмы. Если это техническая часть, то помимо словесного описания могут быть приведены схемы технических устройств.
• Графический, в виде блок-схем обязательно с пояснениями (что за составляющие блоков и для чего, как реализуются наиболее интересные моменты алгоритма). (есть системы, с помощью которых удобно рисовать блок-схемы см., например, [12]).
3.5.2.4.Схема функционирования ПС или ПТС В этом разделе может быть полностью или частично описана структура ПС или ПТС, т. е.:
• из каких функциональных блоков (файлов, модулей, процедур, функций, классов) состоит ПС или ПТС;
• приведено описание каждого блока с его названием и назначением;
• приведена графическая схема взаимосвязи этих блоков.
Приведем небольшой пример такой схемы.
Блок «Новости » включает в себя следующие страницы:
• Index.php – главная страница;
• Addnews.php – добавление новой новости;
• EditNews.php – изменение информации о новости;
• DeleteNews.php – удаление устаревшей новости.
Пример схемы взаимодействия приведён на рис. 3.5.2.
Приведем пример схемы функционирования в виде списка последовательных предложений:
1. Приветствие – форма, с которой начинается работа пользователя 2. Начало – здесь необходимо подтвердить регистрацию или зарегистрироваться (для нового пользователя) 3. Помощь – форма помощи, для пользователей впервые работающих с системой.
4. Подтверждение – форма подтверждения «логина» и пароля для уже зарегистрированных пользователей.
5. Регистрация – форма регистрации новых пользователей.
6. Анализ – форма для пользователей. На ней расположены кнопки, по нажатию которых можно просматривать таблицы, добавлять учебники и тестировать библиотеки.
7. Просмотр и изменение – форма для создателя и экспертов. Можно просматривать все таблицы, но еще и добавлять, удалять и редактировать данные на них. А так же тестировать библиотеки.
8. Параметры – форма для просмотра данных о параметрах. Описание параметра и название.
9. Подпараметры – форма для просмотра подпараметров с их описанием, названием параметра, к которому относится данный подпараметр и коэффициентом значимости.
10. Результаты – форма с таблицей результатов.
Ниже могут быть приведены описания наиболее значимых пунктов.
3.5.3. Данные ПС или ПТС В данном разделе описывается структура входных, выходных и промежуточных данных. Например, входные данные поступают на вход программы в виде файла, значит, структура файла должна быть полностью описана. Аналогичное требование выполняется для промежуточных и выходных данных. Например, для сайтов входной информацией могут быть текстовые файлы (указать в каком формате), графическая информация (указать формат) и т. п., выходная информация – это HTML, PHP и т. п.
страницы, видимые в окне браузеров (указать, каких).
3.5.3.1.Описание базы данных В этом разделе необходимо описать структуру базы данных, если таковая имеется в Вашем проекте. Если приложение не использует базу данных, этот пункт опускается.
При описании структуры базы данных:
1. Описываются все таблицы в виде:
Имя таблицы – описание, т. е. для хранения какой информации предназначена данная таблица.
Например:
RESULT – таблица хранит информацию о результатах тестирования.
2. Описываются все поля таблицы с указанием типа, назначения, первичных и внешних ключей. Пример приведен ниже.
BOOKN VARCHAR (30) Название книги N_TESTER smallint Номер того, кто выполнял тест, внешний ключ Таблица RESULT – хранит результаты теста. По оформлению таблиц смотрите требования, описанные во второй части данного руководства.
Описание полей таблицы можно сделать в виде текста, например, так:
Таблица PARAMETRS – таблица параметров содержит следующие поля:
N_par – smallint, номер параметра, первичный ключ Naz_par – varchar(35), название параметра Opis – varchar(150), описание параметра Koeff – varchar(1), коэффициент значимости Приводится концептуальная схема базы данных (рис. 3.5.3), которая отображает взаимосвязи между таблицами, например, в стиле СУБД ACCESS.
Пример концептуальной схемы базы данных Для объектной базы данных приводится описание структуры данных всех классов, аналогично тому, как это сделано для таблиц, добавляется только описание методов.
Если Вами разработаны и созданы инструменты для работы с БД, их можно описать в данном разделе.
3.5.4. Отладка и тестирование программного средства В этом разделе необходимо указать степень отлаженности программного или технического средства. Например, указать, что программное или техническое средство полностью отлажено и сдано в эксплуатацию (например, опытную). Можно указать, прошло Ваше ПС или ПТС альфа или бета-тестирование, т. е., протестировано только разработчиком или «посторонними» коллегами. Также можно указать на каких данных, каким образом проводилось тестирование ПС или ПТС. При необходимости можно привести тест на правильность функционирования ПС или ПТС. Тесты специально разрабатываются для проверки всевозможных ситуаций работы Вашего ПС или ПТС, документируются и прилагаются результаты тестирования. По результатам тестирования ПС или ПТС может быть проведена техническая, алгоритмическая или программная оптимизация.
3.5.5.Руководство пользователя В этот раздел могут быть включены следующие пункты:
• порядок установки и настройки программного средства на компьютер пользователя или первичная настройка технического • действия пользователя в случае сбоя ПС или ПТС;
• последовательность действий пользователя для решения своих основных задач при работе с программным или техническим средством.
В этом разделе можно привести образы экранов (ScreenShots) с пояснениями для лучшего восприятия раздела. Приветствуется создание помощи по установке и эксплуатации Вашего ПС или ПТС. И текст этого раздела может совпадать с Вашим HELP-ом.
3.6. Заключение В этом разделе необходимо указать решена задача полностью или частично:
• подвести итоги проделанной работы – что сделано для решения поставленной задачи, это может быть:
разработанное и реализованное ПС или ПТС;
научно-исследовательская работа;
список решенных модельных или реальных задач;
разработаны новые математические алгоритмы;
предложен новый подход к решению подобных задач;
предложен новый метод реализации ПС или ПТС;
разработана технология решения подобных задач.
• оценить практическую значимость работы, будет ли она иметь практическое применение;
• отметить точки роста (развития) ПС или ПТС. Например:
o добавить новые функции (блоки, режимы работы);
o распространить на новый класс задач, другой тип данных;
• привести сравнительные характеристики (кратко) Вашей работы с существующими аналогами, если таковые имеются;
• перечислить виды проделанной Вами работы и полученные результаты, аналогично тому, как это сделано в разделе «Введение»
(можно просто скопировать);
• привести объем созданного Вами программного средства, в любых единицах, например, в килобайтах, строках кода, классах, процедурах, функциях и т. д.
• отразить апробацию работы: выступления на семинарах, публикации, выступления на конференциях и конкурсах (полученные дипломы, грамоты и т. п.), акты о внедрении, реально действующий 3.7. Список использованных источников Список должен содержать сведения об источниках, использованных при составлении пояснительной записки. Это могут быть книги, журнальные статьи, отчеты, препринты, Интернет-ресурсы, программная и техническая документация. На все использованные источники в тексте пояснительной записки должны быть ссылки. В списке источники следует располагать в порядке появления ссылок в тексте.
3.8. Приложения В приложения рекомендуется включать материалы, связанные с выполненным дипломным проектом, которые по каким-либо причинам не могут быть включены в основную часть.
В приложения могут быть включены:
1. тексты программ;
2. иллюстрации вспомогательного характера;
3. таблицы вспомогательных цифровых данных;
4. протоколы испытаний;
5. описание аппаратуры и приборов, применяемых при проведении экспериментов, измерений и испытаний;
6. тесты.
Список использованных источников 1. ГОСТ 7.32-91 Отчет о научно-исследовательской работе. Структура и правила оформления. — (Соотв. ИСО 5966-82). —Утв. 1980. — (Система стандартов по информации, библиотечному и издательскому делу).
2. ГОСТ 7.12-93. Библиографическая запись. Сокращение слов на русском языке. Общие требования и правила. — (Соотв. ИСО 832-94). — Взамен ГОСТ 7.12-77. — Утв. 1995. — (Система стандартов по информации, библиотечному и издательскому делу).
3. ГОСТ 2.105-95. Общие требования к текстовым документам. — Взамен ГОСТ 2.105-79, ГОСТ 2.906-71. — Утв. 1995. — (Единая система конструкторской документации) 4. ГОСТ 7.1-2003. Библиографическая запись. Библиографическое описание. Общие требования и правила составления. — Взамен ГОСТ 7.1-84, ГОСТ 7.16-79, ГОСТ 7.18-79, ГОСТ 7.34-81 и ГОСТ 7.40Утв. 2003. — (Система стандартов по информации, библиотечному и издательскому делу).
5. ГОСТ 7.83-2001. Электронные издания. Основные виды и выходные сведения. — Утв. 2001. — (Система стандартов по информации, библиотечному и издательскому делу).
6. ГОСТ 19.002-80. Схемы алгоритмов и программ. Правила выполнения. — Взамен ГОСТ 19427-74. — Утв. 1980. — (Единая система программной документации).
7. ГОСТ 19.003-80. Схемы алгоритмов и программ. Обозначения условные графические. — Взамен ГОСТ 19428-74. — Утв. 1980. — (Единая система программной документации).
8. Грекул В.И., Денищенко Г.Н., Коровкина Н.Л. Проектирование информационных систем. — М.: Интернет-университет информационных технологий - : [Электрон. ресурс].– www.intuit.ru/ [1.02.05].
9. М. Фаулер, К. Скотт UML в кратком изложении. - М.: Мир, 1999.191с.
10. Г. Майерс. Надежность программного обеспечения. - М.:Мир, 1986.с.
11. ГОСТ 28195-89 «Оценка качества программных средств».- : [Электрон. ресурс].– www.gost.ru/ [1.12.08].
12. On-line среда для создания блок-схем и диаграмм.- : [Электрон.
ресурс].–http://.flowchart.com/ [1.12.08].
13. Поттосин И. В. «Хорошая программа»: попытка точного определения понятия/ Программирование, 1997, №2, с. 3-17.
14. Елтаренко Е., Сергиевский М. Оценка аппаратных и программных средств по многоуровневой системе критериев./ Компьютер-пресс, №8, 1998, с. 268-272.
15. Антошина И. В., Домрачев В. Г., Ретинская И. В. Методика составления системы характеристик качества для программных средств.// Качество, инновации, образование, №3, 2002. – с.57-60.
16. Поттосин И. В. «О критериях добротности программ» // В сб. Системная информатика. — Новосибирск: Наука, Сиб. изд. фирма РАН, 1998. — Вып. 6. — С. 90- 17. М. Х. Холстед «Начало науки о программах». — М.: Финансы и статистика, 18. Апостолова Н. А., Гольдштейн Б. С., Зайдман Р. А. «О программометрическом подходе к оценке программного обеспечения» // Программирование. — 1995. — №4. — С. 38- 19. Черноножкин С. К. «Меры сложности программ (обзор)» // В сб. Системная информатика. — Новосибирск: Наука, Сиб. изд. фирма РАН, 1996. — Вып. 5. — С. 188- 20. Крайер Э. Успешная сертификация на соответствие нормам ИСО серии 9000: Пер. с нем. - М.: ИздАТ, 21. ИСО/.МЭК 9126 Информационные Технологии. Оценка продукции программного обеспечения. Характеристики качества и инструкции по их применению. Международная организация стандартов, Женева, 22. Липаев В. В., Качество программных средств, М., Янус-К, Пример содержания
СОДЕРЖАНИЕ
ВВЕДЕНИЕ
1. ПОСТАНОВКА ЗАДАЧИ
1.1. Характеристика предметной области 1.2.3. Требования качества и надежности 1.3. Аналоги программного средства (ПС) 1.4. Список используемых технологий2. ОПИСАНИЕ БАЗЫ ДАННЫХ
2.2. Наполнение тестовыми данными исходной базы данных3. АЛГОРИТМ РЕШЕНИЯ ЗАДАЧИ
3.1. Формализация описания поля «Заметки»3.2. Разборка текста поля «Заметки»
3.3. Алгоритм конвертации базы данных 4. ОТЛАДКА И ТЕСТИРОВАНИЕ ПРОГРАММЫ
5. РУКОВОДСТВО ПО ЭКСПЛУАТАЦИИ ПС
ЗАКЛЮЧЕНИЕ
СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ
ПРИЛОЖЕНИЕ 1. ТЕКСТ ПРОГРАММЫ
ПРИЛОЖЕНИЕ 2. ФОРМЫ Пример перечисления видов работ для «ВВЕДЕНИЯ» и «ЗАКЛЮЧЕНИЯ»Для достижения цели мною были проделаны следующие виды работ:
• изучен документооборот отдела экономических исследований;
• ознакомился с различными технологиями сайтостроения;
• изучены программное обеспечение сервера Apache и СУБД mysql;
• проанализированы различные дизайны сайтов, выбран наиболее подходящий для этой структуры;
• изучены пользователи сайта с целью выбора наиболее подходящего дизайна;
• ознакомление с контентом сайта;
• проектирование и разработка дизайна страниц сайта;
• выбор пунктов меню и структурирование контента по разделам;
• разработаны и созданы инструменты для дополнения и корректировки информации на сайте в автономном режиме;
• изучение программных средств (html, gss, php) для создания страниц сайта;
• изучение рнр для написания гостевой книги;
• создание форума в режиме on-line конференции с целью общения пользователей сайта;
• организован поиск по ключевым словам, осуществляющийся с использованием серверных средств индексирования интересующих документов и материалов по темам;
• создана страница «новости», по которой кратко собраны выписки из последних материалов, выложенных на сайте. в конце каждого нового сообщения есть ссылка с названием «подробнее», нажав на которую пользователь попадет на соответствующую страницу для того, чтобы ознакомиться с интересующим его материалом более подробно;
• для получения большего количества интересующей информации на сайте создана страница «ресурсы», на которой располагаются ссылки на сайты с похожей тематикой;
• разработана и создана гостевая книга, где пользователь может оставить сообщение и просмотреть уже имеющиеся сообщения.
Этот перечень можно разбить на два пункта:
1. проделанные виды работ;
2. полученные результаты.
Показатели качества и надежности ПС Официально определение качества программного продукта дает ГОСТ 28195-89 «Оценка качества программных средств» [11].
Этот ГОСТ определяет качество программного продукта как комплекс характеристик – показателей качества программных средств.
При создании ПТС необходимо добавить показатели качества для технического средства.
Основным документом, регламентирующим показатели качества программных средств в настоящее время является международный стандарт ISO 9126-1,2,3,4 «Информационная технология. Оценка программного продукта. Характеристики качества и руководство по их применению» [21].
ГОСТ Р ИСО/МЭК 9126 устанавливает шесть характеристик качества ПС.
Под характеристикой качества ПС, согласно этому стандарту, понимается набор свойств (атрибутов) программной продукции, по которым её качество оценивается или описывается. Определение качества и определенные в этом стандарте характеристики отражают представление пользователя о качестве ПС.
1. Функциональные возможности. Данная характеристика описывает свойства ПС в части полноты удовлетворения требований пользователя и в этом смысле является определяющей для потребительских свойств ПС. Оценка качества ПС должна начинаться с точного и формального установления предъявляемых требований, которые могут различаться для различных ПС.
Функциональные возможности - набор атрибутов, относящихся к сути набора функций и их конкретным свойствам. Функциями являются те, которые реализуют установленные или предполагаемые потребности. Данный набор атрибутов характеризует то, что ПС выполняет для удовлетворения потребностей.
2. Надежность. Специфика ПС заключается в том, что оно должно быть безотказно, а отказы проявляются из-за ошибок в требованиях, проекте, реализации.
Надежность – набор атрибутов, относящихся к способности ПО сохранять свой уровень качества функционирования в установленных условиях за определенный период времени.
3. Практичность. При оценке этой характеристики следует исходить из требований пользователя, так как пользователи разного уровня подготовленности предъявляют разные (часто взаимоисключающие) требования. Практичность – набор атрибутов, относящихся к объему работ, требуемых для исполнения определенным или предполагаемым кругом пользователей.
4. Эффективность. Оценка данной характеристики также критически зависит от требований пользователя. ПС может выглядеть неэффективным не в силу плохого кодирования, а в силу противоречивости и нереальности исходных требований. Например, требования к ПС выполнять функции на технических средствах минимальной (по объему оперативной и дисковой памяти, тактовой частоте и пр.) конфигурации компьютера противоречит требованиям о высоком быстродействии. Вообще говоря, и теория, и практика свидетельствуют, что быстродействие и объем используемой памяти являются взаимодополняющими характеристиками в том смысле, что увеличение одного приводит к увеличению другого при прочих равных условиях. Эффективность – набор атрибутов, относящихся к соотношению между уровнем качества функционирования ПС и объемом используемых ресурсов при установленных условиях.
5.,6. Сопровождаемость. Мобильность. Эти характеристики связаны с долгосрочным планированием развития ПС. Улучшение сопровождаемости и мобильности может, вообще говоря, повысить стоимость ПС в настоящий момент времени, что (многократно) окупается лишь через несколько лет. Сопровождаемость – набор атрибутов, относящихся к объему работ, требуемых для проведения конкретных изменений (модификаций). Мобильность – набор атрибутов, относящихся к способности ПС быть перенесенным из одного окружения в другое.
Ниже приводится список показателей качества по ГОСТ 28195-89.
Помимо приведенных в данном пособии списков показателей качества существует множество подходов [13-22] и к набору качественных характеристик и их интерпретации. Вы можете, исходя из целесообразности Вашей задачи, предложить свой список показателей качества и надежности. Задача выбора показателей качества для Вашего проекта зависит от требований заказчика, имеющихся технических и программных средств и Ваших возможностей, как разработчика. При описании реализации проекта следует отразить те решения, которые были предприняты Вами для достижения этих показателей и в списке проделанных Вами работ также надо отразить эти результаты.
Ниже приводится схема показателей качества по ГОСТу (Показатели сгруппированы в иерархическую структуру, которая содержит 2 уровня):
Показатели На первом уровне перечисляются комплексные показатели, а на втором – составляющие комплексного показателя.
Характеристики показателей 1. Показатели надежности Характеризуют способность ПС в конкретных областях применения выполнять заданные функции в соответствии с программными документами в условиях возникновения отклонений в среде функционирования, вызванных сбоями технических средств, ошибками во входных данных, ошибками обслуживания и другими дестабилизирующими воздействиями.
1.1. Устойчивость функционирования Способность обеспечивать продолжение работы программы после возникновения отклонений, вызванных сбоями технических средств.
1.2. Работоспособность Способность программы функционировать в заданных режимах и объемах обрабатываемой информации в соответствии с программными документами при отсутствии сбоев технических средств.
2. Показатели сопровождения Характеризуют технологические аспекты, обеспечивающие простоту устранения ошибок в программе и программных документах и поддержания ПС в актуальном состоянии.
2.1.Структурность Организация всех взаимосвязанных частей программы в единое целое с пользованием логических структур «последовательность», «выбор», «повторение».
2.2. Простота конструкции Построение модульной структуры программы наиболее рациональным с точки зрения восприятия и понимания образом.
2.3. Наглядность Наличие и представление в наиболее легко воспринимаемом виде исходных модулей ПС, полное их описание в соответствующих программных документах.
2.4. Повторяемость Степень использования типовых. проектных решений или компонентов, входящих в ПС.
3. Показатели удобства применения Характеризуют свойства ПС, способствующие быстрому освоению, применению и эксплуатации ПС с минимальными трудозатратами с учетом характера решаемых задач и требований к квалификации обслуживающего персонала.
3.1. Легкость освоения Представление программных документов и программы в виде, способствующем пониманию логики функционирования программы в целом и ее частей.
3.2. Доступность эксплуатационных программных документов Понятность, наглядность и полнота описания взаимодействия пользователя с программой в эксплуатационных программных документах.
3.3. Удобство эксплуатации и обслуживания Соответствие процесса обработки данных и форм представления результатов характеру решаемых задач.
4. Показатели эффективности Характеризуют степень удовлетворения потребности пользователя в обработке данных с учетом экономических, вычислительных и людских ресурсов.
4.1. Уровень автоматизации Уровень автоматизации функций процесса обработки данных с учетом рациональности функциональной структуры программы, с точки зрения взаимодействия с ней пользователя и использования вычислительных ресурсов.
4.2. Временная эффективность Способность программы выполнять заданные действия в интервал времени, отвечающий заданным требованиям.
4.3. Ресурсоемкость Минимально необходимые вычислительные ресурсы и число обслуживающего персонала для эксплуатации.
5. Показатели универсальности Характеризуют адаптируемость ПС к новым функциональным требованиям, возникающим вследствие изменения области применения или других условии функционирования.
5.1. Гибкость Возможность использования ПС в различных областях применения 5.2. Мобильность Возможность применения ПС без существенных дополнительных трудозатрат на ЭВМ аналогичного класса.
5.3. Модифицируемость Обеспечение простоты внесения необходимых изменении и доработок в программу в процессе её эксплуатации.
6. Показатели корректности Характеризуют степень соответствия ПС требованиям, установленным в ТЗ, требованиям к обработке данных и общесистемным требованиям.
6.1. Полнота реализации Полнота реализации заданных функций ПС и достаточность их описания в программной документации.
6.2. Согласованность Однозначное, непротиворечивое описание и использование тождественных объектов, функций, терминов, определений, идентификаторов и т. д. в различных частях программных документов и текста программы.
6.3. Логическая корректность Функциональное и программное соответствие процесса обработки данных (при выполнении задания) общесистемным требованиям.
6.4. Проверенность Полнота проверки возможных маршрутов выполнения программы в процессе тестирования.
Оформление пояснительной записки 1. Общие требования к структуре Структурными элементами пояснительной записки к дипломному проекту являются:
• титульный лист;
• содержание;
• перечень сокращений, условных обозначений и пр.;
• введение;
• основная часть;
• заключение;
• список использованных источников;
• приложения.
Жирным шрифтом выделены обязательные элементы (подробнее см. часть 1 данного пособия).
Требования по содержанию структурных элементов приведены в первой части данного пособия.
Наименования всех структурных элементов, кроме титульного листа и основной части, служат заголовками структурных элементов пояснительной записки. Основная часть текстового документа, как правило, разбивается на два, три или более разделов. Этим разделам присваиваются порядковые номера, обозначенные арабскими цифрами с точкой (например, 1.ПОСТАНОВКА ЗАДАЧИ ). Пример структуры (содержания) дан в приложении 2 к части 1.
Деление текста на самостоятельные, но взаимосвязанные части (разделы, подразделы, пункты, подпункты и т. д.) называется рубрикацией [8,9]. Это деление должно быть направлено на описание отдельных основных и вспомогательных подзадач связанных между собой. Текст при этом должен быть не слишком длинным, но и не слишком коротким.
Слишком длинный текст без рубрикации утомителен для восприятия читающего и говорит о том, что автор не представляет структуру информации, либо пишет слишком много слов на одну тему. Чрезмерно частая рубрикация мешает структурному восприятию смысла излагаемого и говорит о хаотичном представлении информации.
Разделы основной части могут быть разделены на подразделы те, в свою очередь, на пункты и, при необходимости, на подпункты и т. д.
Каждое такое разделение должно быть логически обоснованным. Помимо основной части разделы, подразделы, пункты и подпункты могут быть только в приложениях. Итак, пояснительная записка состоит из заголовков разделов, подразделов, пунктов и подпунктов и текстов. Все составляющие должны быть последовательны и связаны между собой.
Можно, например, связывать пункты, подпункты таким образом: «Как следует из вышеприведенного пункта…» или «Далее следует подробное пояснение…».
Основной текст – это текст без заголовка цельного структурного элемента (введение, заключение) или текст подраздела, пункта, подпункта основной части или приложения (если оно разбивается на подразделы, пункты, подпункты). Основной текст также разбивается на абзацы.
Несколько замечаний о стиле текста. К стилю текста пояснительной записки предъявляются такие же требования, как и к научной статье, т. е.
текст должен быть написан логично, строгим, корректным языком без художественных и лирических отступлений. Во-первых, одной из особенностей научного текста является употребление, вместо местоимения «я», «мы». Это объясняется тем, что автор тем самым показывает, что он является всего лишь одним из цепочки исследователей, занимающимся данной проблемой. Во-вторых, структура ПЗ и содержание должны однозначно и понятно показать суть проблемы (задачи), последовательность её решения и полученные результаты. Содержание разделов, подразделов, пунктов и подпунктов подробно приводится в первой части пособия. В процессе подготовки ПЗ для логической связи текста и абзацев можно использовать следующие словосочетания:
указывающие на последовательность изложения: в конце; после;
во-первых; прежде всего; впоследствии; затем; после того, как; и т. д.
указывающие на противопоставление вышесказанному: напротив;
тем не менее; однако; в то же время; между тем; тогда как; и т. д.
указывающие на следствие из вышесказанного: отсюда следует;
следовательно; поэтому; вследствие этого; потому что; и т. д.
указывающие на переход от одной мысли к другой: далее рассмотрим; прежде чем; обратимся к следующему вопросу (проблеме, задаче); остановимся на; выделим следующий момент; и т. д.
указывающие на итог от вышесказанного: в итоге; на основе сказанного; итак; таким образом; значит; в заключение приведем следующее; и т. д.
Замечание. Пояснительная записка прошивается, отзыв руководителя, рецензия и техническое задание не прошиваются, а вкладываются в диплом.
2. Правила оформления 2.1. Общие требования к оформлению Для пояснительной записки используется белая бумага формата А4.
Допускается представлять компьютерные иллюстрации, таблицы и распечатки на листах формата А3 [3].
Текст пояснительной записки (ПЗ) должен быть кратким, ясным, не содержать орфографических и грамматических ошибок. Этот текст должен быть напечатан на одной стороне листа с левым полем не менее 3 см, правым полем не менее 1 см, верхним полем не менее 1,5 см и нижним полем не менее 2см. Для задания в Microsoft Word требуемого межстрочного интервала надо в меню «Формат», «Абзац» указать интервал “Минимум” с величиной интервала 18 пт.
Текст ПЗ состоит из заголовков и основного текста структурных элементов или разделов, подразделов, пунктов и подпунктов.
Для основного текста должен использоваться шрифт Times New Roman размера 14 пт.
Опечатки и описки допускается исправлять подчисткой или закрашиванием белой краской и нанесением на том же месте исправлений машинописным способом или черной тушью.
Текст каждого абзаца должен начинаться с отступа, равного 1.5 см.
Между абзацами и внутри абзацев не должно быть дополнительных отступов или пустых строк.
При выполнении пояснительной записки необходимо соблюдать равномерную плотность, контрастность и четкость изображения по всему тексту. В тексте должны быть четкие, не расплывшиеся линии, буквы, цифры и знаки, которые должны быть одинаково черными по всему тексту.
Вписывать в отпечатанный текст отдельные слова, формулы, знаки допускается только черными чернилами или черной тушью, при этом плотность вписанного текста должна быть максимально приближена к плотности основного изображения.
Опечатки, описки и графические неточности допускается исправлять подчисткой или закрашиванием белой краской и нанесением на том же месте исправленного изображения машинописным способом или от руки черными чернилами или черной тушью.
В тексте пояснительной записки не допускается [8,9]:
• применять обороты разговорной речи, жаргонные выражения, профессионализмы, т. е. специфические выражения, используемые в узком кругу;
применять для одного и того же понятия различные научнотехнические термины, близкие по смыслу (синонимы);
применять произвольные словообразования;
использовать иностранные слова и термины – при наличии русскоязычных аналогов;
применять сокращения слов, не установленных правилами русской орфографии, соответствующими государственными стандартами, а также не указанных в Вашей пояснительной записке;
сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковиках таблиц, и в расшифровках буквенных обозначений, входящих в формулы и рисунки.
В тексте ПЗ, за исключением формул, таблиц и рисунков, не допускается:
• применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово «минус»);
• применять без числовых значений математические знаки, например, > (больше), < (меньше), = (равно), (больше или равно), (меньше или равно), (не равно), а также знаки № (номер), Нумерация страниц пояснительной записки – сквозная, включая страницы приложений, начинается с титульного листа, но номер страницы на нем не печатается. На странице с номером 2 помещается содержание, на третьей странице – перечень сокращений, если он имеется, иначе — введение, и т. д. Номера страниц документа проставляются арабскими цифрами в правом верхнем углу без точки в конце. Для вставки номеров страниц в Microsoft Word используется пункт меню Вставка | Номера страниц.
2.1.1. Единицы измерения в MICROSOFT WORD В текстовом редакторе Microsoft Word линейные размеры можно указывать в нескольких единицах. Ввод размерной величины производится в форме: 1 cm или 2.3in или 4.5 li. При вводе числа без указания размерности Word использует единицы измерения по умолчанию (см. меню:
«Сервис», «Параметры», «Общие», «Единицы измерения» («Tools», «Options», «Gene-ral», «Measurement units»)).
измерения латинское русское Соотношения единиц Сантиметр Дюйм (inch) Строка (line) Пика (pica) Пункт (point) Следует отметить важное различие в определении межстрочного интервала в Word 2.0 и 6.0/7.0. Межстрочный интервал «Одинарный»
(«Single», см. Формат Абзац (Format Paragraph)) в Word 2.0 соответствует расстоянию между строками в 1 li и не зависит от высоты букв, а в Word 6.0/7.0 этот интервал соответствует межстрочному расстоянию, равному высоте букв абзаца. Для задания в Word 6.0/7.0 независимого от высоты букв межстрочного интервала надо использовать интервал «Минимум» с указанием величины интервала числом (например, полтора интервала соответствуют установке «Минимум 18 пт»).
Аналогично обстоят дела и с интервалами «Полуторный» и «Двойной»
(«1.5 line» и «Double»).
2.1.2. Заголовки Следующим структурным элементам номера заголовков не присваиваются:
• СОДЕРЖАНИЕ • ВВЕДЕНИЕ,
• СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ
• ПРИЛОЖЕНИЕ Эти заголовки пишутся без нумерации; кроме того, эти структурные элементы не имеют разделов, подразделов и т. д. В ПЗ может быть несколько приложений, и они нумеруются следующим образом: ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т. д.Основная часть ПЗ, как правило, состоит из нескольких пронумерованных разделов. Заголовки структурных элементов и разделов выполняются жирным шрифтом, прописными буквами, без переносов с выравниванием по центру.
Каждый структурный элемент и раздел следует начинать с новой страницы.
Разделы делятся на пронумерованные подразделы, подразделы делятся на пронумерованные пункты, а те, в свою очередь, – на подпункты и т. д. Подразделы имеют нумерацию в пределах раздела (общий номер подраздела состоит из номера раздела и номера подраздела, разделенных точкой, например, 1.1., 1.2. и т. д.), пункты – в пределах подраздела (1.1.1., 1.1.2.), подпункты — в пределах пункта (1.1.1.1., 1.1.1.2.). Подразделы, пункты и подпункты имеют собственные заголовки. Заголовки подразделов, пунктов и подпунктов следует начинать с абзацного отступа и печатать строчными буквами, не подчеркивая, без точки в конце. Каждый заголовок должен быть указан в содержании. Деление текста на подразделы, пункты и подпункты должно быть логически обоснованным.
Заголовки по возможности следует делать краткими, но не до абсурда.
Слишком краткие заголовки, особенно, состоящие из одного слова, могут потерять всякую конкретность и быть слишком общими. Если заголовок включает несколько предложений, (это следует делать только в крайнем случае) их разделяют точками. В конце заголовков точка не ставится. Переносы слов в заголовках не допускаются.
Шрифт заголовков одного уровня рубрикации должен быть единым по всему тексту и отличаться от остальных шрифтов. Например, заголовки подразделов можно выполнять жирным шрифтом, пунктов – жирным курсивом, подпунктов – курсивом. Подчеркивание в заголовках и тексте не рекомендуется. Допускается увеличивать размер шрифта заголовков до 16-18 пт.
Заголовки следует отделять от основного текста вертикальными отступами сверху и снизу. Аналогично шрифту, вертикальные отступы перед заголовком и после него в зависимости от уровня рубрикации могут иметь разное значение:
• после заголовка структурного элемента или раздела — 18 пт;
• перед заголовком подраздела — 18пт, после — 12пт;
• перед заголовком пункта — 12пт, после — 9пт;
• перед заголовком подпункта — 9пт, после — 6пт.
При оформлении работы программой Microsoft Word размер дополнительных пробелов устанавливается в меню Формат | Абзац | Интервал | после, как показано на рис.4.
Заголовки рисунков и таблиц выравниваются горизонтально по центру относительно рисунка или таблицы.
2.1.3. Нумерация в ПЗ Номер страницы ставится в правом верхнем углу каждой страницы, кроме титульного листа. Титульный лист считается первой страницей.
Заголовки разделов основной части, пунктов и подпунктов нумеруются последовательно арабскими цифрами. Номера заголовков пунктов и подпунктов включают номера всех вышележащих разделов. В конце номера должна стоять точка. После заголовка пунктов и подпунктов до конца страницы должна быть напечатана хотя бы одна строка текста.
Разделы «Введение», «Заключение», «Список использованных источников» не нумеруются.
Рисунки, таблицы и формулы нумеруют последовательно арабскими цифрами. Нумерация может быть сквозная («Рис. 12.») или в пределах раздела («Рис. 3.10.»). Сквозная нумерация означает нумерацию по всему тексту, независимо от его разбиения на разделы и подразделы. Для каждого вида (рисунки, таблицы, формулы) своя нумерация. При двойной нумерации первым числом ставится номер раздела (приложения), за ним через точку ставится порядковый номер рисунка, таблицы или формулы в разделе (приложении). Например, для первого рисунка в подразделе 2.3. будет номер рисунка Рис.2.3.1., для таблицы – Таблица 2.3.1.
и т. д. В приложении рисунки и таблицы нумеруются с добавлением буквы «П» :
• «Рис. П.10.», «Таблица П.2.», если приложение одно ПЗ;
• «Рис. П.2.5.», «Таблица П.1.1.», если приложений больше одного.
Ссылки на использованные источники нумеруют сквозной одинарной нумерацией в косых чертах или квадратных скобках в порядке появления в тексте (например: /2/ или [2] или [3-9] или [3-5,8,11-24]) т. е., первая ссылка в тексте должна быть на первый источник в списке использованных источников.
Если в основной части (приложении) только один рисунок (одна таблица или формула), они могут не нумероваться и слова «Рис.» («Таблица») не пишутся.
Использованные источники информации описываются в списке использованных источников, а в тексте ПЗ даются ссылки на это описание.
2.2. Оформление титульного листа Титульный лист является первой страницей пояснительной записки, входит в общее число страниц, но номер страницы на нем не печатается.
Образец титульного листа дан в приложении 1 к части 2. Но его не надо слепо копировать. Во втором приложении приведен конкретный пример оформления титульного листа. Название дипломного проекта пишется без кавычек. Проследите, чтобы тема дипломного проекта точно соответствовала ее написанию в приказе на утверждение тем дипломных работ. Вместо слов «должность место работы» нужно указать должность и место работы Вашего научного руководителя, например:
Научный руководитель к.т.н., с.н.с. ИВМиМГ СО РАН Названия должности, института и ученые степени пишутся сокращенно. Допустимые сокращения:
м.н.с. — младший научный сотрудник;
н.с. — научный сотрудник;
с.н.с. — старший научный сотрудник;
зав. лаб. — заведующий лабораторией;
зав. отд. — заведующий отделом;
к.ф.-м.н. — кандидат физико-математических наук;
д.ф.-м.н. — доктор физико-математических наук;
к.т.н. — кандидат технических наук;
д.э.н. — доктор экономических наук и т.п.
К моменту защиты дипломного проекта на титульном листе должны стоять подпись научного руководителя, заверенная печатью, и подпись студента.
2.3. Оформление содержания Содержание является обязательным и располагается на странице 2.
Шрифт и наименование заголовков должны соответствовать их написанию в тексте, только размер шрифта должен быть 14 пт, но при этом заголовки первого уровня могут выделяться большими буквами, подпункты, например, – курсивом. Содержание должно быть напечатано шрифтом Times New Roman 14 пт с интервалом между строк Минимум 18 пт.
Если Вы весь текст оформили в Microsoft Word правильно, то содержание (оглавление) должно быть создано Вами автоматически. Это условие является обязательным при оформлении ПЗ. При автоматическом формировании содержания параметры типа и размера шрифта устанавливаются вручную. Номера страниц должны быть выровнены по правой границе поля. Заполнитель строк — точки.
Заголовки одного уровня вложения должны быть выровнены по одной вертикальной границе. Заголовки нижнего уровня печатаются с отступом вправо по отношению заголовков верхнего уровня.
Пример оформления содержания дан в приложении 3 к части 2.
2.4 Оформление перечня сокращений и терминов Принятые в ПЗ малораспространенные сокращения, условные обозначения, символы, единицы и специфические термины должны быть представлены в виде отдельного списка.
Если сокращения, условные обозначения, символы, единицы и термины повторяются в ПЗ менее трех раз, отдельный список не составляют, а расшифровку дают непосредственно в тексте ПЗ при первом упоминании.
2.5. Оформление основного текста Основной текст – это текст без заголовка цельного структурного элемента (введение, заключение) или текст подраздела, пункта, подпункта основной части или приложения (если оно разбивается на подразделы, пункты, подпункты). Деление текста на самостоятельные части (разделы, подразделы, пункты, подпункты, абзацы и т. д.) называется рубрикацией [8,9]. Это деление должно быть логически обоснованным и связанным между собой и при этом быть не слишком длинным, но и не слишком коротким. Слишком длинный текст без рубрикации утомителен для восприятия читающего и говорит о том, что автор не представляет структуру информации либо пишет слишком много слов на одну тему.
Чрезмерно частая рубрикация мешает структурному восприятию смысла излагаемого и говорит о хаотичном представлении информации.
В процессе подготовки ПЗ для логической связи текста и абзацев можно использовать следующие словосочетания:
указывающие на последовательность изложения: в конце; после; во-первых; прежде всего; впоследствии; затем; после того, указывающие на противопоставление вышесказанному: напротив;
тем не менее; однако; в то же время; между тем; тогда как; и т. д.
указывающие на следствие из вышесказанного: отсюда следует;
следовательно; поэтому; вследствие этого; потому что; и т. д.
указывающие на переход от одной мысли к другой: далее рассмотрим; прежде чем; обратимся к следующему вопросу (проблеме, задаче); остановимся на; выделим следующий момент; и т. д.
указывающие на итог от вышесказанного: в итоге; на основе сказанного; итак; таким образом; значит; в заключение приведем следующее; и т. д.
Смысл сводится к последовательному изложению решения подзадач и задачи в целом. Можно, например, связывать пункты, подпункты таким образом: «Как следует из вышеприведенного пункта…» или «Далее следует подробное пояснение…». Для оформления основного текста должен использоваться шрифт Times New Roman размера 14 пт. Красная строка должна отступать на 1.5 см от левого края текста.
2.6. Оформление иллюстраций Иллюстрациями называются любые графические материалы: рисунки, фотографии, схемы, блок-схемы, графики, screen-short и т. п. Фрагменты текстов программ также оформляют как иллюстрации.
Иллюстрации должны быть напечатаны или выполнены черной пастой (тушью). Допускается выполнять иллюстрации на отдельном листе (если рисунок не входит на неполную страницу) и включать их в текст.
Допускаются иллюстрации, напечатанные на цветном принтере.
Иллюстрации должны располагаться после первой ссылки на них в тексте пояснительной записки.
Иллюстрация должна состоять из: 1) названия, 2) графического изображения, 3) пояснительной надписи (не обязательно) и 4) номера. Пример оформления иллюстрации приведен ниже.
Иллюстрацию центрируют на странице или сдвигают влево или вправо так, чтобы текст обтекал рисунок, но только с одной стороны.
Название иллюстрации, подрисуночный текст и номер центрируют относительно иллюстрации.
В названии иллюстрации и подрисуночном тексте допускается использовать меньший размер шрифта (8-12 пт).
Иллюстрация обозначается словом «Рис.1.1», которое помещают после поясняющих данных. Между номером иллюстрации и дальнейшим текстом должен быть дополнительный отступ (задается в меню Формат | Абзац | Интервал | после 6 пт).
Иллюстрацию следует выполнять на одной странице. Если иллюстрация не умещается на одной странице, можно переносить ее на другие страницы, при этом название иллюстрации помещают на первой странице, поясняющие данные – на каждой странице и под ними указывают номер рисунка и номер листа, например: «Рис.1.5., лист 1.», «Рис.1.5., лист 2.».
2.7. Оформление блок-схем Блок-схемы графически изображают алгоритм решения задачи.
Основные графические символы и соотношения размеров сторон приведены в таблице [6,7].
После приведенной блок-схемы ниже должны быть даны пояснения общего характера и пояснения по поводу отдельных блоков схемы. Перед блок-схемой также должен быть текст, т. е., одна блок-схема без текста в разделе, подразделе, пункте или подпункте не допускается.
3.Предопределенный Использование ранее процесс 4.Ввод-вывод Преобразование данных 5. Ручная операция Автономный процесс, 6. Ручной ввод Ввод данных вручную при 8. Линия потока Указание 9. Соединитель Указание связи между 10. Пуск - останов Начало, конец, 11. Комментарий Связь между элементом Размер a должен выбираться из ряда 10, 15, 20 мм. Допускается увеличивать размер a на число, кратное 5. Размер b равен 1,5a. На отдельной блок-схеме размеры a и b должны быть фиксированными.
Линии потока должны быть параллельны и перпендикулярны сторонам листа. Располагать их под иным углом не допускается.
Направления линии потока сверху вниз и слева направо принимают за основные и, если линии потока не имеют изломов, стрелками можно не обозначать. В остальных случаях направление линии потока обозначать стрелкой обязательно.
Пример блок-схемы приведены на рис.6.
Зарегистрированы?
Ниже блок-схемы должен идти поясняющий текст.
2.8. Оформление таблиц Таблицы используются для размещения цифрового или структурированного текстового материала. Таблицы должны располагаться после первой ссылки на них в тексте пояснительной записки.
Строятся таблицы в соответствии со схемой, приведенной на рис. 7.
Таблица должна состоять из:
1) номера таблицы;
2) названия таблицы;
3) таблицы.
При размещении таблиц на странице следует руководствоваться теми же правилами, что и для рисунков.
Номер следует размещать в правом верхнем углу над заголовком таблицы после слова «Таблица».
Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф - со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе.
Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.
Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей.
Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф.
Головка таблицы должна быть отделена линией от остальной части таблицы.
Таблицу следует располагать непосредственно после текста, в котором она упоминается впервые, или на следующей странице. На все таблицы должны быть ссылки в тексте пояснительной записки.
Если таблица продолжается на нескольких страницах, то на первой странице после шапки таблицы (строки с названиями столбцов) добавляется строка с номерами столбцов. На второй и последующих страницах должна быть надпись: «Продолжение табл.», оформленная так же, как номер таблицы (например: «Продолжение табл. 2.2»), а в продолжении таблицы первой ставится строка с номерами столбцов. Названия столбцов таблицы на последующих листах не пишутся.
Отдельная колонка (№ п/п), содержащая нумерацию строк, в таблицу включаться не должна. Нумерацию строк, при необходимости, проставляют в первом столбце таблицы, отделяя от текста точкой.
Числовые данные в колонках таблицы должны быть выровнены по десятичному разделителю.
Ниже приведем пример оформления таблицы с продолжением на другой странице:
Имя поля Пояснение Id Уникальный номер пользователя Email Электронный почтовый ящик Name1 Имя пользователя-редактора Adm Значение 1 или 0, для идентификации администратора Datetime Дата и время сообщения Name_U Логин пользователя, который оставил сообщение Email_U Электронный почтовый адрес автора сообщения www Домашняя страничка автора сообщения Message Сообщение пользователя Date Дата публикации новости Full_text Полный текст новости Name_F Название файла, которое будет отображаться на сайте Data_LOAD Дата закачки (загрузки) Filename Название файла для скачки Id_L Уникальный номер учебника Data_L Дата закачки учебника T_name Название таблицы, в которой хранятся данные этого Обратите внимание, что таблицы с продолжением на другой странице и без продолжения оформляются по разному. Если таблица продолжается, то столбцы имеют номера, как в приведенном примере 1 и 2, и эти номера являются второй строкой таблицы, а при оформлении продолжения уже не имена столбцов указываются, а их номера.
Текст, повторяющийся в строках одной и той же графы и состоящий из одиночных слов, чередующихся с цифрами, для сокращения заменяют кавычками ( ). Если повторяющийся текст состоит из двух и более слов, при первом повторении его заменяют словами «То же», а далее – кавычками. Заменять кавычками повторяющиеся в таблице цифровые данные, математические знаки, знаки процента не допускается.
При отсутствии отдельных данных в таблице следует ставить прочерк (тире).
2.9. Оформление формул Формулы должны быть напечатаны или вписаны в текст черной пастой (тушью).
Формулы на отдельной строке должны быть выровнены горизонтально по центру текстового поля. Номер формулы в круглых скобках центрируется вертикально относительно формулы и помещается у правой границы станицы.
Уравнения и формулы следует выделять из текста в отдельную строку. Между текстом и формулой на отдельной строке должен быть отступ 12 пт. Если уравнение не умещается в одну строку, оно должно быть перенесено после знака равенства (=) или после знаков плюс (+), минус (-), умножения (), деления (:), или других математических знаков. Причем знак должен присутствовать в конце строки и дублироваться в начале следующей строки.
Если в ПЗ только одна формула или уравнение, их не нумеруют.
Пояснения символов и числовых коэффициентов, входящих в формулу, если они не пояснены ранее в тексте, должны быть приведены непосредственно под формулой. Пояснения каждого символа следует давать с новой строки в той последовательности, в которой символы приведены в формуле. Первая строка пояснения должна начинаться со слова «где»
без двоеточия после него.
Пример:
Плотность каждого образца, кг/м3, вычисляют по формуле где m - масса образца, кг;
V - объем образца, м3.
Верхние (нижние) индексы в формулах должны быть смещены вверх (вниз) на величину 0.20.3 и иметь размер 0.50.6 относительно размера символа, к которому они приписаны. Например, Aij.
Формулы, следующие одна за другой и не разделенные текстом, разделяют запятой.
2.10. Оформление ссылок На каждый рисунок, таблицу, формулу, приложение и литературный источник в тексте пояснительной записки обязательно должна быть ссылка. Первичные ссылки следует оформлять по следующим образцам:
• на формулу: В выражении (5.1)... Решая систему уравнений (5.2)...
• на рисунок: На рис. 4.1 изображено… В результате решения получим зависимость скорости от частоты (рис. 4.3)… • на таблицу: В табл. 2.2 приведены данные… • на приложение: Образец оформления дан в прил. 2 … • на литературный источник: … [2-4,7].
Повторные ссылки на рисунки, таблицы и приложения начинаются сокращенным словом «см.» (например: см. рис. 4.3, см. табл.2.2).
2.11. Оформление списка использованных источников Список должен содержать перечень источников, на которые имеются ссылки в тексте пояснительной записки. В качестве источников могут быть книги, журнальные статьи, препринты, Интернет-ресурсы, отчеты, электронные ресурсы на CD, программная и техническая документация.
Список приводится в порядке появления ссылок в тексте пояснительной записки, т. е. первая в тексте ссылка должна быть на первые по списку источники. Сведения об источниках следует давать в соответствии с [4,5].
Сведения об источнике состоят из двух частей:
1. Название статьи (книги). Состоит из:
списка авторов в виде: Фамилия1 И.О., Фамилия2 И.О.;
заголовка статьи (книги).