Общие требования к программным документам




3.8.Требования к содержанию и оформлению формуляра

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

Текст основной части документа должен состоять из следующих разделов:

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

 

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

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

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

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

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

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

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

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

3.10.Руководство программиста

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

- Характеристики программы - описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и cамовосстанавливаемости программы и т.п.).

- Обращение к программе - описание процедур вызова программы (способы передачи управления и параметров данных и др.).

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

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

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


3.11.Руководство оператора

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

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

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

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

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


3.12. Типовая структура и содержание базовых комплектов эксплуатационных документов.

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

2.операторы, реализующие функционирование и применение ПС.

Документация администрирования при эксплуатации информационной системы должна обеспечивать поддержку первичной инсталляции, функционирование и восстановление программ и данных после сбоев.
К основным функциям системы администрирования относят:
1.консультация разработчиков программ и данных по особенностям применения ПС и СУБД.

2.планирование использования памяти и производительности вычислительной системы в рабочем режиме применения ПС.

3.инсталляция версии ПС для пользователя.

4.выявление и регистрация сбоев и дефектов функционирования программ и данных.

5.управление средствами защиты информации и санкционированным доступов пользователей, анализ попыток взлома системы защиты.

6.защита и восстановление информации БД при искажении.

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

1. наличие механизмов управления окнами

2. использование готовых графических символов (икон) для отображения управляемых объектов

3. непосредственное манипулирование графическими объектами и окнами посредством мыши

4. объектно и проблемно-ориентированное проектирование диалоговых систем.

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

1.соответствия между элементами интерфейса пользователя (экранными формами) и типовыми процедурами

2.последовательность допустимых операций и переходы между экранными формами

3.форма идентификации ошибочных действий или ситуаций

4.формы входных и выходных документов

 



Поделиться:




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

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


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