Составление руководства пользователя




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

Можно выделить некоторые формальные требования, на которых защищается квалификация разработчика.

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

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

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

4. Средства документации. Программы снабжаются внутренней документацией в виде комментариев, средств меню и диалога, средств помощи.

4.

Структура курсовой работы

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

1. Титульный лист

2. Содержание

3. Введение

4. Теоретическая часть.

5. Практическая часть.

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

5.2. Анализ задачи

5.2.1. Существующие подходы к решению задачи и используемые стандарты

5.2.2. Выбор метода решения задачи

5.2.3. Анализ требований

5.3. Проектирование

5.4. Кодирование

5.5. Тестирование

6. Заключение

7. Приложения

7.1. алгоритм задачи

7.2. листинг программы

7.3. результаты испытаний

7.4. руководство пользователя

8. Список используемой литературы

1.Титульный лист оформляется по образце, представленному в приложении.

2.Содержание включает наименование всех глав и параграфов (если они имеются) с указанием номера страниц, на которых размещается начало материала главы (параграфа).

Введение

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

Теоретическая часть

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

Практическая часть содержит в себе несколько пунктов

Практическая часть

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

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

Анализ задачи

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

При проведении анализа требований указываются

· требования к функциональным характеристикам (описывается детальный список функций, реализуемых приложением для обеспечения выполнения требований, указанных в разделе «Постановка задачи».)

· требования надежности (указываются ошибки, которые программа должна правильно обрабатывать)

· требования к составу и параметрам технических средств (указываются параметры компьютеров на которых будет эксплуатироваться программа).

· требования к информационной и программной совместимости (указывается язык программирования на котором будет написана программа и операционная система необходимая для ее функционирования)

Проектирование

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

Кодирование

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

Полный листинг программы приводится в приложении 2.

 

Тестирование

Здесь указываются способы и методы тестирования и отладки задачи.

Тестовые результаты приводятся в приложении 3.

Заключение

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

 

Приложения

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

Составление руководства пользователя

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

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

1. «О программе» – описание программы, назначение и основные возможности.

2. «Системные требования» – список аппаратных и программных средств и их характеристик, необходимых для запуска и успешного функционирования программы.

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

4. «Запуск программы» – описание действий, необходимых для запуска программы.

5. «Работа с программой» – пошаговое описание основных действий (в соответствии с выбранным подходом к написанию руководства), которые доступны в программе, с пояснениями и скриншотами примерами.

6. «Приложение». Необязательный раздел, добавляется при необходимости и может включать любые сведения, не вошедшие в вышеперечисленные разделы, например, глоссарий.

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

 

8.Список использованной литературы указывается в виде библиографического списка по алфавиту. Список использованной литературы составляется в соответствии с ГОСТ 71-84 «Библиографическое описание документа». В список включаются только те источники, которые использовались при подготовке курсовой работы и на которые имеются ссылки в работе.

При описании литературного источника необходимо указать:

· фамилии и инициалы авторов,

· название книги, статьи,

· место издания,

· издательство,

· год издания,

· объем (количество страниц).

Для материалов из Интернета указывают:

· фамилии и инициалы авторов,

· полное название материала,

· Интернет-адрес,

· дату просмотра материала в Интернете.

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

Книга одного и более авторов

Когаловский М.Р. Энциклопедия технологий баз данных. – М.: Финансы и статистика, 2002. – 800 с.

Информационные технологии управления / Под ред. Титоренко Г.А. – М.: ЮНИТИ-ДАНА, 2003. – 439 с.

Статья из журнала

Коржов В. Internet на космической скорости // Мир ПК. – 2001. – №1. С. 86–87.

Публикации в сети Интернет

Микушин А. В. Микропроцессоры. – https://www.computer-museum.ru/technlgy/proclect/content.htm (16.04.06)

Александр Евангели. Новое поколение глобальных сетей // BYTE/Россия, №7, 2005. – https://bytemag.ru/?ID=604029 (20.12.12)



Поделиться:




Поиск по сайту

©2015-2024 poisk-ru.ru
Все права принадлежать их авторам. Данный сайт не претендует на авторства, а предоставляет бесплатное использование.
Дата создания страницы: 2018-01-27 Нарушение авторских прав и Нарушение персональных данных


Поиск по сайту: