doc_kr35_2009 (Готовое ДЗ неизвестного варианта (1)), страница 2

Примечание: Отмечу, что данном случае, программа испытания строится для проверки системы классов на тестовом примере, а не тестового примера! На это должны быть рассчитаны пункты проверки в таблице.

1. Стиль изложения должен быть предписывающим, и основан на техническом языке, принятом программистами и специалистами по разработке ПП (программистский жаргон недопустим). Например, "нажмите … клавишу", "получите на экране …", "испытания должны проводиться в режиме командной строки MS DOC в.6.12" и т.д. Неоднозначностей и ошибок в тексте документа ПМИ не должно быть. Данный документ должен быть лаконичным и четким. Не нужно строить сложные предложения.

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

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

   1. В п.1 описывается, что испытывается, включая и наименование программного изделия.

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

   3. В п.3 приводится полный перечень представляемой документации для проведения испытаний.

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

   5. В пункте 5.1 определены конкретные условия проведения испытания для проверки. В пункте 5.2 в виде таблицы, формат которой приведен ниже дается перечень действий и результатов, необходимых для проведения испытаний. Пример таблицы:

Примечания: 1. В колонке 2 можно не раскрывать содержание пункта ТЗ, но желательно.

2. Выполняемые действия должны быть точными, расписанными в точности до нажатия отдельной клавиши.

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

4. Каждая строка таблицы проверки пунктов ТЗ должна содержать описание действий для выборочной проверки этого пункта. Поэтому нужно продумать все необходимое и возможно продублировать действия других пунктов или выполнить ссылку на них (по пункту в колонке №1).

5. Колонка 5 таблицы необязательна.

1. В пункте 6 , при необходимости, описываются методы и методики проведения испытаний, которые трудно отобразить в таблице п.5 (например, выводимые результаты на экран, сложные эксперименты для проверки работоспособности и т.д.). В этом случае пункты должны быть пронумерованы, а в таблице ПМИ будут сделаны ссылки на эти пункты.

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

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

   1. Структура оглавления руководства пользователя очень зависит от функционального назначения ПП. Даже в рамках разных вариантов КР этот документ может иметь существенные отличия. Все отличия мы сведем в п.4. Для нашего случая структура документа может иметь вид:

1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ

2. ПОДГОТОВКА К РАБОТЕ С ПРОГРАММОЙ

3. ЗАПУСК ПРОГРАММЫ

4. РАБОТА С ПРОГРАММОЙ (системой классов)

4.1 Работа с программой в режиме …

4.2 Работа с программой в режиме …

…

5. ЗАВЕРШЕНИЕ РАБОТЫ ПРОГРАММЫ

6. ОПИСАНИЕ СООБЩЕНИЙ ОБ ОШИБКАХ И ИСКЛЮЧИТЕЛЬНЫХ СИТУАЦИЙ ПРИ РАБОТЕ С ПРОГРАММОЙ

1. Стиль изложения руководства пользователя должен быть описательным и исчерпывающим. Описание необходимо давать простым языком, без злоупотреблений техническими терминами. Должны рассматриваться различные примеры и рисунки для различных режимов работы, рассматриваться ошибочные ситуации и диагностические сообщения. Данный документ должен понимать тот пользователь, на которого рассчитан программный продукт. В тексте документа не должно содержаться пространных рассуждений и материала, не относящегося к программному продукту. Должна быть дана подробная инструкция применения программы, включая запуск, использование и выгрузку. системы классов: подключения в программу, создания и манипулирования объектами, использование всех методов. Должны быть даны наглядные примеры для всех случаев использования.

2. Главные требования к основным разделам руководства пользователя (на выполнение этих требований будет обращаться повышенное внимание при предъявлении ПП).

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

   2. В пункте 2 приводятся необходимые действия для подготовки работы с программой, системой классов.

   3. В пункте 3 описываются в БНФ способы запуска программы с примерами для всех возможных случаев. Приводятся диагностические сообщения, выдаваемые программой при различных режимах применения и ошибках.

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

   5. В пункте 6 дается перечень сообщений программы в виде таблицы и действия пользователя при появлении этих сообщений. Описываются возможные исключительные ситуации (например, объект не создается) и способы их обработки.

   6. К данной инструкции может быть приложено описание тестового примера, если он входить в комплект поставки библиотеки классов.

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

   1. Структура оглавления руководства системного программиста:

1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ

2. ТРЕБОВАНИЯ К СОСТАВУ И ПАРАМЕТРАМ ТЕХНИЧЕСКИХ СРЕДСТВ

3. ТРЕБОВАНИЯ К ПРОГРАММНОМУ ОБЕСПЕЧЕНИЮ

4. СОСТАВ ПРОГРАММНОГО ПРОДУКТА

5. УСТАНОВКА ПРОДУКТА

6. УДАЛЕНИЕ ПРОДУКТА

7. ХАРАКТЕРИСТИКИ СИСТЕМЫ

8. ПОДГОТОВКА К РАБОТЕ С ПРОГРАММОЙ

9. ЗАПУСК ПРОГРАММЫ

10. ЗАВЕРШЕНИЕ РАБОТЫ ПРОГРАММЫ

1. Стиль изложения руководства системного программиста должен быть предписывающим: "Для установки ПП нужно выполнить следующие действия …", "ПП состоит из набора следующих компонент …". Здесь могут использоваться специальные термины, но не жаргон программистов.

2. Главные требования к основным разделам руководства системного программиста (на выполнение этих требований будет обращаться повышенное внимание при предъявлении ПП):

   1. Информация в п.п. 1-3 повторяет другие документы, в частности описанию применения, техническому описанию и ПМИ.

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

   3. В п.5 описывается процесс развертывания программного продукта на отдельном компьютере(подключения системы классов в используемую систему программировния). Описание нужно дать по шагам. Описываются все ситуации, включая и нештатные, когда продукт установить нельзя. Если, при установке, для конкретного шага, выдается информационное сообщение, то оно должно быть тоже приведено.

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

   5. В п.6 описывается процесс удаления программного продукта с отдельного компьютера. Описание нужно дать по шагам. Описываются все ситуации, включая и нештатные, когда продукт удалить нельзя. Если, при удалении, для конкретного шага, выдается информационное сообщение, то оно должно быть тоже приведено.

1. 3 листа формата А3 или А2, поясняющие работу и конструкцию программного продукта.

   1. В курсовой работе разрабатывается 3 листа, конструкторской документации. Листы могут быть выполнены в машинном исполнении, только в этом случае допускается их распечатка в уменьшенном формате на бумаге А4 (можно использовать Visio, MetaDesign, CorelDraw и других пакеты).

   2. В листах к КР/ДЗ должно быть отражено:

• Блок схемы алгоритмов программы и процедур (обязательно);

• Модульная структура программы (обязательно);

• Пользовательский интерфейс в виде инструкции командной строки - БНФ (при большой сложности);

• Структуры данных (при необходимости);

• Другая проектная информация(при необходимости);

• Граф диалога с пользователем (при наличии);

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

1. Листы представляются отдельно, а не располагаются внутри других документов.

ЕДИНЫЙ ТИТУЛЬНЫЙ ЛИСТ ДЛЯ ВСЕХ ДОКУМЕНТОВ ПРИВЕДЕН НА СЛЕДУЮЩЕЙ СТРАНИЦЕ!!!

Московский государственный технический университет им. Н.Э.Баумана

_________________________________________________________________

Домашнее задание по дисциплине ПППО