— Сведения об издании: содержат сведения о повторности издания, его переработке и т.п.
— Место издания: Издательство или издающая организация, дата издания.
— Объем: сведения о количестве страниц, листов.
Если используется составная часть издания (например, статья в журнале или сборнике), то составляется аналитическое описание в следующем виде:
Сведения о составной части // Сведения о документе, в котором помещена составная часть.
Первая часть библиографического аналитического описания содержит сведения об авторах, заглавии, сведения, относящиеся к заглавию. Во второй части (после //) приводится краткое библиографическое описание документа, в котором опубликована составная часть (автор, если он не совпадает с автором составной части, заглавие, сведения, относящиеся к заглавию; сведения об ответственности, которые приводятся в основном для сборников научных трудов; сведения об издании, месте и годе издания), а также указываются страницы, на которых помещена данная статья или раздел. В случае с сериальными изданиями или многотомниками дополнительно указывается номер тома или выпуска.
Приведем примеры.
Описание книги одного автора. Место издания указывается сокращенно для следующих городов: Москва – М., Санкт-Петербург – СПб (Ленинград – Л.), Киев – К., Минск – Мн. Перед названием издательства указывается двоеточие. Области описания отделяются тире.
1. Касаткин А.И. Профессиональное программирование на языке Си. Управление ресурсами: Справ. пособие / А.И. Касаткин. – Мн.: Высш. шк., 1992. – 432 с.
2. Павловская Т.А. С/С++. Программирование на языке высокого уровня / Т.А. Павловская. – СПб.: Питер, 2008. – 461 с.
Описание книги 2-х, 3- х авторов. В заголовке описания книги двух или трёх авторов приводят фамилию одного автора, как правило, первого из указанных на титульном листе.
1. Павловская Т.А. С/С++. Объектно-ориентированное программирование: Практикум / Т.А. Павловская, Ю.А. Щупак. – СПб.: Питер, 2008. – 265 с.
Описание книги 4-х и более авторов.
1. Основы криптографии: Учебное пособие / А.П. Алферов, А.Ю. Зубков, А.С. Кузьмин и др. – М.: Гелиос АРВ, 2001. – 480 с.
Описание статьи, входящей в книгу. Указываются страницы, принадлежащие статье.
1. Хоор К. О структурной организации данных / У. Дал, Э. Дейкстра,
К. Хоор // Структурное программирование. – М.: Мир, 1975. – С. 98-197.
Описание статьи из журнала. Если статья разбита на несколько номеров журнала, описание для каждого номера дается через точку с запятой.
1. Иванов И.И. Поиски киберов / И.И. Иванов // Доклады РАН. – 2005.
– Т. 2, № 4. – С. 234-237.
2. Меффорд М. Клавиатура от A до Z / М. Меффорд // КомпьютерПресс.
– 1991. – № 11, С. 29-39; № 12, С. 41-55.
3. Sidorov I.S. The axiomatic theory of relativity / I.S. Sidorov // Russian Math. Surv. – 1982. – V. 37, N. 2. – P.41-80.
Описание технического руководства. Если не указаны место или год издания, в квадратных скобках добавляется информация, не содержащаяся в издании. Для этого используются сокращения: без года – б.г. (т.е. не указан год издания), без места – б.м. (не указано место издания). В текстах, набранных латиницей, используются соответственно сокращения - s.a. (sine anno), s.l. (sine loco).
1. Turbo Debugger. Version 2.5. User's Guide. Borland International. – [s.l.] (USA), 1991.
Описание электронного ресурса.
Ресурс локального доступа.
1. Цветков В.Я. Компьютерная графика: рабочая программа [Электронный ресурс] / В.Я. Цветков. – Электрон. дан. и прогр. – М.: МИИГАиК, 1999. – 1 дискета. – Систем. требования: IBM PC, Windows 95, Word 6.0. – Загл. с экрана. – № гос. регистрации 0329900020.
Ресурс удаленного доступа. В скобках указывается дата обращения к документу.
1. Адигеев М.Г. Введение в криптографию [Электронный ресурс] / М.Г. Адигеев. – Режим доступа: http://www.ict.edu.ru/ft/004793/Crypto-1.pdf (10.10.2008).
Описания источников в библиографическом списке должны быть пронумерованы и расположены по алфавиту авторов.
Сначала располагаются издания на русском языке, а затем на иностранных языках.
На все источники в библиографическом списке должны быть ссылки в тексте пояснительной записки (например, [1], или [1, с.129], или [1, 5, 8–12]).
Описание алгоритма должно быть дано простым, понятным языком. Следует подробно описывать алгоритм не всей программы, а только нетривиальной ее части, понимание которой может вызвать затруднения. Так, не нужно детализировать описание начального диалога программы с пользователем, когда запрашиваются некоторые параметры и проверяется их принадлежность некоторому диапазону.
В описании алгоритма не следует использовать внутренних имен функций и модулей, из которых состоит программа. Следует давать им названия, отражающие смысл. При описании программного обеспечения желательно дать таблицу соответствия содержательных и формальных имен. Например, если в программе, функция, выполняющая оценку точности решения, носит имя accur(), то в описании алгоритма следует использовать осмысленное название «модуль оценки точности». В тексте программы в свою очередь должен быть комментирующий текст, поясняющий читателю назначение функции accur().
Отметим, что не во всякой дипломной работе можно говорить об алгоритме в строгом смысле этого слова. Допустим, разрабатывается программа на языке Пролог. Тогда алгоритм скрыт в используемых языковых средствах, и уместнее говорить о сценарии работы программы. Это же касается использования прикладных программных пакетов, предназначенных, например, для моделирования динамических систем. В общем, термин «алгоритм» можно использовать и в этом случае, но понимать его в расширительном смысле, как алгоритм взаимодействия пользователя с прикладной программной системой. Синонимами здесь будут такие термины как «сценарий», «методика», «последовательность действий».
Итак, выбор адекватного языка описания алгоритма представляет собой нетривиальную задачу и должен производиться взвешенно. Здесь полезны обсуждения с руководителем и консультантом.
3.4. Описание программного обеспечения
Требования к объему и детализации описания программного обеспечения зависят от задач и характера дипломной работы, от объема разрабатываемых программ. Программное обеспечение должно быть описано в соответствии с основными требованиями ГОСТов, составляющих Единую систему программной документации (ЕСПД). В реальной практике в техническое задание (ТЗ) включается раздел «Требования к программной документации», в котором определяется состав документов, передаваемых Заказчику вместе с программным обеспечением: например, «Руководство системного программиста», «Руководство оператора», «Программа и методика испытаний» и т.д. В документах имеются повторяющиеся разделы (например, «Назначение программы»), поэтому в дипломной работе нецелесообразно педантично воспроизводить форму этих документов. Достаточно продемонстрировать умение описывать программное обеспечение так, что из пунктов описания легко потом скомпоновать документы, определенные ТЗ. При наиболее полном описании разработанного программного обеспечения рекомендуем раскрыть в дипломной работе следующие пункты (они выбраны из ЕСПД).
1) Общие сведения о программе (программном комплексе – далее это уточнение будет опускаться).
Здесь указываются:
· обозначение и наименование программы;
· программное обеспечение, необходимое для функционирования программы;
· языки программирования, на которых написана программа;
· основные характеристики: объем и время работы программы.
Остановимся подробнее на последнем пункте. Объем программы измеряется дважды: во-первых, определяется объем исходных текстов программ, во-вторых, объем исполняемых модулей. Полезно также указывать объемы, полученные в результате архивации файлов каким-либо популярным архиватором.
2) Функциональное назначение.
Указываются классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на ее применение.
3) Структура программы. Программное обеспечение обычно создается коллективом разработчиков (бригадой программистов), дипломник разрабатывает часть модулей. Следует в общих чертах описывать всю систему и подробно - модули, разработанные автором.
Структуру взаимодействия модулей предпочтительно изображать в виде графа подчиненности модулей, чтобы наглядно показать иерархическую структуру комплекса. Служебные подпрограммы, используемые практически всеми модулями комплекса, целесообразно показывать отдельно, чтобы не загромождать схему большим количеством связей. Для каждого модуля приводится его название и описывается назначение.
Для графического представления объектно-ориентированных систем следует использовать унифицированный язык моделирования UML.
4) Используемые технические средства. Здесь перечисляется минимальный состав технических средств, обеспечивающий работу программы: тип процессора, объем оперативной памяти, наличие жесткого диска, требуемый объем дискового пространства, тип дисплейного адаптера, наличие принтера и его тип, какое-либо специализированное оборудование.
5) Требования к программному окружению. Операционная система и ее минимально допустимая версия, наличие в оперативной памяти специализированных драйверов, используемые стандартные библиотеки.
6) Настройка программы (процедура инсталляции) – какие действия должен предпринять программист при установке программы на жесткий диск. Желательно описать командный файл, автоматизирующий процедуру инсталляции, сводящий ее к диалогу с программистом.
7) Эксплуатация программы.
7.1) Описание входных данных.
Входная информация разделяется на переменную и постоянную. Например, программы, эксплуатируемые на производственном участке, читают нормативно-справочную информацию из файлов, содержимое которых обновляется достаточно редко. В то же время оперативный план может меняться ежедневно.