21

ПКШ КЛР/ДЗ (ТЗ) (ООП) – Большаков С.А. 2014/2015 1-й курс

Методические указания к лабораторной работе № 12 по курсу

Программирование на основе классов и шаблонов

" Комплексная Лабораторная работа/Домашнее задание.

Документация. Разработка Технического задания проекта"

Москва, МГТУ - 2014

_____________________________________________________________________________________________

СОДЕРЖАНИЕ

1. Цель работы 3

2. Задачи, решаемые в лабораторной работе 3

3. Основные понятия и примеры 4

3.1. Программная документация 4

3.2. Программная документация, разрабатываемая в домашнем задании 4

3.3. Особенности и принципы разработки программной документации (ПД) 4

3.4. Требования к оформлению ПД в ДЗ 5

3.5. Документ техническое задание (ТЗ) и его назначение 6

3.6. Стиль изложения в ТЗ 6

3.7. Требования к ТЗ 6

3.8. Разработка ТЗ 6

3.9. Содержание ТЗ 7

3.10. Раздел ТЗ – 5. Технические требования (общее) 8

3.11. Раздел ТЗ – 5.1 Требования к функциональным характеристикам 8

3.12. Разделы ТЗ – Другие технические требования 8

3.13. Раздел ТЗ – требования к документации 8

3.14. Раздел ТЗ – этапы сроки выполнения 8

3.15. Раздел ТЗ – порядок приема и контроля 9

3.16. Порядок изменения и корректировки ТЗ 9

4. Порядок работы и методические указания (основные требования) 9

4.1. Прочитать и усвоить основные понятия данной лабораторной работы. 9

4.2. Прочитать документ требования к ДЗ/КЛР. 9

4.3. Определить номер своего варианта и получить тему ДЗ. 10

4.4. Познакомиться с требованиями к оформлению документа ТЗ. 10

4.5. Проработать предметную область ДЗ/КЛР. 10

4.6. Познакомиться с образцом документа ТЗ. 10

4.7. Создать в VS 2005 консольный проект (DZ_XXXXX_ХDD). 10

4.8. Обеспечить русификацию консольного ввода и вывода. 11

4.9. Провести макетирование системы классов. 11

4.10. Использование шаблона документа ТЗ 13

4.11. Разработать разделы документа: Наименование, назначение и исполнитель. 13

4.12. Разработать раздел документа: Функциональные требования. 13

4.13. Прочитать раздел документа образец: Требования к ПД. 13

4.14. Прочитать раздел документа образец: Стадии и этапы разработки. 13

4.15. Прочитать раздел документа образец: Порядок приема и контроля. 14

4.16. Построить предварительную диаграмму классов для ДЗ. 14

4.17. Дополнительные требования для сильных студентов 14

5. Варианты по группам и студентам 14

6. Предварительные диаграммы классов домашнего задания 17

7. Контрольные вопросы к ЛР 18

8. Сроки и порядок защиты документа ТЗ 18

9. Литература 18

10. Приложение: Шаблон документа ТЗ 19

11. Приложение: Образец документа ТЗ (*.doc) 19

12. Приложение: Образец документа ТЗ (*.pdf) 19

13. Справочные материалы 19

1 Цель работы

Целью лабораторной работы получение навыков разработки документа на программное обеспечение - технического задания (ТЗ). Работа выполняется в рамках ДЗ/КЛР. На основе образца и шаблона данного документа, для своего варианта задания, студенты разрабатывают и защищают собственное техническое задание для своего варианта ДЗ. Данная лабораторная работа входит в цикл работ, выполняемых студентами кафедры в рамках практикума по программированию (во 2-м семестре кафедры ИУ5). Кроме этой работы в цикл входят ЛР № 13,14, и 15. Они объединены общей задачей. Порядок работ и требования к ним изложены в документе “ Методические указания для выполнения ДЗ/КЛР по дисциплине Программирование на основе классов и шаблонов кафедры ИУ5”[6], он размещен на сайте дисциплины. Документ оформляется в MS WORD в виде текстового документа.

2 Задачи, решаемые в лабораторной работе

В процессе выполнения ЛР студенты индивидуально должны выполнить следующие задачи. Перечислим основные требования к лабораторной работе:

• Прочитать и усвоить основные понятия данной лабораторной работы.

• Прочитать документ требования к ДЗ/КЛР.

• Определить номер своего варианта и получить тему ДЗ.

• Познакомиться с требованиями к оформлению документа ТЗ.

• Познакомиться с образцом документа ТЗ.

• Провести макетирование системы классов.

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

• Разработать разделы документа: Наименование, назначение и исполнитель.

• Разработать раздел документа: Технические требования.

• Построить предварительную диаграмму наследования классов.

• Прочитать и изучить раздел документа образец: Требования к программной документации.

• Прочитать и изучить раздел документа образец: Стадии и этапы разработки.

• Прочитать и изучить раздел документа образец: Порядок приема и контроля.

• После выполнения перечисленных действий студенты: демонстрируют преподавателю документ, разработанный во время ЛР. Документ оформляется в MS WORD на основе шаблона документа с использованием образца документа.

Примечания. 1. Для удобства восприятия текста используется цвет и тип шрифта. Фрагменты исходного текста, включаемые в программные модули, я буду выделять синим цветом. Например, вставка заголовочного файла в программу будет выглядеть так:

#include <iostream>

2. Вывод результата в консольное окно, который формируется программой, будем помечать коричневым цветом и устанавливать непропорциональный шрифт Courier New. Например:

Введите iVal: 10

3. Формализованные описания языка и синтаксические правила будем записывать зеленым цветом:

<левая часть выражения присваивания> = <правая часть выражения присваивания>;

4. Если в тексте встречается переменная, которая подчеркнута, то это означает, что дается определение важного понятия и это понятие встречается в данном тексте первый раз. Например:

Программа – это упорядоченная совокупность операторов …

3 Основные понятия и примеры

В рамках освоения дисциплины “Программирование на основе классов и шаблонов” студенты выполняют домашнее задание (комплексную лабораторную работу - КЛР) по разработке собственной системы классов. Назначение системы классов определяется вариантом задания. Работы выполняются студентами индивидуально. Работа выполняется частично в часы проведения лабораторных работ – КЛР (комплексная лабораторная работа) по отдельным частям и в часы самостоятельной проработки курса. Результаты работы учитываются во втором модуле курса.

4 Программная документация

Любой программный проект должен сопровождаться разработкой комплекса программной документации. Время, которое затрачивается на разработку такой документации соизмеримо со временем самой программной разработки (не менее 50% времени всего проектирования). Иногда это время превышает время программирования и отладки проекта. Некоторые документы разрабатываются до начала разработки. Например, техническое задание (ТЗ) на программную разработку. Без создания грамотного ТЗ проект вообще нереализуем или, скорее всего, не будет успешным. Кроме того, без хорошо разработанного технического задания, невозможно успешно предъявить и сдать работу заказчику, а также, успешно закрыть работу по проекту (включая и получения оплаты за выполненную работу). Программисты (или специальные разработчики документации) разрабатывая документы, по сути, являются “техническими писателями”, а освоение таких умений является неотъемлемой частью получаемых навыков в рамках подготовки по нашей специальности.

5 Программная документация, разрабатываемая в домашнем задании

Для получения основных навыков в разработке технической документации на программное обеспечение выбраны главные документы из значительного множества документов, требуемых в ГОСТ [8]. Этот комплект документов содержит следующие документы:

• Техническое задание (ТЗ);

• Описание применения программного продукта (ОП);

• Техническое описание программного продукта (ТО);

• Руководство пользователя (РП);

• Руководство системного программиста (РСП);

• Исходные тексты программ системы классов и тестового примера (ИТ);

• Программа и методика испытаний на основе тестового примера (ПМИ);

• Описание тестового примера (ОПТ);

Последний документ (“Описание тестового примера”) может не выделяться отдельно и входить составной частью других документов: “ Руководство пользователя ”, ” Техническое описание программного продукта ”, “ Программа и методика испытаний ”. В рамках домашнего задания и КЛР студенты должны разработать весь комплект документации на программный продукт, разрабатываемый по их варианту. По каждому документу у вас предусмотрена отдельная лабораторная работа, которую вы можете выполнить и заранее в рамках часов, отводимых под самостоятельных работу студентов (34 академических часа)

6 Особенности и принципы разработки программной документации (ПД)

При разработке ПД нужно учесть следующие обстоятельства:

• Кто из участников процесса разрабатывает данный документ ПД.

• Для кого разрабатывается данный документ ПД

• Каков стиль изложения данного документа ПД

• Каково содержание данного документа ПД

• На каком этапе проектирования разрабатывается данный документ ПД

• Каковы требования к данному документу.

Четкие ответы на перечисленные вопросы должны быть у каждого разработчика данного документа. В процессе разработки документации на программный продукт могут участвовать следующие группы и разновидности специалистов:

• Руководители проекта.

• Разработчики программисты (или исполнители проекта).

• Заказчики проекта.

• Пользователи разрабатываемого программного обеспечения (ПО).

• Системные программисты, устанавливающие ПО для пользователя.

• Технические писатели (разработчики технической документации).

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

В каждой ЛР из цикла КЛР мы рассмотрим все эти особенности, применительно к каждому типу рассматриваемого документа. Здесь выделим общие особенности стиля изложения и разработки ПД:

• Документы должны содержать информацию, имеющую отношение только к данному проекту и данному документу.

• Документы должны быть написаны на техническом языке и не должны содержать неопределенности и неоднозначности.

• Документы должны быть написаны короткими предложениями, и они должны включать минимум распространенных предложений (с придаточными предложениями).

• Стиль документа должен соответствовать стилю документа данного типа.

• Документы не должны содержать “воды” и отступлений от содержания. Никакой “лирики”.

• Все пункты должны быть пронумерованы (разделы, позиции и т.д.) и допускать ссылки из других документов. Не допускается перечисления в виде маркированных списков (bullets).

• При ссылках на другие документы должны указываться прямые ссылки, содержащие: полное название документа и позицию (пункт), на который производиться ссылка.

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

7 Требования к оформлению ПД в ДЗ

В нашем случае требования к оформлению следующие:

• Текстовый редактор - MS WORD (не Open Office!),

• Шрифт - Times New Roman.

• Кегль шрифта - 12,

• Интервал между строками - одинарный,

• Способы форматирования текста – по ширине,

• Размеры страниц – А4 (верх - 2 , низ - 2 , слева - 3 , справа - 2),

• Содержание колонтитулов (вариант, группа, ФИО студента),

• Способы рисования иллюстраций документа (Предпочтительнее MS Visio можно MS WORD),

• Нумерация страниц – центр – верх.

Данные требования необходимо соблюдать при разработке всех документов домашнего задания.

8 Документ техническое задание (ТЗ) и его назначение

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

Документ ТЗ разрабатывается совместно заказчиком и разработчиками (руководителем проекта и исполнителями) и утверждается (подписывается). После этого, не выполнение отдельных пунктов ТЗ может являться основанием для расторжения договора (по закону). Более того, утверждается, что невыполнение ТЗ преследуется по закону.