Описание структуры базы данных
В описании структуры базы данных дается перечень полей каждой таблицы. Для описания структуры базы данных используется таблица 7.
Таблица 7 - Описание структуры базы данных
| Физическое имя таблицы (Логическое имя таблицы) | ||||
| Имя поля | Описание поля | Тип данных | Размер поля | Тип ключа[1]) |
Пример оформления структуры базы данных приведен в приложении Е.
Контрольный пример
При построении контрольного примера входные данные и предполагаемые результаты задаются в виде таблиц. Эти результаты в дальнейшем должны совпадать с результатами, полученными при работе программного продукта на соответствующих входных данных. Данные должны быть подобраны таким образом, чтобы на них можно было продемонстрировать работу основных функций задачи, а при получении отчетов однозначно просматривались критерии сортировки, группировки, а также промежуточные и окончательные итоги.
Общие требования к программному продукту
Описание требований к программному продукту содержит:
- обозначения и указания;
- функциональные возможности;
- надежность;
- эффективность.
При описании общих требований к программному продукту необходимо указать:
а) целевые рабочие задачи, которые могут быть выполнены данным продуктом;
б) ссылки на нормативные документы, которым удовлетворяет данный продукт, в этом случае должны быть указаны соответствующие редакции данных документов;
|
|
|
в) технические, программные средства, необходимые для ввода продукта в эксплуатацию, включая наименования изготовителей и обозначения типов всех ее частей, например:
1) процессоры, включая сопроцессоры;
2) объем основной памяти;
3) типы периферийных устройств;
4) оборудование ввода и вывода;
5) сетевое оборудование;
6) системные и прочие программные средства;
г) соответствующие интерфейсы или продукты, если в описании продукта имеются ссылки на интерфейсы с другими продуктами;
д) каждый физический компонент поставляемого продукта, в частности, все печатные документы и все носители данных;
е) вид поставляемых программ, например исходные программы, объектные (рабочие) модули или загрузочные модули;
ж) необходимое программное обеспечение для сопровождения продукта.
При описании функциональных возможностей необходимо отразить:
а) обзор функций продукта, необходимых для них данных и предоставляемых средств;
б) граничные значения. Если использование продукта ограничено конкретными граничными значениями. Они должны быть указаны в описании продукта, например:
1) минимальные или максимальные значения;
2) длины ключей;
3) максимальное число записей в файле;
|
|
|
4) максимальное число критериев поиска;
5) минимальный объем выборки.
При необходимости в описание продукта должна быть включена информация по средствам предотвращения несанкционированного доступа к программам и данным.
При описании надежности продукта необходимо привести информацию по процедурам сохранения данных. Например:
- проверка достоверности исходных данных;
- описание технологии сбора, передачи, обработки и выдачи информации;
- защита от серьезных последствий ошибки пользователя;
- восстановление при ошибках.
При описании эффективности необходимо отразить информацию о характере поведения продукта во времени, например, указать время ответа и время оценки производительности для заданных функций при установленных условиях (например, для заданных конфигураций системы и профилей загрузки).
В описание продукта могут быть внесены формулировки требований (правил) по сопровождению и мобильности продукта.
Экспериментальный раздел
В экспериментальном разделе следует отобразить документацию к выполненной программной разработке в рамках курсового проекта.
Независимо от конкретности проблемы, можно выделить некоторые общие требования, которые должны быть соблюдены:
|
|
|
- устойчивость программы. Программа не должна терять работоспособность ни при каких, даже некорректных, действиях пользователя. Всякие действия, грозящие потерей информации, выполняются только после повторного подтверждения. Вводимая информация там, где возможно, подвергается логическому контролю;
- обеспечение целостности баз данных. При любых действиях пользователя базы не должны терять целостности (некорректности индексов, потеря ссылок в связях после удаления – добавления записей и т.д.);
- функциональная полнота. В рамках согласованного с преподавателем или заказчиком подмножества функций все они должны быть реализованы;
- терминологическая среда и интерфейс. В диалоговых средствах используются только термины, понятные пользователю, и не используются термины разработчика («запись», «индексация» и т.д.), появление служебных англоязычных сообщений СУБД недопустимо. Язык диалога – с соблюдением норм вежливости, цветовая гамма – по общепринятым рекомендациям;
- входные и выходные документы. Экранные формы для ввода и корректировки должны быть максимально «похожими» на привычные для пользователя документы;
- средства документации. Программа может быть снабжена внутренней документацией.
|
|
|
Описание программы
Описание программы содержит: описание модулей, схему программы (модульную схему.
В описании модулей подробно описывается каждый модуль; перечисляются все процедуры, входящие в модуль; описываются действия, выполняемые в каждой процедуре модуля.
Схема программы выполняется согласно ГОСТ 19.701-90. ЕСПД. Схемы алгоритмов, программ, данных и систем. Обозначения условные и правила выполнения. Пример схемы программы представлен на рисунке 4.
Так же в качестве схемы может быть представлена модульная схема работы приложения.
Рисунок 4
Руководство пользователя
Руководство пользователя относится к эксплуатационной документации. Основная цель руководства пользователя заключается в обеспечении пользователя необходимой информацией для самостоятельной работы с программой или автоматизированной системой.
Таким образом, документ Руководство пользователя должен отвечать на следующие вопросы: что это за программа, что она может, что необходимо для обеспечения ее корректного функционирования и что делать в случае отказа системы.
Руководящими стандартами для создания документа Руководство пользователя могут являться как РД 50-34.698-90 в п.п. 3.4. «Руководство пользователя», так и ГОСТ 19.505-79 «Руководство оператора. Требования к содержанию и оформлению».
Основные разделы руководства пользователя:
- назначение системы;
- условия применения системы;
- подготовка системы к работе;
- описание операций;
- аварийные ситуации.
Назначение системы.
Данный раздел документа Руководство пользователя должен содержать информацию о назначении системы, ее целях и задачах.
Пример:
«Корпоративный интранет портал предназначен для повышения корпоративной культуры организации эффективного взаимодействия сотрудников.
Основной целью Портала является создание единого информационного пространства предприятия и оптимизация работы сотрудников путем облегчения коммуникаций между ними и оптимизации ряда бизнес-процессов».
Условия применения системы.
Данный раздел документа Руководство пользователя должен включать все те факторы, которые необходимы для корректной работы системы. Здесь можно выделить несколько подразделов:
Требования к аппаратному обеспечению – сюда можно включить требования к конфигурации компьютера пользователя, программное обеспечение необходимое для работы Системы, а также наличие дополнительного оборудования (принтер, сканер и т.п.), если таковое необходимо;
Квалификация пользователя – данный подраздел должен содержать требования к навыкам и знаниям пользователя, например: «Пользователи должны обладать навыками работы с операционной системой Windows 2012».
Подготовка системы к работе.
Данный раздел документа Руководство пользователя должен содержать пошаговую инструкцию для запуска приложения. К этапу подготовки системы к работе можно отнести установку дополнительных приложений (при необходимости), идентификацию, аутентификацию и т.п.
Описание операций.
Это основной раздел документа Руководство пользователя, который содержит пошаговую инструкцию для выполнения того или иного действия пользователем.
Если работа автоматизированной системы затрагивает целый бизнес-процесс, то в руководстве пользователя перед описанием операций целесообразно предоставить информацию о данном процессе его назначении и участниках. Подобное решение позволяет человеку четко представить свою роль в данном процессе и те функции, которые реализованы для него в системе.
Далее в документе Руководство пользователя следует представить описание функций разбитых на отдельные операции. Необходимо выделить подразделы, описывающие функции данного процесса, и действия, которые необходимо совершить для их выполнения.
Пример:
«4.1 Согласование проекта. Данный процесс предназначен для организации работы сотрудников, участвующих в разработке и согласовании проекта. Автор проекта создает запись в Системе и прикрепляет пакет необходимой документации, далее проект передается на согласование руководящими лицами. Руководители после ознакомления с проектом могут подтвердить его или отправить на доработку Автору.
4.1.1 Создание проекта. Для того чтобы создать Проект необходимо на панели «…» нажать на кнопку «…» и в появившейся форме заполнить следующие поля:
Наименование проекта
Описание проекта
Следующие поля заполняются автоматически:
Дата создания проекта – текущая дата;
Автор – ФИО и должность автора проекта»
Руководство пользователя может представлять собой как краткий справочник по основному функционалу программы, так и полное учебное пособие. Методика изложения материала в данном случае будет зависеть от объема самой программы и требований заказчика.
Чем подробнее будут описаны действия с системой, тем меньше вопросов возникнет у пользователя. Для более легкого понимания всех принципов работы с программой стандартами в документе Руководство пользователя допускается использовать схемы, таблицы, иллюстрации с изображением экранных форм.
Аварийные ситуации.
Данный раздел документа Руководство пользователя должен содержать пошаговые инструкции действий пользователя в случае отказа работы Системы. Если к пользователю не были предъявлены особые требования по администрированию операционной системы и т.п., то можно ограничиться фразой «При отказе или сбое в работе Системы необходимо обратиться к Системному администратору». Сообщения пользователю оформляются в виде таблицы, в которой перечисляются все сообщения, выдаваемые программой, их причина и необходимые действия пользователя.
Таблица 8 - Сообщение пользователю
Дата добавления: 2019-11-25; просмотров: 225; Мы поможем в написании вашей работы! |
Мы поможем в написании ваших работ!