Руководства, Инструкции, Бланки

руководство пользователя программы пример по госту img-1

руководство пользователя программы пример по госту

Категория: Руководства

Описание

50 Виды программных документов

5 0 Виды программных документов.

К программным относят документы, содержащие сведения, необходи­мые для разработки, сопровождения и эксплуатации программного обеспе­чения. Документирование программною обеспечения осуществляется в со­ответствии с Единой системой программной документации (ГОСТ 19. XXX ). Так ГОСТ 19.101-77 устанавливает виды программных документов для про­граммного обеспечения различных типов. Ниже перечислены основные про­граммные документы по этому стандарту и указано, какую информацию они должны содержать.

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

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

Те кст пр ограммы (код вида документа - 12) должен содержать текст программы с необходимыми комментариями. Необходимость этого докумен­та определяете я на папе разработки и утверждения технического задания.

Описание программы (код вида документа -13) должно содержать сведения о логической структуре и функционировании программы. Необходимость данного документа также определяется на этапе разработки и утверждения технического задания.

Ведомость эксплуатационных документов (код вида документа - 20) должна содержать перечень эксплуатационных документов на программу, к которым относятся документы с кодами: 30, 31, 32, 33, 34. 35. 46. Необходимость этого документа также определяется на этапе разработки и утверждения технического задания.

Формуляр (код вида документа - 30) должен содержать основные характеристики ПО, комплектность и сведения об эксплуатации программы.

Описание применения (код вида документа - 31) должно содержать сведения о назначении программного обеспечения, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, ми­нимальной конфигурации технических средств.

Руководство системного программиста (код вида документа - 32) должно содержать сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения.

Руководство программиста (код вида документа - 33) должно содер­жать сведения для эксплуатации программного обеспечения.

Руководство оператора (код вида документа - 34) должно содержать сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программного обеспечения.

Описание языка (код вида документа - 35) должно содержать описание синтаксиса и семантики языка.

Руководство по техническому обслуживанию (код вида документа - 46) должно содержать сведения для применения тестовых и диагностических программ при обслуживании технических средств.

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

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

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

Код вида документа указывается в его децимальном номере, например:

42333253.00037-01 34 01 (руководство оператора).

Допускается объединять отдельные виды эксплуатационных документов, кроме формуляра и ведомости. Необходимость объединения указывается в техническом задании, а имя берут у одного из объединяемых документов. Например, в настоящее время часто используется эксплуатационный до­кумент, в который отчасти входит руководство системного программиста, программиста и оператора. Он называется «Руководство пользователя».

Рассмотрим наиболее важные программные документы более подробно.

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

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

-учитывайте интересы пользователей - руководство должно содержать все инструкции, необходимые пользователю;

-излагайте ясно, используйте короткие предложения;

-избегайте технического жаргона и узко специальной терминологии, ес­ли все же необходимо использовать некоторые термины, то их следует пояс­нить;

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

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

-общие сведения о программном продукте;

-инструкции по работе (или описание пользовательского интерфейса);

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

Раздел Установка обычно содержит подробное описание действий по установке программного продукта и сообщений, которые при этом могут быть получены.

В разделе Запуск, как правило, описаны действия по запуску ПО и сообщений. которые при этом могут быть получены.

Раздел Инструкции по работе обычно содержит описание режимов работы, форматов ввода-вывода информации и возможных настроек.

Раздел Сообщения пользователю должен содержать перечень возможных сообщений, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.

Руководство системного программиста

По ГОСТ 19.503-79 руководство системного программиста должно содержать всю информацию, необходимую для установки ПО, его настройки и проверки работоспособности. Кроме того в него часто включают и описание необходимого обслуживания, которое раньше приводилось в руководстве оператора (ГОСТ 19.505-79) и/или руководстве по техническому обслуживанию (ГОСТ 19.508-79). В настоящее время данную схему используют для составления руководства системному администратору.

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

-общие сведения о программе;

-сообщения системному программисту.

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

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

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

В разделе Проверка программы должно быть приведено описание способов проверки работоспособности программы, например контрольные примеры.

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

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

Другие статьи

Приложение 7

Методические указания к курсовой работе по дисциплине «Базы данных» Приложение 7. Пример оформления руководства пользователя согласно ГОСТу

Уфимский государственный авиационный технический университет
Кафедра вычислительной математики и кибернетики

«Автоматизированная система построения рейтингов»

Руководство пользователя
Листов 16


Программный продукт (ПП) «Автоматизированная система построения рейтингов» предназначен для построения рейтингов объектов, если информация об объектах представлена в виде:

  • набора индивидуальных ранжирований (1-ая группа методов);

  • значений набора критериев (2-ая группа методов).

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

ПП может использоваться для решения как практических, так и исследовательских задач.

Данный документ указывает:

  • сведения о назначении программного продукта и информацию, достаточную для понимания функций программного продукта и его эксплуатации;

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

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

  • тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора.
^ Назначение программы
ПП предназначен для построения рейтингов объектов, если информация об объектах представлена в виде:

  • набора индивидуальных ранжирований (1-ая группа методов);

  • значений набора критериев (2-ая группа методов).

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

К 1-ой группе методов относятся метод Борда и «медиана Кемени», ко 2-ой группе относятся метод анализа иерархий Саати и алгоритм Мамдани.

Условия выполнения программы
Для выполнения программой заданных функций, ей необходимо следующее программно-аппаратной окружение:

  1. IBM PC-совместимый компьютер с процессором – Intel ? Pentium ? 100 или выше;

  2. оперативная память – не менее 32Mb;

  3. SVGA-монитор;

  4. клавиатура;

  5. манипулятор типа «мышь»;

  6. операционная система Microsoft ? Windows ? 9x.
Выполнение программы


Предполагается, что у каждого эксперта имеется копия программы. Для проведения исследования ему отсылается файл с настройками. Он заполняет исходные данные и отсылает файл с результатами индивидуального ранжирования обратно. Затем данные различных экспертов обрабатываются одним из методов построения итогового ранжирования и сохраняются в виде HTML-документа, который автоматически попадает на сайт.

Работа с программой состоит из следующих основных этапов:

  1. ввод участников рейтинга;

  2. если для построения рейтинга используется метод Саати или алгоритм Мамдани, то их настройка;

  3. ввод данных для соответствующего метода(ов);

  4. просмотр результатов соответствующего метода(ов)

  5. сохранение результатов работы методов (для алгоритма Мамдани и метода Саати) или исходных данных для первой группы методов с целью их дальнейшего использования для получения итогового ранжирования.

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

  1. перейти в директорию, в которой находится программа;

  2. активизировать файл RatingProject.exe;

  3. двойным щелчком мыши или нажатием клавиши ENTER на клавиатуре запустить программу.

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

Рисунок 4.1. Главное окно программы

Пункт меню «Файл» содержит подпункты:

  1. «Новый» - вся текущая информация о настройках и исходных данных удаляется из программы, система готова к вводу информации о новом исследовании.

  2. «Открыть» - загрузка в программу информации об исследовании, хранящейся в 4 файлах с расширениями rtg, txt, fuz, saa, при этом информация о текущем редактируемом исследовании может быть утеряна, если она не была предварительно сохранена с помощью подпункта меню «Сохранить».

  3. «Сохранить» - сохранение информации о текущей редактируемом исследовании в файлы с расширениями rtg, txt, fuz, saa.

  4. «Выход» - завершение работы программы.

Пункт меню «Данные» содержит подпункты меню, которые предназначены для открытия окон «Медиана Кемени, метод Борда», «Метод Саати – ввод данных», «Алгоритм Мамдани – ввод данных».

Пункт меню «Настройки» содержит подпункты меню, которые предназначены для открытия окон «Метод Саати - настройки» и «Алгоритм Мадани - настройки».

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

Для добавления, удаления или изменения имени объекта исследования используйте кнопки «Добавить», «Удалить», «Изменить». Число объектов исследования не должно превышать 100. При попытке добавить еще один объект программа выдаст сообщение об ошибке.

Метод Борда и «медиана Кемени»


Для работы с 1-ой группой методов (метод Борда, «медиана Кемени») необходимо открыть окно для ввода данных, выбрав подпункт меню «Медиана Кемени» пункта меню «Данные» (Рисунок 4.2).

Рисунок 4.2. Ввод данных для 1-ой группы методов

Для ввода данных ранжирования объектов новым экспертом необходимо сначала добавить эксперта в список экспертов.

Для редактирования данных нужного эксперта сначала нужно выбрать этого эксперта в списке (указав на него мышью), а затем ввести данные об объектах в таблицу «Ранжировка объектов текущего эксперта» (по умолчанию ранг всех объектов равен 1).

Для редактирования имени эксперта следует выбрать его в списке, отредактировать имя, и нажать кнопку «Изменить».

Для удаления данных о ранжировании эксперта, следует выбрать его в списке и нажать кнопку «Удалить».

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

Если ввод данных закончен, то можно просмотреть результат работы методов в окне «Просмотр результатов», нажав соответствующую кнопку.

Метод Саати
Для работы с методом Саати необходимо:

  1. представить проблему исследования в виде иерархии с помощью графического редактора, который вызывается с помощью подпункта меню «Метод Саати» пункта меню «Настройки».

  2. ввести данные для определения «важности» подцелей и критериев, а также значений критериев для объектов.

Рисунок 4.3. Редактор для построения иерархии

Вид окна графического редактора представлен на рисунке 4.3.

Для рисования вершины нужно нажать кнопку рисования вершины в меню «Инструменты» и указать мышью месторасположение вершины в области рисования. После чего откроется окно для ввода имени вершины.

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

Для удаления или переименования вершины следует выбрать соответствующий пункт всплывающего меню, которое появляется при нажатии правой кнопки мыши на выделенной вершине (Рисунок 4.4). При удалении вершины удаляются все связанные с ней дуги.

Рисунок 4.4. Пример работы всплывающего меню
Для рисования дуги необходимо нажать кнопку рисования дуги в меню «Инструменты», указать мышью начальную и конечную вершины дуги. Если при этом вы попадете не на вершину, то стрелка не нарисуется.

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

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

Окно «Метод Саати - ввод данных» представлено на рисунке 4.5.

Рисунок 4.5. Окно ввода данных для метода Саати
Сравнение критериев, подцелей и объектов осуществляется на основе 9-балльной шкалы, описание которой расположено в верхней части окна. Результаты сравнения подцелей, критериев и объектов заносятся в матрицы. Каждый элемент матрицы имеет вид ki |kj и означает, что элемент i «лучше» или «хуже» элемента j в ki /kj раз, где ki и kj числа от 1 до 9. Для ввода элементов матрицы нужно предварительно выбрать ее в списке матриц, после этого ввести значения в верхнюю таблицу. Если какой-либо из критериев измеряется объективно (например, скорость, цена и т.д.), то после выбора соответствующей ему матрицы следует включить переключатель «Объективно измеряемый параметр» и ввести значения критерия в нижнюю таблицу.

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

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

Алгоритм Мамдани


Для настройки алгоритма Мамдани следует открыть окно «Алгоритм Мамдани - настройка» (Рисунок 4.6).

Рисунок 4.6. Окно настроек алгоритма Мамдани

Для добавления новой входной или выходной переменной следует вызвать «Редактор нечетких переменных» нажатием кнопки «Добавить».

Для редактирования входных или выходных переменных следует вызвать «Редактор нечетких переменных» нажатием кнопки «Изменить», при этом в списке переменных предварительно нужно выделить ту переменную, которую Вы хотите отредактировать.

После этого открывается новое окно «Редактирование нечеткой переменной» (Рисунок 4.7), в котором можно:

  1. изменить имя нечеткой переменной;

  2. отредактировать диапазон изменения нечеткой переменной;

  3. добавить новое значение нечеткой переменной или отредактировать выбранное из списка значение переменной, нажав кнопку «Добавить» или «Редактировать» соответственно, при этом откроется новое окно «Редактирование значения переменной», в котором можно:

    • отредактировать название значения переменой;

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

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

Рисунок 4.7. Редактирование нечеткой переменной

Для закрытия окна следует нажать кнопку «Закончить редактирование».

Для удаления входной или выходной нечеткой переменной следует выделить нужную переменную в списке и нажать соответствующую кнопку «Удалить» (Рисунок 4.6).

Для добавления нового правила в базу знаний следует вызвать «Редактор правил» нажатием соответствующей кнопки «Добавить» (Рисунок 4.6).

Для редактирования правила следует вызвать «Редактор правил» нажатием соответствующей кнопки «Изменить», при этом в списке правил предварительно нужно выделить то правило, которое Вы хотите отредактировать.

После этого открывается новое окно «Редактирование правил» (Рисунок 4.8), в котором можно:

  1. отредактировать условие:

Рисунок 4.8. Редактирование правил

  • для добавления простого условия следует нажать кнопку «Добавить», при этом откроется новое окно (Рисунок 4.9), в котором нужно выбрать имя и значение входной переменной.

Рисунок 4.9. Добавление простого условия

  • для добавления сложного условия следует нажать кнопку «Сложное условие» (Рисунок 4.8), при этом откроется новое окно (Рисунок 4.10), в котором опять можно добавить (кнопка «Добавить» или «Сложное условие»), изменить (кнопка «Изменить») или удалить (кнопка «Удалить») как простое, так и сложное условие.

  • для редактирования условия следует нажать кнопку «Изменить», после чего откроется новое окно программы в зависимости от типа условия: окно с рисунка 4.9 для простого условия или окно с рисунка 4.10 для сложного условия;

  • для удаления условия следует нажать кнопку «Удалить».

Рисунок 4.10. Добавление сложных условий

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

Для просмотра работы алгоритма следует нажать кнопку «Просмотр результатов» (Рисунок 4.6), после чего открывается новое окно (Рисунок 4.11).

Рисунок 4.11. Просмотр работы алгоритма

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

Данный метод можно использовать не только для построения рейтингов, но также для исследования любой проблемы, знания о которой можно представить в виде правил вида «если …, то…». Например, на рисунке 4.11 показан пример определения заработной платы в зависимости от стажа работы сотрудника и уровня его подготовки (в виде результатов квалификационного тестирования).

После того как настройка закончена, можно приступать к вводу значений критериев в окне «Алгоритм Мамдани – ввод данных» (Рисунок 4.12).

Рисунок 4.12. Ввод данных для алгоритма Мамдани

После ввода данных можно просмотреть результаты в окне «Просмотр результатов».

Вид окна «Просмотр результатов» представлен на рисунке 4.13.

Для просмотра результатов построения рейтинга нужно нажать кнопку «Перерисовать». Результаты будут представлены в виде графика и в табличной форме. Виды методов настраиваются с помощью переключателей в нижнем левом углу окна.

Кнопки «Метод Саати» и «Алгоритм Мамдани» предназначены для сохранения результатов работы соответствующих методов в файлы с расширением res, которые затем могут быть загружены в программу с помощью кнопки «Загрузить данные из файла» в окне ввода данных для первой группы методо при проведении исследований, в которых участвуют несколько экспертов (Рисунок 4.2).

Кнопка «Сохранить результаты в HTML-файл» предназначена для сохранения результатов выбранных методов в HTML-документ, который затем используется для показа рейтинга на сайте.

Рисунок 4.13. Окно просмотра результатов

Сообщения оператору


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

Методические указания к курсовой работе по курсу «базы данных»
Цель курсовой работы заключается в получении практических навыков разработки базы данных в архитектуре клиент-сервер для заданной.

Методические указания к курсовой работе по дисциплине «базы данных»
В ходе выполнения курсового проектирования студенты приобретают углубленные знания по вопросам проектирования баз данных, изучения.

Методические указания к курсовой работе по дисциплине «управлене данным и»
Методические указания предназначены для подготовки бакалавров по направлению подготовки «Информационные системы и технологии» включают.

Методические указания к курсовой работе по дисциплине «организационная культура»
Методические указания к курсовой работе по дисциплине «Организационная культура» / Самар гос техн ун-т; Сост. А. В. Быкова. Самара.

Методические указания к курсовой работе по дисциплине «Управленче­ские решения»
Настоящие методические указания к курсовой работе по дисциплине «Управленче­ские решения» предназначены для студентов заочного обучения.

Методические указания к курсовой работе по дисциплине «Управленче­ские решения»
Настоящие методические указания к курсовой работе по дисциплине «Управленче­ские решения» предназначены для студентов заочного обучения.

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

Методические указания к курсовой работе по дисциплине «Управление персоналом»
Методические указания предназначены для выполнения курсовой работы студентами специальности 080504 «Государственное и муниципальное.