Информационные системы и программирование. Технический писатель. Выпускная квалификационная работа

СРЕДНЕЕ ПРОФЕССИОНАЛЬНОЕ ОБРАЗОВАНИЕ

Серия основана в 2001 году

М.С. ЛОГАЧЁВ
О.В. СЕМЁНОВА

ИНФОРМАЦИОННЫЕ СИСТЕМЫ 
И ПРОГРАММИРОВАНИЕ

ТЕХНИЧЕСКИЙ ПИСАТЕЛЬ. 

ВЫПУСКНАЯ КВАЛИФИКАЦИОННАЯ РАБОТА

УЧЕБНИК

Рекомендовано Межрегиональным учебно-методическим 
советом профессионального образования в качестве учебника 
для учебных заведений, реализующих программу среднего 
профессионального образования по специальности 
09.02.07 «Информационные системы и программирование» 
(протокол № 17 от 11.11.2019)

Э л е к т р о н н о

znanium.com

Москва
ИНФРА-М

2020

УДК 004(075.32)
ББК 32.973-018.2я723

Л69

Р е ц е н з е н т ы :

Ткачева Г.В., кандидат педагогических наук, член-корреспондент 
Академии профессионального образования;

Белобокова Ю.А., кандидат технических наук, доцент

Логачёв М.С.

Л 69 
Информационные системы и программирование. Технический писатель. Выпускная квалификационная работа : учебник /  М.С. Логачёв, О.В. Семёнова. — Москва : ИНФр А-М, 2020. — 551 с. — (Среднее 
профессиональное образование).

ISBN 978-5-16-015544-9 (print)
ISBN 978-5-16-107981-2 (online)
Учебник содержит материалы, необходимые для подготовки к демонстрационному экзамену по компетенции «Программные решения для бизнеса» и защите выпускной квалификационной работы по специальности 
09.02.07 «Информационные системы и программирование» по направлению «Технический писатель» из перечня «ТОП-50 наиболее востребованных профессий». Подробно изложены особенности, правила и требования по созданию содержания выпускной квалификационной работы, 
ее оформлению, а также защите в виде презентации и доклада. Детально 
описаны алгоритмы создания объектов практической части с иллюстрацией каждого этапа их выполнения. В учебнике учитывается навык владения 
профессиональным английским языком и приводятся примеры его использования в подготовке пояснительной записки и презентации проекта.

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

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

УДК 004(075.32) 
ББК 32.973-018.2я723

ISBN 978-5-16-015544-9 (print) 
ISBN 978-5-16-107981-2 (online)

© Логачёв М.С., Семёнова О.В., 
2019, 2020

ОТ АВТОРА

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

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

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

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

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

Отдельно стоит отметить, что технический писатель должен свободно 
владеть иностранным языком. Помимо этого, он должен знать иностран
3

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

Содержание данного учебника позволяет выполнить и подготовиться к 
защите выпускной квалификационной работы (ВКР) по требованиям, определенным в ФГОС по специальности 09.02.07 «Информационные системы и программирование», Профессиональном стандарте 06.019 и стандартам Ворлдскиллс Россия по компетенции демонстрационного экзамена «Программные решения для бизнеса». Представленный материал объединяет в себе основные результаты изучения отдельных профессиональных дисциплин за все годы обучения и разделен на три части. Они содержат методики создания ВКР (программный продукт, содержание пояснительной записки и презентации проекта), правила их оформления и представления полученных результатов.

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

Дополнительную информацию для подготовки к итоговой аттестации по 
специальности 09.02.07 можно получить из следующих изданий, которые 
изданы или готовятся к публикации в НИЦ «ИНФРА-М»:
• «Информационные системы и программирование. Администратор баз 
данных. Выпускная квалификационная работа»;

• «Информационные системы и программирование. Специалист по информационным системам. Выпускная квалификационная работа»;

• «Информационные системы и программирование. Программист. Выпускная квалификационная работа»;

• «Информационные системы и программирование. Специалист по информационным ресурсам. Выпускная квалификационная работа»;

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

Каждый найдет что-то интересное и полезное для себя.
Успешной подготовки!

4

ЧАСТЬ 1

СОДЕРЖАНИЕ ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ

Глава 1

ФОРМАЛЬНАЯ ЧАСТЬ

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

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

§ 1.1 ТИТУЛЬНЫЙ л и ст

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

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

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

2. Полное наименование организации, в которой выполнена работа 
(допускается сокращенное наименование, согласно лицензии на ведение 
образовательной деятельности);

3. Грифы согласования и утверждения работы. На титульном листе 
ставят свои подписи следующие участники процесса государственной итоговой аттестации:
• выпускник;
• руководитель ВКР;
• специалисты, отвечающие за содержание отдельных частей работы (если 
таковые имеются): экономическую часть, охрану труда, графическую 
часть и др.;

• специалист нормоконтроля, отвечающий за соответствие оформления 
работы требованиям ГОСТ и ЕСКД;

5

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

5. Название работы — тема, которая до символа должна соответствовать приказу об утверждении тем для государственной итоговой аттестации. В случае положительной защиты тема работы будет указываться в дипломе (в так называемой «корочке»). Даже если будет пропущена запятая 
или в одном документе будет написано Е, а в  другом — Е, то это несоответствие тем. Титульный лист придется переделывать и собирать все подписи заново. Будьте внимательны.

6. Информация о выполнившем данную работу:

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

7. Информация о руководителе ВКР:

• ученая степень и звание;
• занимаемая должность;
• место работы;
• фамилия, имя, отчество;
• подпись.

8. Место и год защиты.
К оформлению такого листа у каждой образовательной организации свои 
требования. Таким образом, следует обратиться к руководителю за шаблоном титульного листа. На рис. 1.1 приводится пример титульного листа, 
соответствующего перечисленным требованиям.

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

§ 1.2 ИНДИВИДУАЛЬНОЕ ЗАДАНИЕ

Индивидуальное задание, другими словами, техническое задание — это 
лист, на котором перечислены все сведения, необходимые для выполнения 
дипломного проекта. На его основании выбираются методы и средства создания программного продукта, определяются его возможности и характеристики, а также выстраивается структура самой пояснительной записки 
(пример нарис. 1.3-1.4).

6

ДЕПАРТАМЕНТ ОБРАЗОВАНИЯ ГОРОДА МОСКВЫ 
ГОСУДАРСТВЕННОЕ БЮДЖЕТНОЕ ПРОФЕССИОНАЛЬНОЕ 
ОБРАЗОВАТЕЛЬНОЕ УЧРЕЖДЕНИЕ ГОРОДА МОСКВЫ 
«ФИРМЕННОЕ НАЗВАНИЕ ОБРАЗОВАТЕЛЬНОЙ ОРГАНИЗАЦИИ»

РАССМОТРЕНО
на заседании кафедры

протокол № 6
от «13» января 2019 г.
Зав. кафедрой 
__________НО. Фамилия

(подпись)

УТВЕРЖДАЮ

заместитель директора по УР

____________ НО. Фамилия

« 
»____________2019 г.

ЗАДАНИЕ

на выпускную квалификационную работу по специальности

09.02.07 Информационные системы и программирование 

образовательный уровень: базовый

Обучающемуся IV курса группы СИП-415/16 

Фамилия Имя Отчество

Тема 
задания: Проектирование, разработка и эксплуатация мобильного____

приложения, обеспечивающего доступ к цифровому контенту________________

Исходные данные: База данных; Форма клиентского приложения; Open Server; 

язык программирования: С#, РНР (или др. по выбору обучающегося); СУБД: 

SOLite, MS SOL Server 2008 (и выше) (и др. по выбору обучающегося): CASE- 

средства: Visual UML, Ramus, С A ERwin Process Modeler (и др. по выбору 

обучающегося); оформление: ГОСТ 7.32-2001________________________________

Структура работы

1. Пояснительная записка (55—70 листов):

Введение (актуальность, цель и задачи);

Теоретическая часть (методы и средства проектирования и разработки 

программных продуктов, описание предметной области, регламент работ); 

Аналитическая часть (обзор и анализ существующих программных 

решений в предметной области);

Рис. 1.3 Пример индивидуального задания (первый лист)

9

Проектная часть (программная реализация, интерфейс пользователя, 

организация обработки и хранения информации, категории пользователей, 

функциональные возможности, сопроводительная документация); 

Технико-экономическая 
часть (определение ресурсных затрат для 

проектирования, разработки и эксплуатации разработанного программного 

продукта, определение экономической эффективности);

Охрана труда (особенности эксплуатации программного продукта, график 

работы, принципы безопасной работы специалистов с программным 

продуктом);

Заключение (выводы: что получено в результате работы, выполнение всех 

поставленных задач и результат их выполнения);

Список используемой литературы (учебники, периодические издания, 

электронные ресурсы, не менее 30 источников).

2. Мультимедийная часть: презентация ВКР, 10-12 слайдов;

3. CD-R или CD-RW диск: разработанный программный продукт, презентация 

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

Дата выдачи задания «__» ___________ 2019 г.

Сроки выполнения разделов выпускной квалификационной работы:
Введение 
с 17.02.2019 по 19.04.2019

Теоретическая и аналитическая части 
с 17.02.2019 по 04.05.2019

Практическая и технико-экономическая части с 17.02.2019 по 26.05.2019 
Охрана труда, заключение и презентация 
с 17.02.2019 по 31.05.2019

Срок представления законченной работы «37» мая 2019 г.

Руководитель выпускной

квалификационной работы __________________М С. Логачёв

(подпись руководителя)

получил «__» ________2019 г.

обучающийся_________________ И.О. Фамилия

(подпись обучающегося)

Рис. 1.4 Пример индивидуального задания (второй лист)

10