использовании и т.д.;
- исходные тексты модулей с достаточно подробными комментариями, необходимые для сопровождения и модификации вашего продукта. (При большом их объеме достаточно распечатать только ключевые модули и заголовочные файлы.)
Кроме того, в приложения выносятся распечатки результатов тестирования, испытаний и примеров применения программы, подтверждающие ее работоспособность и полезность, а также части, композиционно не вписывающиеся в основной текст из-за своего большого объема (например, громоздкие доказательства и выводы формул).
Распространенным недостатком является плохая логическая структура текста записки. Она должна соответствовать дедуктивной логике научного и инженерного мышления: от общих вопросов постепенно переходить к частным, от целого – к деталям, от важного – к второстепенному. Чтобы изложение было логически стройным, советуем придерживаться следующей схемы: текст компонуется из ответов на три многократно (в частности, рекурсивно) повторяющихся вопроса: ЧТО? ЗАЧЕМ? КАК? или ЧТО? ПОЧЕМУ? КАК? Ответами могут служить любые структурные единицы текста: фразы, их последовательности, абзацы, разделы. Упомянутая рекурсия означает, что эти единицы текста могут, в свою очередь, содержать ответы на "вложенную" триаду вопросов. Другими словами, это триада:
ЧТО?
Какая проблема (задача, система, метод, алгоритм, структура данных, программа) решается, разрабатывается,...?
ЗАЧЕМ? (ПОЧЕМУ?)
Какие цели (требования, причины, условия, ограничения) существуют для ЧТО?
КАК?
Каким методом (способом, средствами, приемами) решается проблема, преодолеваются трудности для достижения ЧТО?
Другая частая ошибка – неравнопрочность изложения, неравномерная его подробность. Например, на 40 страницах излагается математический метод и алгоритм, а описание процесса разработки программы, его реализующей, занимает полстраницы. Но ведь время, затраченное на эти части работы, делится не в такой пропорции! И знания - тоже. А так получается, что автор как математик имеет высшее образование, а как программист - бессловесный кодировщик, каких теперь готовят в ПТУ. На самом деле программа, претендующая называться продуктом, проходит фазы определения требований, спецификации, проектирования, собственно кодирования, тестирования, испытаний. Значит, эти этапы технологии программирования должны найти отражение в тексте выпускной работы. Поэтому же желательным приложением являются руководство пользователя и исходные тексты основных модулей. Особое внимание уделите описанию того, как проводилось тестирование – именно оно подтверждает качество результата, надежность конечного продукта.
Точность речи достигается прежде всего правильным употреблением общепринятой терминологии. Термином называется слово или словосочетание, обозначающее понятие специальной области знания или деятельности. Специальная терминология и соответствующий понятийный аппарат – это ядро языка профессионального общения, дающее возможность взаимопонимания между специалистами. Основное требование к термину - однозначность, т. е. наличие только одного раз навсегда установленного значения. Определения значений терминов даются в учебниках и другой литературе по специальности; они фиксируются в толковых словарях. Весьма распространенная ошибка – произвольное толкование терминов и следовательно, неправильное их употребление. Например, термин тестирование программного продукта, обозначающий систематический поиск ошибок в нем, часто понимается как его испытание, подтверждающее отсутствие ошибок. А поскольку такое испытание невозможно в принципе, то тестирование подменяется выполнением ряда «контрольных примеров», достаточность которых ничем не подтверждается.
Очевидно, что разнобой в употреблении терминологии мешает эффективному общению специалистов. В компьютерной сфере положение усугубляется тем, что терминология очень быстро обновляется: ежегодно появляются десятки и сотни новых понятий и терминов, а старые понятия изменяют свое содержание. Специалисты не успевают однозначно согласовать эти изменения (хотя такая работа ведется) и отразить их в словарях. Поэтому столь важно внимательно относиться к точному использованию новых, еще не укоренившихся терминов. Давайте им краткие определения при первом же упоминании, так вы избежите непонимания и предупредите упреки в неправильной терминологии.
Поскольку подавляющее большинство терминов ИТ приходит к нам из англоязычной литературы, так актуальны вопросы их перевода на русский. Избегайте прямых заимствований из английского, если есть русские эквиваленты терминов. Например, вместо антиалиасинг лучше писать устранение лестничного эффекта, вместо инсталляция - установка. Однако, к сожалению, тотальная русификация компьютерной терминологии невозможна. Есть термины, к которым не подобрать подходящего русского аналога, и в профессиональный язык приходится вводить новое слово. Много таких транслитераций (т.е. записи звуков английского слова на кириллице) уже перешло в общий лексикон: компьютер, сканер, веб-сайт, рендеринг и т.д.
Так что же делать, если вам нужно использовать новый термин, встреченный при переводе английской статьи или монографии? Прежде всего, проверьте, нет ли уже устоявшегося русского эквивалента в отечественной литературе или переводах. Если такового нет, то вам придется найти такой эквивалент и явно определить его в своем тексте, указав в скобках английский оригинал. Сначала постарайтесь подыскать аналогичное русское слово (например, буквальный перевод) или словосочетание, передающее смысл понятия, обозначаемого этим термином. Если же найти такое слово не удается, а подходящее словосочетание оказывается слишком длинным и неудобным в употреблении, то используйте транслитерацию оригинала. Следите при этом за правильной передачей английского произношения: так, для router (маршрутизатор) правильно рутер, а не раутер или роутер. Если же транслитерация неблагозвучна, то только тогда оставляйте английское написание, как например, mip-map текстура или cookie.
Разумеется, недопустимо употребление профессионального сленга и жаргона, вроде словечек «фича» или «баг».
Процесс сочинения текста выпускной работы совмещаться во времени с решением поставленных задач. Неразумно в процессе разработки держать всю информацию в голове и только после завершения и теоретической, и практической работы садиться за «чистый лист бумаги» для написания текста. Вначале пишутся планы, наброски, черновики, которые затем постепенно дополняются, изменяются и шлифуются, превращаясь в окончательный текст. Благо в электронной форме править черновики гораздо легче, чем это было в докомпьютерную, бумажную эпоху. Это метод, известный программистам как пошаговое усовершенствование программы при ее разработке (виртовское stepwise refinement). Чем раньше вы начнете писать черновики, тем лучше. Уже во время изучения литературы полезно делать заметки и выписки, которые потом войдут в ее обзор.
При правильной организации работы к моменту оформления текста уже есть все необходимые фрагменты: аналитические модели, доказательства, схемы (диаграммы), псевдокоды, выписки из литературы, графики и таблицы результатов и пр. Все это нужно объединить в логически стройное целое, добавив поясняющий текст. Рекомендуем писать этот текст путем пошаговой детализации - как последовательность все более подробных планов (или тезисов) разделов, обсуждая их с руководителем. Многие части текста можно писать параллельно друг другу. Последовательность, в какой эти части приобретают окончательный вид, может не совпадать с планом содержания (оглавлением). Вначале обычно пишутся начисто более простые и очевидные разделы, последними – обзор литературы (чтобы охватить самые свежие публикации), введение и заключение.
5. Требования к оформлению работы
Оформление должно соответствовать требованиям Положения СПбГПУ «Правила оформления студенческих выпускных работ и отчетов» (оно опубликовано на сайте кафедры, URL: http://amd.stu.neva.ru/ diploma/diploma-documents) и положениям ГОСТ 7.32 – 2001. Отчет о НИР. Структура и правила оформления.
Перечислим основные требования.
1. Структура разделов - как показано выше, на стр. 4. Введение и Заключение не нумеруются; у подразделов - составные номера (рекомендуется вложенность не более 3). Приложения нумеруются отдельно и должны иметь свои названия. Точка после названия раздела не ставится ни в Содержании, ни в тексте. В "Содержание" не включают титульный лист, реферат и перечень условных обозначений.
2. Печать – двусторонняя или односторонняя на бумаге формата А4. Страницы нумеруются в сквозном порядке, начиная со следующей после Реферата. Номера проставляются внизу посредине страницы.
3. Рисунки могут занимать целую страницу или ее часть. Под рисунком помещается Рис. <№>, а рядом с ним - название рисунка. Рисунки, так же как формулы и таблицы, нумеруются в пределах основного раздела, номер которого служит префиксом (т.е., Рис.1.1,...Рис.1.5, Рис. 2.1,...). Название таблицы помещается над ней.
4. Реферат должен содержать: сведения об объеме реферируемого документа (количество страниц, иллюстраций и таблиц), перечень ключевых слов и текст реферата. Образец оформления реферата приведен в приложении В. Рекомендуемый объем текста реферата составляет 500-1000 знаков.
5. Ссылки на литературу даются в квадратных скобках (например, [8], [1, 7], [2 - 5]) и нумеруются в порядке первого их упоминания в тексте. В разделе «Список использованных источников» в этом же порядке перечисляются библиографические описания источников с указанием автора, названия, издательства, года, страниц. Для источников из интернета нужно приводить не только их URL, но и автора и дату публикации (если они известны), содержательные названия публикации и сайта, а также дату посещения сайта. Источников в списке без ссылок на них в тексте быть не должно! Примеры библиографических описаний в соответствии с (ГОСТ Р 7.0.5-2008. Библиографическая ссылка) приведены в Приложении Г.