Методические указания ПО формированию пакета документов ПП

Лабораторная работа №23

«Документирование новой версии ПО»

 

Цель: Изучить основы документирования новой версии ПО.

Содержание отчета:

- Цель, название лабораторной работы.

- Документация для ИС, разрабатываемого в течении семестра (Пояснительная записка, Руководство пользователя).

 

Методические указания по формированию пакета документов ПП

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

 

Пояснительная записка должна иметь следующее содержание:

Введение.

1. Техническое задание.

1.1. Назначение и область применения программного продукта.

1.2. Основание для разработки программного продукта.

1.3. Источники входной информации.

1.4. Выходная информация.

1.5. Методы решения задачи.

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

1.5.2. Расчётные формулы для получения промежуточных результатов.

1.5.3. Описание методики решения задачи.

1.6. Требования к программному продукту.

1.6.1. Требования к конфигурации электронно-вычислительных средств.

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

1.6.3. Требования к языку программирования.

Разработка программного продукта.

2.1. Постановка задачи.

2.1.1. Разработка структуры входных данных.

2.1.2. Разработка диаграмм.

2.1.3. Построение связей между объектами.

2.1.4. Создание программных модулей.

2.2. Пример контрольного теста.

 

Литература

1. Структурная схема программного продукта.

2. Блок-схема алгоритма работы основных расчётных модулей.

3. Распечатка контрольных тестов.

4. Руководство пользователя.

 

4.1. Методические указания содержанию разделов пояснительной записки

 

 

Введение.

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

Техническое задание.

 Основанием для разработки технического задания является тема, утвержденная преподавателем. Техническое задание составляется учащимся в соответствии с требованиями ГОСТ 19.201-78 «Техническое задание. Требования к содержанию и оформлению». В техническом задании должны быть указаны:

1) источники входной информации (формы, маршрутные карты, бланки и т.п.);

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

3) требования к программному продукту. Следует описать требования заказчика.

К требованиям также относятся:

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

б) формирование интерфейса;

в) организация поиска информации;

г) резервирование информации;

д) методы формирования выходных документов.

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

Назначение и область применения программного продукта.

В разделе «Назначение программы» указывают назначение, область применения, возможности программы, ее основные характеристики, ограничения, накладываемые на область применения программы [из п. 5 ГОСТ 19.502-78].

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

В этом разделе описывается причины разработки ПП.

Источники входной информации.

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

Выходная информация.

Выходная информация – результат выполнения запросов, фильтрации данных, вывод необходимой информации в отчет, печать информации. Информация, которая несет вывод либо обобщает указанные данные в общем виде или по определенному критерию.

Методы решения задачи.

Решение задач методом поиска в пространстве состояний.

Решение задач методом редукции.

Решение задач дедуктивного выбора

Решение задач, использующие немонотонные логики, вероятностные логики.

Требования к программному продукту.

Тут описываются минимальные требования которые должны быть для того чтобы использовать программный продукт. Ниже описаны примеры заполнения пунктов 1.6.1-1.6.3.

Требования к конфигурации электронно-вычислительных средств

Минимальные требования к конфигурации электронно-вычислительных средств:

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

Программный продукт требует Microsoft Net Framework не ниже версии 2.0. Операционные системы Microsoft не ниже Windows XP SP1.

  Требования к языку программирования

Средой разработки выбран Embarcadero C++Builder 2006 - это передовая среда разработки на языке C++, предназначенная для создания интерактивных приложений с пользовательским интерфейсом для настольных компьютеров, рабочих станций, сенсорных дисплеев, информационных терминалов и Интернета. Это единственная двусторонняя визуальная среда с широкими функциональными возможностями для быстрой разработки на языке C++ приложений с развитым пользовательским интерфейсом и приложений баз данных. Приложения, созданные в среде C++Builder, отличаются высочайшим быстродействием и компактностью, а также обладают полнофункциональным пользовательским интерфейсом и способностью подключаться практически к любой базе данных или другому источнику данных, не требуя дополнительной доработки.

Основные возможности:

интегрированные средства ANSI/ISO C++ с поддержкой предварительной спецификации C++0x;

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

поддержка библиотек Boost и TR1;

более 250 компонентов в библиотеке VCL;

встроенная поддержка касаний и жестов;

dbExpress с поддержкой 9 основных баз данных;

многоуровневое промежуточное ПО DataSnap с поддержкой JSON, REST, HTTP, COM и XML;

Постановка задачи.

Постановка задачи — точная формулировка условий задачи с описанием входной и выходной информации. Входная информация по задаче — данные, поступающие на вход задачи и используемые для её решения.

 Подраздел «Постановка задачи» состоит из следующих пунктов:

 

Разработка диаграмм.

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

Пример контрольного теста.

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

Примеры описания тестов:

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

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

В данном разделе в обязательном порядке должны быть представлены результаты работы модулей.

Непосредственно содержание контрольных тестов распечатывается отдельно и представляется в виде приложения.

 

  Методические указания по содержанию руководства пользователя

Руководство пользователя составляется как самостоятельный документ. Содержание руководства пользователя:

1. Правила эксплуатации программного продукта.

1.1. Технические условия эксплуатации.

2. Эксплуатация программного продукта.

2.2. Организация корректного вызова программного продукта.

2.3. Демонстрационный пример работы программного продукта.

2.4. Сообщения программного продукта.

РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ

 

ОБЩИЕ ПОЛОЖЕНИЯ

 

1.1 Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным.

1.2 Руководство пользователя должно содержать следующие разделы:

· назначение программы;

· условия выполнения программы;

· выполнение программы;

· сообщения пользователю.

В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.

 

СОДЕРЖАНИЕ РАЗДЕЛОВ

 

2.1 В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.

2.2 В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратных и программных средств и т.п.).

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

2.4 (Исключён).

2.5 В разделе «Сообщения пользователю» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия пользователя (действия пользователя в случае сбоя, возможности повторного запуска программы и т. п.).

2.6 Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.

2.7 В приложении к руководству пользователя допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.

 

 

Лабораторная работа №23

«Документирование новой версии ПО»

 

Цель: Изучить основы документирования новой версии ПО.

Содержание отчета:

- Цель, название лабораторной работы.

- Документация для ИС, разрабатываемого в течении семестра (Пояснительная записка, Руководство пользователя).

 

Методические указания по формированию пакета документов ПП

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

 

Пояснительная записка должна иметь следующее содержание:

Введение.

1. Техническое задание.

1.1. Назначение и область применения программного продукта.

1.2. Основание для разработки программного продукта.

1.3. Источники входной информации.

1.4. Выходная информация.

1.5. Методы решения задачи.

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

1.5.2. Расчётные формулы для получения промежуточных результатов.

1.5.3. Описание методики решения задачи.

1.6. Требования к программному продукту.

1.6.1. Требования к конфигурации электронно-вычислительных средств.

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

1.6.3. Требования к языку программирования.