Техническая документация. Назначение руководства программиста Сообщения об ошибке руководство программиста
Ниже представлен пример (образец) документа "Руководство пользователя ", разработанного на основании методических указаний РД 50-34.698-90 .
Данный документ формируется IT-специалистом, или функциональным специалистом, или техническим писателем в ходе разработки рабочей документации на систему и её части на стадии «Рабочая документация».
Для формирования руководства пользователя в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической системы «Корпоративное хранилище данных».
Ниже приведен состав руководства пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к содержанию и текст примера заполнения (выделен вертикальной чертой).
Разделы руководства пользователя:
1. Введение
В разделе "Введение" указывают:
- область применения;
- краткое описание возможностей;
- уровень подготовки пользователя;
- перечень эксплуатационной документации, с которой необходимо ознакомиться пользователю.
1.1. Область применения
Требования настоящего документа применяются при:
- предварительных комплексных испытаниях;
- опытной эксплуатации;
- приемочных испытаниях;
- промышленной эксплуатации.
1.2. Краткое описание возможностей
Информационно-аналитическая система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации технологии принятия тактических и стратегических управленческих решений конечными бизнес-пользователями на основе информации о всех аспектах финансово-хозяйственной деятельности Компании.
ИАС КХД предоставляет возможность работы с регламентированной и нерегламентированной отчетностью.
При работе с отчетностью используется инструмент пользователя Oracle Discoverer Plus, который предоставляет следующие возможности:
- формирование табличных и кросс-табличных отчетов;
- построение различных диаграмм;
- экспорт и импорт результатов анализа;
- печать результатов анализа;
- распространение результатов анализа.
1.3. Уровень подготовки пользователя
Пользователь ИАС КХД должен иметь опыт работы с ОС MS Windows (95/98/NT/2000/XP), навык работы с ПО Internet Explorer, Oracle Discoverer, а также обладать следующими знаниями:
- знать соответствующую предметную область;
- знать основы многомерного анализа;
- понимать многомерную модель соответствующей предметной области;
- знать и иметь навыки работы с аналитическими приложениями.
Квалификация пользователя должна позволять:
- формировать отчеты в Oracle Discoverer Plus;
- осуществлять анализ данных.
1.4. Перечень эксплуатационной документации, с которой необходимо ознакомиться пользователю
- Информационно-аналитическая система «Корпоративное хранилище данных». ПАСПОРТ;
- Информационно-аналитическая система «Корпоративное хранилище данных». ОБЩЕЕ ОПИСАНИЕ СИСТЕМЫ.
2. Назначение и условия применения Oracle Discoverer Plus
В разделе "Назначение и условия применения" указывают:
- виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;
- условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).
Oracle Discoverer Plus в составе ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по показателям деятельности, а также для углубленного исследования данных на основе корпоративной информации хранилища данных.
Работа с Oracle Discoverer Plus в составе ИАС КХД возможна всегда, когда есть необходимость в получении информации для анализа, контроля, мониторинга и принятия решений на ее основе.
Работа с Oracle Discoverer Plus в составе ИАС КХД доступна всем пользователям с установленными правами доступа.
3. Подготовка к работе
В разделе "Подготовка к работе" указывают:
- состав и содержание дистрибутивного носителя данных;
- порядок загрузки данных и программ;
- порядок проверки работоспособности.
3.1. Состав и содержание дистрибутивного носителя данных
Для работы с ИАС КХД необходимо следующее программное обеспечение:
- Internet Explorer (входит в состав операционной системы Windows);
- Oracle JInitiator устанавливается автоматически при первом обращении пользователя к ИАС КХД.
3.2. Порядок загрузки данных и программ
Перед началом работы с ИАС КХД на рабочем месте пользователя необходимо выполнить следующие действия:
- Необходимо зайти на сайт ИАС КХД ias-dwh.ru.
- Во время загрузки в появившемся окне "Предупреждение о безопасности", которое будет содержать следующее: "Хотите установить и выполнить "Oracle JInitiator" ..." Нажимаем на кнопку "Да".
- После чего запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next и затем OK.
3.3. Порядок проверки работоспособности
Для проверки доступности ИАС КХД с рабочего места пользователя необходимо выполнить следующие действия:
- Открыть Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer» на рабочем столе или вызвать из меню «Пуск».
- Ввести в адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».
- В форме аутентификации ввести пользовательский логин и пароль. Нажать кнопку «Далее».
- Убедиться, что в окне открылось приложение Oracle Discoverer Plus.
В случае если приложение Oracle Discoverer Plus не запускается, то следует обратиться в службу поддержки.
4. Описание операций
В разделе "Описание операций" указывают:
- описание всех выполняемых функций, задач, комплексов задач, процедур;
- описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур.
Для каждой операции обработки данных указывают:
- наименование;
- условия, при соблюдении которых возможно выполнение операции;
- подготовительные действия;
- основные действия в требуемой последовательности;
- заключительные действия;
- ресурсы, расходуемые на операцию.
4.1. Выполняемые функции и задачи
Oracle Discoverer Plus в составе ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:
4.2. Описание операций технологического процесса обработки данных, необходимых для выполнения задач
Ниже приведено описание пользовательских операций для выполнения каждой из задач.
Задача: «Визуализация отчетности»
Операция 1: Регистрация на портале ИАС КХД
- Компьютер пользователя подключен к корпоративной сети.
- Портал ИАС КХД доступен.
- ИАС КХД функционирует в штатном режиме.
Подготовительные действия:
На компьютере пользователя необходимо выполнить дополнительные настройки, приведенные в п. 3.2 настоящего документа.
- На иконке «ИАС КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки.
- В открывшемся окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя. Нажать кнопку «Далее».
Заключительные действия:
Не требуются.
15-30 секунд.
Операция 2: Выбор отчета
Условия, при соблюдении которых возможно выполнение операции:
Успешная регистрация на Портале ИАС КХД.
Подготовительные действия:
Не требуются.
Основные действия в требуемой последовательности:
1. В появившемся окне «Мастер создания рабочих книг» поставить точку напротив пункта «Открыть существующую рабочую книгу».
2. Выбрать нужную рабочую книгу и нажать кнопку «Откр.»:
Заключительные действия:
После завершения работы с отчетом необходимо выбрать пункт меню «Файл», далее выбрать пункт «Закрыть».
Ресурсы, расходуемые на операцию:
15 секунд.
Задача: «Формирование табличных и графических форм отчетности»
Заполняется по аналогии.
5. Аварийные ситуации
В разделе "Аварийные ситуации" указывают: 1. действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств; 2. действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях обнаружении несанкционированного вмешательства в данные; 4. действия в других аварийных ситуациях.
В случае возникновения ошибок при работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к ответственному Администратору ИАС КХД.
| Класс ошибки | Ошибка | Описание ошибки | Требуемые действия пользователя при возникновении ошибки |
|---|---|---|---|
| Портал ИАС КХД | Сервер не найден. Невозможно отобразить страницу | Возможны проблемы с сетью или с доступом к порталу ИАС КХД. | Для устранения проблем с сетью обратиться к сотруднику подразделения технической поддержки (HelpDesk). В других случаях к администратору ИАС КХД. |
| Ошибка: Требуется ввести действительное имя пользователя | При регистрации на портале ИАС КХД не введено имя пользователя. | Ввести имя пользователя. | |
| Ошибка: Требуется ввести пароль для регистрации | При регистрации на портале ИАС КХД не введен пароль. | Ввести пароль. | |
| Ошибка: Сбой аутентификации. Повторите попытку | Неверно введено имя пользователя или пароль, либо такая учетная запись не зарегистрирована. | Нужно повторить ввод имени пользователя и пароля, однако после третей неудачной попытки регистрации учетная запись блокируется. Если учетная запись заблокирована, нужно обратиться к администратору ИАС КХД. | |
| Сбой в электропитании рабочей станции | Нет электропитания рабочей станции или произошел сбой в электропитании. | Рабочая станция выключилась или перезагрузилась. | - нажать кнопку «Пуск» - выбрать пункт «Выполнить» Повторить попытку подключения (входа) в ИАС КХД |
| Сбой локальной сети | Нет сетевого взаимодействия между рабочей станцией и сервером приложений ИАС КХД | Отсутствует возможность начала (продолжения) работы с ИАС КХД. Нет сетевого подключения к серверу ИАС КХД |
Перезагрузить рабочую станцию. Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды: - нажать кнопку «Пуск» - выбрать пункт «Выполнить» - в строке ввода набрать команду telnet ias_dwh.ru 80 - если открылось окно Telnet, значит соединение возможно. После восстановления работы локальной сети повторить попытку подключения (входа) в ИАС КХД. |
Ковтун М.В. Январь 2012.
Программно-технические средства
блокировок и защит по уровню воды
Руководство программиста
Структура программы контроллера
АННОТАЦИЯ
В настоящем документе приводится описание назначения, условий применения и характеристик прикладного программного обеспечения (ППО) программируемого логического контроллера (ПЛК). Прикладное программное обеспечение промышленного компьютера (ПК) описано в документе «Руководство оператора». Ссылки на программное обеспечение ПК приведены в настоящем документе по мере необходимости.
СОДЕРЖАНИЕ
1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ
1.1.Назначение ППО ПЛК
1.2.Условия применения ППО ПЛК
2. ХАРАКТЕРИСТИКА ПРОГРАММЫ
2.1. Структура ППО ПЛК
2.3. Пользовательские функциональные блоки, применяемые в ППО «Unity»
3. ОБРАЩЕНИЕ К ПРОГРАММЕ
4. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ
5. СООБЩЕНИЯ
1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ
ПТС блокировок и защит по уровню воды в парогенераторах энергоблоков №1,2 Электростанции предназначена для защиты трубной системы парогенераторов при снижении уровня воды, а также защиты системы от заброса питательной воды в проточную часть турбины при повышенном уровне в парогенераторе.
Защита технологического процесса обеспечивается комплексом технологического оборудования:
Арматура на основной линии питающей воды (ВП-9);
Арматура на основной линии питающей воды (ВП-10);
Арматура на линии продувки (У5-01);
Арматура на линии продувки (У5-02);
Арматура на байпасной линии питающей воды (ВП11);
Команды включения аварийного повысительного электронасоса (АПЭН-1);
Команды включения аварийного повысительного электронасоса (АПЭН-2);
Команда отключения турбогенератора (ТГ3);
Команда отключения турбогенератора (ТГ4);
Выдача технологической сигнализации по понижению уровня в 4-х из 6-ти ПГ
Выдача технологической сигнализации срабатывания защиты по +300мм
Команда отключения регулятора питания на линии продувки +75мм
Команда отключения регулятора питания на линии продувки 500 тонн
Выдача технологической сигнализации по +125мм
Выдача технологической сигнализации по +75мм
Выдача технологической сигнализации по ±50мм
Выдача технологической сигнализации по -120мм
Выдача технологической сигнализации по 500т/час
Функционирование системы обеспечивается прикладным программным обеспечением (ППО).
ППО включает прикладное программное обеспечение промышленного компьютера (ППО ПК) и прикладное программное обеспечение программируемого контроллера (ППО ПЛК).
1.1. Назначение ППО ПЛК
ППО ПЛК в составе ПТС реализует следующие функции:
– резервирование контроллеров;
– получение и обработка сигналов ввода-вывода с трех идентичных корзин ввода-вывода;
– Принимает и фильтрует входные дискретные сигналы от вероятного «дребезга» контактов.
– Принимает и обрабатывает входные аналоговые сигналы:
обеспечивает контроль выхода сигнала за допустимые границы (недостоверность сигнала);
производит масштабирование аналогового сигнала;
осуществляет гистерезис пороговых значений;
анализирует состояния трех сигналов из состава корзин и выборка достоверных значений;
осуществляет фильтрацию сигнала по скорости нарастания или убывания величины сигнала.
– Выдача дискретных сигналов на оборудование (срабатывание защит);
– Контроль отклонений параметров от заданий и достижения уставленных значений;
– Выдача исполнительных воздействий на лампы технологической сигнализации на БЩУ;
– Реализация алгоритмов защит и блокировок;
– Обмен данными со смежными системами по каналу Modbus/TCP/IP;
– Проверка модулей контроллера на наличие ошибок, и формирование сообщений для АРМ о состоянии оборудования контроллера, а также на панель БЩУ;
– Мониторинг аварийных ситуаций оборудования системы;
– ППО ПЛК обеспечивает возможность приема от промышленного компьютера, а также с панели БЩУ ключей отключающих определенные защиты и блокировки системы.
1.2. Условия применения ППО ПЛК
Общая архитектура системы приведена на рисунке 1.
Рисунок 1. Общая архитектура ППО
Комплекс ПТС включает следующие аппаратные и покупные программные компоненты:
1) Два программируемых логических контроллера (ПЛК) QUANTUM на базе процессора P266 CPU, работающих в режиме горячего резерва. Исполнительная среда Unity Pro 4.1 XL.
2) Промышленный компьютер, состоящий из:
– персональная ЭВМ (встраиваемый промышленный компьютер);
– операционная система Windows XP Pro SP3;
– пакет визуализации СITECT 7
ПЛК осуществляют взаимодействие с внешними подсистемами по сети Ethernet (со стороны ПЛК) и по каналам ввода-вывода.
Взаимодействие ПЛК и промышленного компьютера осуществляется по сети Ethernet.
ПТС включает прикладные программные компоненты, разрабатываемые в соответствии с настоящим проектом:
Приложение Unity Pro, установленное на ПЛК.
Приложение Citect, установленное на ПК.
2. ХАРАКТЕРИСТИКА ПРОГРАММЫ
2.1. Структура ППО ПЛК
Прикладное программное обеспечение ПЛК реализуется в виде приложения (см Рисунок 1), написанного в среде Unity v.4.1. Название приложения – upg.stu.
Приложение upg.stu обеспечивает реализацию функциональности системы, реализуемой на ПЛК для всех режимов работы.
Приложение содержит:
конфигурацию аппаратных и программных средств;
набор функциональных модулей, каждый из которых реализуется секциями, написанными на языке LD (лестничных диаграмм);
набор функциональных блоков, разработанных в рамках проекта;
базу данных;
анимационные таблицы.
В состав приложения входят следующие функциональные модули, каждый из которых содержит один или несколько программных модулей, отраженных в таблице 1.
Таблица 1
Init Секция выполняется при первом цикле после запуска и обеспечивает присвоение начальных значений всем параметрам.
AI_to_AM Секция обработки входных аналоговых сигналов. Осуществляется вызов блока соответствующего сигнала для присвоения значения внутренней переменной и проверки достоверности канала.
DI_to_DM Секция обработки входных дискретных переменных. Производится вызов функционального блока соответствующего сигнала для присвоения значения внутренней переменной и проверки достоверности канала.
Comparing Секция сравнения получаемых значений с трех различных корзин распределённого ввода-вывода. Сигналы сравниваются по логике 2 из 3-х. Если два сигнала идентичны, а третий различен, то последний признается недействительным.
Наименование секции Функциональность
Alarms Секция обработки дискретных и аналоговых сигналов для определения достижений предельных значений. Выработка сигнализаций и команд на исполнение блокировок и защит.
INTERLOCK Секция формирования алгоритма блокировок и защит. В данной секции происходит запись в переменные, связанные с исполнительными механизмами.
SIM Секция управления режимами имитации и опробования контроллера.
DIAGNOSTIC Секция формирования диагностической информации контроллера.
Внутри секций используются следующие подпрограммы:
Таблица 2
Наименование секции Функциональность
CompAI Функциональный блок, предназначенный для сравнения трех разных аналоговых величин, выдачи на выход результирующего значения, а также диагностической информации по каждому из каналов.
CompDI Функциональный блок, предназначенный для сравнения трех дискретных сигналов приходящих с трех разных корзин, выдачи на выход результирующего значения, а также диагностической информации по каждому из каналов.
BlockF Функциональный блок, предназначенный для фиксирования недопустимо быстрого падения или прироста аналоговой величины. В случае обрыва или короткого замыкания данный ФБ выведет данный сигнал из обработки, что не позволит остановить технологический процесс.
GetDI Функциональный блок, предназначенный для получения и обработки дискретных сигналов. Осуществляет фильтрацию «дребезга» контактов.
Наименование секции Функциональность
HLLA4 Функциональный блок, предназначенный для выработки четырех пороговых нарушений с одного аналогового сигнала (HH, H, L, LL). В ФБ учтены параметры гистерезиса и мертвой зоны по фиксации нарушений.
GetAI Функциональный блок, предназначенный для получения и обработки аналоговых сигналов. Осуществляет масштабирование значений, а также выполняет функции частичного сглаживания.
SIMPMEHA Функциональный блок, предназначенный для выдачи синусоидальной помехи. Данная помеха «подмешивается» к имитируемому сигналу для придания реалистичности при работе с такими режимами, как «опробование».
SIMPULSE Функциональный блок, предназначенный для выдачи в системе пульсов заданной длительности.
SIMPV Функциональный блок, предназначенный для имитации аналоговой величины при работе с такими режимами, как «опробование».
2.2. Структуры данных ППО ПЛК
Всего в каждом энергетическом блоке находится шесть парогенераторов и программные элементы ППО выполнены для каждого из них идентично.
В проекте программного обеспечения контроллеров используются следующие типы данных:
Слово состояния аналогового канала – тип word;
Слово состояния дискретного канала – тип word;
Слово определяющее значение аналогового канала – тип real (два слова word);
Слово состояния контроллера QUANTUM – тип word (всего зарезервировано два слова);
Слово состояния нарушений – тип word;
Слово состояния блокировок – тип word;
Слово состояния деблокировочных ключей – тип word;
Промышленный компьютер позволяет производить управляющие воздействия только на деблокировочные ключи, посредством изменения состояния битов через управляющее слово. ПЛК информирует о своем состоянии через слово состояния. Описание отдельных полей (разрядов) слов данных приведено в Руководстве программиста.
Переменные в ПЛК кодируются следующим образом:
AI – аналоговый вход в ПЛК;
AIM – внутренний аналоговый вход ПЛК /ПК;
DI – дискретный вход в ПЛК;
DM – внутренний дискретный вход ПЛК /ПК;
2.3. Пользовательские функциональные блоки, применяемые в ППО «Unity»
2.3.1 Функциональный блок сравнения аналоговых каналов CompAI
.
Рисунок 2. Функциональный блок сравнения аналоговых каналов CompAI
Данный ФБ служит для сравнения трех различных аналоговых значений. Если один из аналоговых параметров выходит за пределы среднего значения двух других, то его значение не учитывается и в свойство данного канала пишется сообщение об ошибке. Если исправны все три канала (находятся в приемлемом допуске рассогласования), то результирующим будет большее из существующих значений.
2.3.2 Функциональный блок сравнения аналоговых каналов CompDI
Рисунок 3. Функциональный блок сравнения дискретных каналов CompDI
Данный ФБ служит для сравнения трех пар дискретных сигналов. Если в паре сигналов два значения будут одинаковыми, то это будет означать обрыв или короткое замыкание. В данном случае данная пара не учитывается и выводится из обращения. В систему выдается сообщение о характере вызвавшего нарушения. Если суммарное значение в трех разных парах различается, то алгоритм блока выводит из обращения те, которые не соответствуют предыдущим двум.
2.3.3 Функциональный блок вычисления скорости спада аналоговой величины BlockF
Рисунок 4. Функциональный блок вычисления скорости спада аналоговой величины BlockF
Данный ФБ служит для вычисления скорости нарастания и спада значения на аналоговых каналах. В случае, если произойдет обрыв провода на аналоговом датчике или резкое падение физического значения, то параметр, считываемый с этого датчика, начнет резко падать. Данный ФБ предназначен для фиксации событий о КЗ или обрыве и записи в слово состояния канала признака ошибки. То есть при возникновении обрыва или короткого замыкания данный канал будет выводиться из обращения.
2.3.4 Функциональный блок масштабирования аналогового канала GetAI
Рисунок 5. Функциональный блок масштабирования аналогового канала GetAI
Данный ФБ служит для перевода программных единиц контроллера (INT) в величины реальных единиц технологического процесса (REAL). В случае выхода параметра за границы допустимой погрешности (OFFSET) ошибка на канале не выдается и параметр останавливается на максимальном или минимальном значении. В случае если параметр выделяется сильнее нормированной погрешности, то выдается ошибка на канале с расшифровкой характера нарушения.
2.3.5 Функциональный блок обработки дискретного канала GetDI
Рисунок 6. Функциональный блок обработки дискретного канала GetDI
Данный ФБ служит для фильтрации «дребезга» на дискретном канале. В случае потери связи с каналом на вход данного ФБ записывается заданное значение, вследствие чего на выходе функционального блока в результирующий выход будет записана величина, заданная по умолчанию.
2.3.6 Функциональный блок выработки пороговых нарушений HLLA4
Рисунок 7. Функциональный блок выработки пороговых нарушений HLLA4
Данный ФБ служит для реализации четырех пороговых нарушений, которые можно использовать как для выдачи системных нарушений, так и для реализации их в алгоритмах реализации блокировок и защит. Для того, чтобы нарушение не пропадало сразу при возврате район установленного значения, предусмотрена функция гистерезиса, влияющие на характер выдачи сигналов о нарушении.
2.3.7 Функциональный блок выработки синусоидальной помехи SIMPMEHA
Рисунок 8. Функциональный блок выработки синусоидальной помехи SIMPMEHA
Данный ФБ служит для реализации режимов контроллера, связанных с отладкой и имитацией работы установки. Данный сигнал на диаграмме выглядит как синусоидальная кривая, с диапазоном разброса заданного пределами (входные переменные). Эта помеха предназначена для «подмешивания» к величине аналогового сигнала и для придания ему динамических свойств и визуальной реалистичности.
2.3.8 Функциональный блок выработки импульсов заданной длины SIMPULSE
Рисунок 9. Функциональный блок выработки импульсов заданной длины SIMPULSE
Данный ФБ служит для реализации режимов контроллера, связанных с отладкой и имитацией работы установки. Данный сигнал на диаграмме выглядит как меандр, с разными диапазонами вершин и впадин. Временные значения вершин меандра задаются временными пределами (входные переменные).
2.3.9 Функциональный блок генерации аналоговой переменной SIMPV
Рисунок 10. Функциональный блок генерации аналоговой переменной SIMPV
Данный ФБ служит для генерации аналоговых сигналов для режимов имитации работы устройств и отладки контроллера.
3. ОБРАЩЕНИЕ К ПРОГРАММЕ
Программа при работе на объекте сконфигурирована на автоматический запуск при включении контроллера. Состояние программы отображается на дисплее контроллера. Настройка параметров программы может осуществляться с переносного компьютера, входящего в поставку системы.
4. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ
Входными данными системы является информация, поступающая от объекта управления в ПТС через устройства связи с объектом (распределенной периферии), а также команды, вводимые оператором с ПК.
Выходными данными системы является информация, передаваемая на объект управления из ПТС через устройство связи с объектом. Информация выводится в ПК в виде экранных форм и поступает в виде сигнализации на панель БЩУ.
5. СООБЩЕНИЯ
Сообщения, передаваемые по интерфейсу ПЛК-ПК, описаны в документе «Руководство программиста. Часть 2. Интерфейс ПЛК-ПК». Сообщения, выдаваемые оператору, описаны в документе «Руководство оператора».
#Руководство, #программиста, #описание, #ПЛК, #ПТС, #интерфейс, #аналоговых, #контроллер
Создан 02.02.2010 9:34:31
Назначение и условия применения программ
В разделе «Назначение и условия применения программ» должны быть указаны назначение и, условия, необходимые для выполнения программы (объем, к составу и параметрам, требования к и т.п.) [из п. 2.1 ГОСТ 19.504-79]
Характеристика программы
В разделе «Характеристика программы» должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля выполнения и самовосстанавливаемости программы и т.п.) [из п. 2.2 ГОСТ 19.504-79]
Обращение к программе
В разделе «Обращение к программе» должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.) [из п. 2.3 ГОСТ 19.504-79]
Входные и выходные данные
В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее [из п. 2.4 ГОСТ 19.504-79]
Сообщения
В разделе «Сообщения» должны быть указаны тексты сообщений, выдаваемых программисту или в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям [из п. 2.5 ГОСТ 19.504-79]
Приложения
В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.) [из п. 2.6 ГОСТ 19.504-79]
Руководство пользователя составляют на основании ГОСТ 19.504-79. Руководство программиста разрабатывают в трех случаях:
– программный продукт по своему основному назначению является средой разработки или библиотекой (как Delphi или Qt);
– комплекс или программный продукт служит платформой для разработки программ или систем определенного типа (как 1С или Axapta);
– программа распространяется вместе с исходным кодом или постоянно модифицируется самими разработчиками.
Очевидная задача руководства программиста - снабдить разработчика информацией, которой ему будет достаточно для создания на базе разработанного программного продукта собственных программ или систем.
Руководство программиста должно объяснять:
– С какими объектами программист имеет дело, где они находятся, сколько времени существуют и как они взаимодействуют между собой. Какие из них он создает сам, а какие предоставлены ему изначально средой, фреймворком, библиотекой.
– Какие еще средства разработки (кроме разработанного программного продукта) необходимы для того, чтобы создать приложение или систему. Например, если разработанный программный продукт - библиотека, программисту потребуются компилятор, какая-то среда разработки и прочий инструментарий.
– В какой среде функционирует приложение или система. Какими будут его минимальные требования к системе. Понадобятся ли для его запуска какие-либо дополнительные программные средства: фреймворки, рантаймы, интерпретаторы.
– Что представляет собой минимальное работоспособное приложение или минимальная работоспособная система. Какие объекты и в какой последовательности необходимо создать, как соединить их друг с другом, чтобы приложение осуществило какой-то свой минимальный вывод.
– Как (по шагам) скомпилировать работоспособное приложение или развернуть работоспособную систему.
Кроме того руководство программиста должно содержать полные описания всех предусмотренных в программном продукте объектов. Если это функции, то должны быть приведены их синопсисы, если классы, то описания их интерфейсов и т. Д.
Если программный продукт предполагает использование оригинального языка программирования и снабжен собственным компилятором или интерпретатором, в руководство программиста необходимо включить его описание.
В тексте руководства обязательно должны быть соблюдены следующие правила:
– При вводе нового понятия следует опираться только на те понятия, которые были введены ранее или заведомо знакомы читателю.
– Ввод каждого понятия должен быть чем-то обоснован.
Основное требование при описании отдельных объектов - полнота описания каждого из них.
При описании объектов особое внимание следует уделять следующим аспектам:
– Что обязательно должно предшествовать созданию и использованию объекта.
– Каковы побочные эффекты обращения к объекту.
– Особенности интерпретации объектом передаваемых ему данных.
– Где «физически» (в каком файле, в какой библиотеке) находится объект.
– Желательно по каждому объекту привести примеры использования, небольшие фрагменты кода, демонстрирующие создание объекта (если перед использованием его необходимо создать), передачу объекту входных данных, получение выходных данных и их интерпретацию.
Возможно выполнение руководства программиста гипертекстовым.
Структура руководства программиста:
1. Назначение и условия применения программы.
2. Характеристика программы.
3. Обращение к программе.
4. Входные и выходные данные.
5. Сообщения.
Руководство программиста может комплектоваться различными схемами, например, схемами базы данных, диаграммами классов, графами вызова
В качестве примера представлено содержание руководства программиста Система e-port дилер. Клиент-серверный протокол.
Система «e-port дилер» предназначена для приема и проведения моментальных платежей при оплате услуг мобильной связи, доступа в Интернет и т. П. Центральный сервер системы принадлежит группе e-port, а пункт приема платежей может открыть любой желающий, установив у себя на компьютере (подключенном к Интернету) программу-клиент. Обмен данными между центральным сервером и программой-клиентом осуществляется по специальному протоколу. Протокол открытый, что позволяет различным организациям: банкам, розничным сетям, сетям платежных терминалов, осуществлять платежи непосредственно из собственных систем. Протокол разработан Группой e-port, а техническая документация «Философтом»по ее заказу.
ВВЕДЕНИЕ
Система e-port дилер: клиент-серверный протокол. Назначение и обзор возможностей
Задачи протокола
Основные преимущества использования протокола
1 Реализация протокола (шлюз)
1.1 Общие сведения
1.2 Структура приложения
2. Как работает шлюз
2.1 Регистрация и отчетность
2.1.1 Регистрация
2.1.2 Отчетность
2.2 Обмен данными с сервером
2.2.1 Структура пакета
2.2.2 Справочники
2.2.3 Порядок обмена пакетами
2.3 Цикл обработки операции
2.3.2 Очередь
2.3.3 Анализ ответа сервера
2.3.4 Нестандартные ситуации
3 Спецификация протокола
3.1 Структурные элементы пакета
3.2 Заголовок запроса
3.3 Заголовок ответа
3.4 Пополнение счета
3.5 Покупка PIN-кода
3.6 Прерывание процесса обработки операции
3.7 Транзакционные свойства операции
3.9 Справочник
3.11 Статус операции
3.11.1 Примеры сообщений о статусе операций
3.11.2 Коды состояния находящихся в обработке или завершенных операций
3.11 Уведомления системы
4 ГЛОССАРИЙ
ПРИЛОЖЕНИЯ
Приложение 1. DTD XML-запроса и комментарий
Если кроме использования и настройки, программное обеспечение предоставляет возможность написания, редактирования или использования программного кода. Какой документ необходим в этом случае?
Назначение руководства программиста
Руководство программиста относится к эксплуатационно-технической документации и требуется в тех случаях, когда система тем или иным образом предоставляет возможность написания, редактирования или использования программного кода.
Примерами могут служить:
– библиотека функций;
– платформа или среда для разработки ПО;
– ПО с открытым кодом.
Документ должен предоставлять всю необходимую информацию для того, чтобы разработчик мог воспользоваться возможностями системы. Для решения этой задачи содержание документа может включать в себя:
– назначение, структуру входных и выходных данных программных функций;
– возможности по созданию программного кода, особенности его интерпретации и компиляции;
– синтаксические особенности используемого языка программирования;
– возможные правила и ограничения при работе с программным кодом;
– различные инструкции по работе с программой.
Список возможных тем этим не ограничивается, все зависит от особенностей конкретной системы. Надо сказать, что руководство программиста бывает очень полезно и для разработчиков системы, являясь справочником по текущей реализации логики работы ПО.
Состав типового руководства программиста
В соответствии с требованиями ГОСТ руководство программиста должно содержать следующие разделы:
– Назначение и условия применения программы , где указывают область применения ПО и технические требования, необходимые для его работы.
– Характеристика программы , где описывают режим работы программы, показатели скорости ее работы и другие важные для использования характеристики.
– Обращение к программе , где указывают способы и параметры запуска программы;
– Входные и выходные данные , где описывают формат, способ организации и другие требования к входным и выходным данным;
– Сообщения , где приводят тексты сообщений, выдаваемых программой в различных ситуациях и действия, которые необходимо при этом предпринять.
Различные примеры, иллюстрации и таблицы целесообразно приводить в приложениях к документу.
Стандарты для руководства программиста
ГОСТы регламентируют и этот документ, в данном случае это ГОСТ 19.504. В соответствии с ним определяется структура и содержание Руководства программиста.
Стоимость разработки руководства программиста
Работа по созданию руководства программиста требует высокой квалификации специалиста и знаний в области программирования, однако, для профессиональных разработчиков такая работа обычно представляется скучной и нудной, к тому же, требует умения грамотно формулировать и доступно доносить материал. Специалисты ТехРайтКонсалт обладают большим опытом в обеих областях, что позволяет нам создавать документы по доступной цене и точно в срок!
