Содержание документа ОП:

1. НАЗНАЧЕНИЕ ПРОГРАММНОГО ПРОДУКТА

2. ВОЗМОЖНОСТИ ПРОГРАММНОГО ПРОДУКТА

2.1. Общие сведения о программном продукте

2.2. Диаграмма классов программного продукта

3. ОСНОВНЫЕ ХАРАКТЕРИСТИКИ ПРОГРАММНОГО ПРОДУКТА

4. УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММНОГО ПРОДУКТА

4.1. Требования к составу и параметрам технических средств

4.2. Требования к информационной совместимости

4.3. Требования к программному обеспечению

4.4. Требования к условиям эксплуатации

4.5. Требования к маркировке и упаковке

4.6. Требования к хранению

5. ОБЩИЕ ХАРАКТЕРИСТИКИ ПРОГРАММНОГО ПРОДУКТА

12 Требования к ОП

Главные требования к основным разделам документа “Описания применения” (на выполнение этих требований будет обращаться повышенное внимание при сдаче ПО):

В п.1 (“НАЗНАЧЕНИЕ ПРОГРАММНОГО ПРОДУКТА”) дается более подробное, чем в ТЗ, назначение разрабатываемого программного продукта (ПО). Стиль должен быть простым и ориентированным на неподготовленного пользователя, как в рекламных объявлениях и рекламной информации. Документ может быть ориентирован на менеджеров и руководящих работников.

В п.2 (“ВОЗМОЖНОСТИ ПРОГРАММНОГО ПРОДУКТА”) приводятся все положительные свойства ПО, с пояснением, если нужно, условий функционирования и выгод его использования по сравнению с подобными программными продуктами. В нашем случае приводится описание классов на содержательном уровне и основных возможностей их применения. Не допускается использовать латинские названия методов, данных и перегруженных операций. Здесь, в нашем случае, приводиться диаграмма классов разработанного программного продукта.

В п.3 (“ОСНОВНЫЕ ХАРАКТЕРИСТИКИ ПРОГРАММНОГО ПРОДУКТА”) приводятся основные технические характеристики ПО. Эти характеристики можно оформить, для наглядности, в виде таблицы. Здесь отображаются: размеры используемой оперативной памяти, задействованные прерывания, ограничения на возможности создания объектов на основе системы классов (для нашего случая), объемы в ОП и т.д., все, что характеризует и отличает данный программный продукт. Можно давать сравнительные характеристики по сравнению с аналогичными программными продуктами.

В п.4 (“УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММНОГО ПРОДУКТА”) приводятся все ограничения и требования к применению ПО. В частности в п.4.2 может уточняться тип кодировки символов, типы форматы файлов для хранения информации и т.д., в зависимости от назначения и конструкции ПО. В этом разделе в обобщенном виде приводятся данные из ТЗ, связанные с условиями эксплуатации, хранением, транспортировкой ПО.

В п.5 (“ОБЩИЕ ХАРАКТЕРИСТИКИ ПРОГРАММНОГО ПРОДУКТА”) сведены общие и самые существенные характеристики ПО из предыдущих разделов. Эту информацию желательно тоже оформить в виде таблицы.

13 Документ техническое описание (ТО) ПО и его назначение

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

14 Стиль изложения ТО

Стиль изложения документа “Техническое описание” должен быть описательным, но основан на строгом техническом языке, принятом программистами и специалистами по разработке ПО (программистский жаргон здесь недопустим). Например, "файл имеет следующую структуру: …", "Процедура … имеет следующие входные и выходные параметры …", "класс имеет следующее назначение", "создаваемые объекты могут …" и т.д. Материал может быть (желательно) организован в виде наглядных таблиц, диаграмм, блок-схем и других формализованных описаний. В случае необходимости схемы и чертежи проекта могут быть вынесены на отдельные листы конструкторской документации, оформленные по ГОСТу. Из документа ТО, в этом случае, должны быть сделаны однозначные ссылки на содержание листов: например, “На Листе 2 представлена модульная структура программной системы …”.

15 Содержание ТО

Содержание документа ТО по пунктам приведено ниже. В образце документа ТО приведен документ ТО для варианта улиц и домов, описанного в общем пособии по курсу [3]. В шаблоне документа ТО (см. в конце данных методических указаний) даны методические указания к написанию и приспособлению документа применительно к конкретному варианту студента.

Содержание документа ТО:

1. ОБЩИЕ СВЕДЕНИЯ О ПРОГРАММНОМ ОБЕСПЕЧЕНИИ

2. МОДУЛЬНАЯ СТРУКТУРА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

3. ДИАГРАММА КЛАССОВ ПО

4. ОПИСАНИЕ МЕТОДОВ И ДАННЫХ КЛАССОВ ПО

5. ДАННЫЕ И ФАЙЛЫ ДАННЫХ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

6. ОСНОВНЫЕ АЛГОРИТМЫ МЕТОДОВ КЛАССОВ ПО

6.1. АЛГОРИТМ ...

6.2. АЛГОРИТМ ...

…

7. ОПИСАНИЕ ПРОЦЕДУР И ФУНКЦИЙ ПО

7.1. ПРОЦЕДУРА ...

7.2. ПРОЦЕДУРА ...

…

8. ОПИСАНИЕ ПРОЦЕССА ОТЛАДКИ КЛАССОВ.

9. КЛАССЫ И МЕТОДЫ, ПЕРЕОПРЕДЕЛЯЕМЫЕ В ПО

Разделы 6 и 7 могут иметь несколько подпунктов, в зависимости от состава ПО.

16 Требования к ТО

Главные требования к основным разделам технического описания ПП (на выполнение этих требований будет обращаться повышенное внимание при предъявлении ПП). Ниже требования, характерные для нашего конкретного случая КР/ДЗ:

В п.1 (“ОБЩИЕ СВЕДЕНИЯ О ПРОГРАММНОМ ОБЕСПЕЧЕНИИ ”), приводятся общие характеристики программного обеспечения, дается назначение ПО, его шифр и краткая характеристика содержания документа ТО.

В п.2 (“МОДУЛЬНАЯ СТРУКТУРА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ”) приводится модульная структура ПО, либо в виде чертежа-схемы, либо в виде таблицы, если модулей в проекте немного. Возможно наличие и таблицы и чертежа. Дается перечень и связность модулей (исходных, объектных, библиотек и включаемых). В нашем случае это будет описание классов и их реализация. Если используются разные файлы, то дается их описание и назначение, а также распределение описаний по исходным модулям.

В п.3 (“ДИАГРАММА КЛАССОВ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ”) должна быть представлены диаграмма классов ПО и краткое их описание на содержательном уровне. Можно располагать диаграмму классов на отдельном чертеже, но желательно в формате рисунка ее повторить и в данном документе.

В п.4 (“ОПИСАНИЕ МЕТОДОВ И ДАННЫХ КЛАССОВ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ”) желательно в виде структурированной таблицы дается детальное описание классов ПО, их методов и свойств. Если класс наследует свойства базового класса, то нельзя делать ссылки на базовый класс, а нужно повторить описание данных и методов.

Примечание: Материалы с описанием процедур и членов классов необходимо размещать в специальной таблице с графами типа (см. методические указания к КЛР/ДЗ): название процедуры, способ обращения, входные параметры, выходные параметры, назначение, примечание и т.д.

В п.5 (“ДАННЫЕ И ФАЙЛЫ ДАННЫХ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ”) описываются структуры данных и файлов, используемых в ПО. Желательно оформить каждую структуру и файл в виде отдельной таблицы и снабдить необходимыми пояснениями полей данных.

В п.6 (“ОСНОВНЫЕ АЛГОРИТМЫ МЕТОДОВ КЛАССОВ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ”) дается общее описание алгоритмов функционирования процедур По и методов классов, если эти алгоритмы имеют уникальный характер. В частности должно быть приведено описание блок-схем программ методов, которые могут быть представлены в тексте документа или быть оформлены в виде приложении к документу ТО или отдельных листов конструкторской документации.

В п.7 (“ОПИСАНИЕ ПРОЦЕДУР И ФУНКЦИЙ ПО ”) должны быть описаны все процедуры и функции ПП. Описание каждой функции сводиться в таблицу, в которой отображаются: назначение, входные, промежуточные и выходные данные процедур (как в п.4).

В п.8 (“ОПИСАНИЕ ПРОЦЕССА ОТЛАДКИ КЛАССОВ ”) приводится описание процесса отладки ПО и специальные прогрммы, разработанные для отладки.

В п.9 (“КЛАССЫ И МЕТОДЫ, ПЕРЕОПРЕДЕЛЯЕМЫЕ В ПО ”) приводится краткое описание классов переопределяемых в программе и дается ссылка о том, в каких библиотеках базовые классы описаны. В документе приводиться также список библиотечных классов с указанием стандартной библиотеки..

17 Разработка ТО

Разработка ТО выполняется разработчиками ПО или специалистами по разработке документации совместно с разработчиками ПО. Начинается разработка ТО фактически с началом проекта, а завершается (или уточняется содержание) в конце проекта. Поэтому желательно сразу, на основе шаблона, создать такой документ и постоянно в него добавлять информации. Например, завершена разработка и отладка одного класса, можно его описание отобразить в ТО. Иногда, и даже более правильно, сделать описание класса или алгоритма в формате ТО, а только затем выполнить его реализацию, внося, при необходимости, уточнения и изменения в документ ТО.

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

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

Предварительно перед началом лабораторной работы, а желательно и до ее начала в дисплейном классе, необходимо прочитать раздел этого документа “Основные понятия”. Необходимо усвоить эти понятия: техническое описание и описание применения. Познакомиться с методикой написания и оформления программной документации [6,7].

20 Разработать документ описание применения ПО (ОП)

Для этого необходимо первоначально познакомиться с документом “Образец ОП”, приведенным в конце данных МУ в формате *.PDF. Данный образец подготовлен на основе варианта ДЗ, рассмотренного в МУ по ЛР[6,7]. Далее необходимо на основе “Шаблона документа ОП”, приведенного в конце МУ, создать свой документ ОП. Руководствуясь пояснениями в шаблоне ОП и методическими указаниями в разделе “Основные понятия”, необходимо разработать свой документ, применительно к варианте ДЗ.

21 Разработать диаграмму классов ПО

Разработать диаграмму классов для вашего варианта ПО [6,7]. Пример диаграммы можно увидеть ниже.

22 Разработать диаграмму классов и систему классов ПО

Разработать диаграмму классов для вашего варианта ПО [6,7]. Пример диаграммы можно увидеть ниже. Система классов детально описывается в таблицах [6,7]. Разрабатываются алгоритмы реализации отдельных методов классов. Все перечисленное документируется в электронном виде (лучше документ MS WORD).

23 Разработать документ техническое описание ПО (ТО)

Для этого необходимо первоначально познакомиться с документом “Образец ТО”, приведенным в конце данных МУ в формате *.PDF. Данный образец подготовлен на основе варианта ДЗ, рассмотренного в МУ по ЛР[6,7]. Далее необходимо на основе “Шаблона документа ТО”, приведенного в конце МУ, создать свой документ ТО. Руководствуясь пояснениями в шаблоне ТО и методическими указаниями в разделе “Основные понятия”, необходимо разработать свой документ, применительно к варианте ДЗ.

24 Использование шаблонов и образцов для документов ОП и ТО

В конце данных МУ к ЛР№13 приведены шаблоны документов ОП и ТО. Нужно загрузить шаблон документа и внести необходимые изменения для идентификации студента, группы и индивидуального задания студента по вариантам. Места для изменений помечены красным цветом, а методические указания к его оформлению – синим цветом.

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

Для сильных студентов предлагаются дополнительные требования при выполнении ЛР №13 и ДЗ/КЛР. Эти требования могут быть выполнены в любой последовательности и в любом объеме. На титульном листе отчета по ЛР необходимо указать, что дополнительные требования выполнены. Нужно выбрать один из вариантов с дополнительными требованиями (31-36), согласовав свой выбор с преподавателем. Нужно учесть специальные дополнительные требования (по группам), приведенные в разделе вариантов для сильных студентов.

В документе ТЗ необходимо уже на этой стадии разработки учесть дополнительные требования.

Другие специальные дополнительные требования к работам студентов над ДЗ приведены после списка вариантных требований к группам студентов (см. также дополнительные требования для продвинутых студентов ниже).

26 Варианты по группам и студентам

Ниже приведены примерные варианты тем заданий для выполнения комплексной лабораторной работы (КЛР) или домашнего задания (ДЗ) по дисциплине “Программирование на основе классов и шаблонов”. Номера тем заданий соответствуют номерам студента по журналу группы на текущий семестр. Номера вариантов заданий меняются ежегодно, поэтому уточнить тему заданий можно в специальном документе, доступном оперативно студентам на сайте дисциплины: www.sergebolshakov.ru.

Номер варианта	Тема задания
	Класс публикаций в разных журналах и класс их каталогов этих публикаций. Предусмотреть операции объединения каталогов и сортировки по авторам, журналам, году издания и названиям статей и т.д.
	Класс факультетов и кафедр факультета, предусмотреть операции слияния/разделения кафедр и факультетов, перевода кафедр с одного факультета в другой.
	Класс слов и класс предложений. Предусмотреть операции объединения предложений, добавления, удаления и замены слов на заданных позициях и т.д.
	Класс строк переменной длинны и класс массивов этих строк, предусмотреть операции над строками и массивами строк (объединение и разбиения массивов) и т.д.
	Класс файлов и класс каталогов файлов, предусмотреть поиск по имени файла. Предусмотреть операции перемещения файлов, их добавления и удаления, поиска, переименования, сравнения и объединения каталогов и т.д.
	Класс словарей (русско-английских) и класс гнезд словарей (ячеек словарей), предусмотреть поиск и сортировку. Объединение словарей и разделение по алфавитному принципу и т.д.
	Класс множеств объектов и класс их элементов, предусмотреть весь известный из теории набор операций над множествами: объединение, вычитание, пересечение и др. Операции из дискретной математики.
	Класс групп студентов и класс студентов, предусмотреть операции слияния/разделения групп и редактирование всех видов объектов
	Класс перечней программных продуктов инсталлированных на разных ЭВМ и класс программных продуктов с атрибутами. Предусмотреть возможность объединения списков и замены версий программных продуктов в списке и т.д.
	Класс строительных бригады и класс работников бригад. Предусмотреть объединение и разделение бригад, добавление и удаление работников.
	Класс аннотированных ссылок на ИНТЕРНЕТ ресурсы и класс страниц (перечней), на которых они расположены, с возможностью поиска, предусмотреть операции объединения и очистки страниц и т.д.
	Класс программных продуктов и класс компакт дисков, где они записаны. Предусмотреть возможность слияния компакт дисков, их корректной очистки и разбиения на каталоги (каталог – возможно, это новый класс и объекты) и т.д.
	Класс стеллажей книг в библиотеке и класс книг. Предусмотреть объединение разделение стеллажей, добавление и удаление книг.
	Класс таблиц баз данных и класс записей в таблице (реляционная таблица). Предусмотреть класс связей между таблицами.
	Класс наборов компьютеров в локальной сети, класс компьютеров и класс их связей. Предусмотреть операции объединения и разделения наборов компьютеров сети, добавления, удаления и замены компьютеров в списках, изменения соединений, структуры сети и т.д.
	Класс изображений и класс слайдов презентаций (последовательностей слайдов). Изображения не выводятся на экран, а распечатываются в поток с названиями и характеристиками. Предусмотреть возможность включения вложенных презентаций.
	Класс отделов сотрудников и класс сотрудников, предусмотреть операции приема на работу, увольнения, изменение окладов и должностей. Операции объединения и разделения отделов, подсчета фонда зарплаты и средних характеристик отдела: стаж, возраст зарплата и т.д..
	Класс перечня (списка) блоков занятой и свободной оперативной памяти и класс отдельных блоков, предусмотреть сборку мусора объединения списков памяти, объединения и разделения блоков памяти и т.д.
	Класс комплектующих компьютера и класс их наборов (перечней комплектующих). Предусмотреть операции замен комплектующих по типу и множественность некоторых элементов компьютеров (например, диски). Предусмотреть очистку набора и изменение типа комплектующих элементов.
	Класс документов и класс папок с множеством документов, предусмотреть операции слияния папок, добавления и удаления из них документов.
	Классы заголовков текста в документах и классы документов. Предусмотреть возможности объединения документов. Документа на экран не выводятся. В заголовках должна быть указана позиция расположения в документах, они могут иметь многоуровневый вид (не менее 3-х уровней заголовков).
	Класс карточек учета товаров и класс картотек с поиском по названию товара, фирмы их продающих. Учесть даты их поступления. Предусмотреть операции добавления карточек, слияния фирм и ох очистки.
	Класс информации о различных событиях и класс их наборов (перечней событий). Обеспечить поиск по контексту названия, интервала дат и типу событий, которых должно быть не менее пяти. Объединение списков событий и т.д.
	Класс звуковых сигналов (нот) и класс мелодий из них, предусмотреть операции слияния мелодий и включения новых звуков в них (необязательно проигрывать мелодии и звуки, достаточно давать их буквенное обозначение)
	Класс очередей задач к ресурсам операционной системы и класс задач. Задача рассматривается как элемент с различными атрибутами (требуемая ОП, время счета и т.д.). Очередь организуется в режиме FIFO. Предусмотреть операции объединения очередей и изменения последовательности расположения задач в зависимости от характеристик и т.д.
	Класс окон интерфейса и класс управляющих элементов в этих окнах (кнопки, поля и т.д.). Сами окна и элементы интерфейса не выводятся на экран. Имитируется распечатка списка элементов и окон. Предусмотреть операции объединения окон и проверки корректности расположения элементов (отсутствие наложения друг на друга, нахождения в рамке окна и т.д.).
	Класс векторов и класс их списков (двумерные вектора), предусмотреть операции над векторами и списками векторов (сложение и т.д. из математики)
	Класс магазинов и класс товаров, которые продаются в данном магазине. Предусмотреть завоз новых товаров, продажу товаров. Объединение магазинов и выделение филиалов с товарами.
	Класс списка литературы и класс элементов списка литературы. Предусмотреть возможность объединения списков, их сортировки по разным критериям и распечатки и т.д.
	Класс мультимедиа объектов (звуки, рисунки, текст и т.д.) и класс их хранилищ ("холста" для рисунков). Объекты не воспроизводятся, нужно предусмотреть стандартный вывод названий и свойств. Предусмотреть операции объединения и расслоения холстов по введенным признакам, например номер слоя.
(Д.т.)	Класс двунаправленных списков и их произвольных элементов: строк, дат и чисел (нужно использовать указатели). Операции со списками их сортировки и их объединения. Создать собственные классы, а не копировать из VS и т.д. Необходимо придумать содержательный контейнерный класс для наследования от двунаправленных списков и элементный класс, объекты которого включаются в него.
(Д.т.)	Классы таблиц (строки и столбцы – произвольной размера) и их содержимого в виде текстовых ячеек. Операции объединения текста в ячейках, добавление текста, обмена ячейками и т.д.
(Д.т.)	Классы векторов и классы массивов векторов (трехмерные вектора) предусмотреть операции над векторами и массивами векторов (сложение и т.д. из математики)
(Д.т.)	Классы массив целых чисел и классы их массивов (массивов указателей для массивов), предусмотреть операции над массивами и числами: сложения, вычитания и объединения.
(Д.т.)	Класс баз данных и класс таблиц баз данных (реляционная таблица). Предусмотреть класс записей в таблицах.
(Д.т.)	Класс баз данных и класс таблиц баз данных (реляционная таблица). Предусмотреть класс связей между таблицами.

Примечание: Для того чтобы задания каждого студента были индивидуальными введены специальные требования для каждой из групп ( 2014/2015 учебный год):