надо. Информационных систем
 Скачать 0.73 Mb.
|
|
8. РАБОЧАЯ ДОКУМЕНТАЦИЯ В состав рабочей, или иначе эксплуатационной, документации входят руководство пользователя, руководство оператора, руководство администратора, руководство системного администратора, руководство программиста, руководство системного программиста. 8.1. Руководство пользователя Основной целью руководства пользователя является обеспечение пользователя необходимой информацией для самостоятельной работы с программой или автоматизированной системой. Поэтому руководство пользователя должно отвечать на вопросы: что это за программа (система)? что может программа (система)? что необходимо для обеспечения корректного функционирования программы (системы)? что делать в случае отказа системы? При составлении наиболее подробного руководства пользователя можно придерживаться следующей структуры: 1. Введение Данный раздел должен предоставлять пользователю общую информацию о программе (системе). В нем указывают: область применения; краткое описание возможностей; уровень подготовки пользователя. 51 2. Перечень эксплуатационной документации В данном разделе перечисляется документация, которая позволит пользователю избежать определенного рода ошибок. 3. Назначение и условия применения Раздел подразделяет основную задачу программы (системы) на подзадачи и описывает каждую из них. В нем указывают: виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации; условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.). 4. Подготовка к работе Данный раздел должен содержать пошаговую инструкцию для запуска программы (системы). К этапу подготовки системы к работе можно отнести установку дополнительных приложений, идентификацию, аутентификацию. В данном разделе указывают: состав и содержание дистрибутивного носителя данных; порядок загрузки данных и программ. 5. Проверка работоспособности В разделе описываются показатели, по которым можно определить, что программное обеспечение работает нестабильно. 6. Описание операций Это основной раздел, который содержит пошаговую инструкцию для выполнения того или иного действия пользователем. Если работа 52 автоматизированной системы затрагивает целый бизнес-процесс, то в руководстве пользователя перед описанием операций целесообразно предоставить информацию о данном процессе, его назначении и участниках. Подобное решение позволяет человеку четко представить свою роль в данном процессе и те функции, которые реализованы для него в системе. Далее в руководстве пользователя следует представить описание функций, разбитых на отдельные операции. Необходимо выделить подразделы, описывающие функции данного процесса, и действия, которые необходимо совершить для их выполнения: описание всех выполняемых функций, задач, комплексов задач, процедур; описание операций технологического процесса обработки данных, необходимых для выполнения функций, задач, процедур. 7. Аварийные ситуации В разделе описываются действия в случае длительных отказов технических средств, обнаружении несанкционированного вмешательства в данные, действия по восстановлению программ или данных. 8.2. Руководство оператора Нормативной базой для составления данного документа может являться ГОСТ 19.505-79 «ЕСПД. Руководство оператора. Требования к содержанию и оформлению», в котором выделяются следующие разделы: назначение программы (сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации); 53 условия выполнения программы (минимальный и/или максимальный состав аппаратурных и программных средств и т. д.); выполнение программы (последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды); сообщения оператору (тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора в случае сбоя, возможности повторного запуска программы и т. п.). В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками. В общем случае руководство оператора отличается от руководства пользователя. В руководстве оператора все процессы, выполняемые программным обеспечением, рассматриваются с технической точки зрения. Исходя из этого, можно представить альтернативную структуру данного руководства: 1. Установка на сервер В разделе описывается процесс установки программного обеспечения на сервер. Пошаговая инструкция дает точные указания, каким образом необходимо выполнить установку, в зависимости от технического состояния сервера. 54 2. Установка локальная В разделе описывается процесс настройки компьютеров, использующих программное приложение, также даются рекомендации по оптимизации настройки рабочих станций, чтобы улучшить процесс взаимодействия сервера и компьютеров пользователей. 3. Администрирование пользователей В разделе подробно описывается процесс администрирования учетных записей пользователей программного обеспечения. Подробная инструкция описывает все ситуации, которые могут возникнуть при управлении пользователями. Например, можно централизованно завершать все активные соединения с информационной базой и устанавливать блокировку новых соединений на определенный период времени. Такая возможность полезна при выполнении различных административных действий с информационной базой. 4. Информационная база В разделе рассматриваются вопросы администрирования, сохранения, переноса базы данных. Описаны рекомендации по настройке базы данных. Например, рассматривается ситуация резервного копирования. Резервное копирование может выполняться как в автоматическом режиме, так и в ручном. Для автоматического режима предварительно необходимо выполнить настройки. В любой момент можно восстановить данные информационной базы из созданной ранее резервной копии. 5. Технические неполадки Этот раздел содержит информацию о возможных технических проблемах, которые могут возникнуть в процессе эксплуатации программного обеспечения. Рассматриваются проблемы, возникающие в результате некорректной работы оборудования, а 55 также ситуации, возникающие в результате некорректного использования функций программного обеспечения. 6. Программный код В разделе подробно описывается структура программного кода. Если в процессе использования программного обеспечения возникают ошибки или потребуется доработка, то для этого необходимо знать программный код. Указываются особенности программного кода, создающие затруднения в процессе доработки. Раздел является очень важным, так как может потребоваться добавить, удалить или изменить определенные функции программного обеспечения. 8.3. Руководство администратора Обычно администратор считается пользователем системы, при этом он наделен как особыми обязанностями, так и необходимыми для их выполнения привилегиями. По методике и стилю изложения руководство администратора похоже на руководство пользователя. При этом, как правило, описание в нем строится от задач, а не от функций. Работа администратора многопользовательской системы, как правило, заключается в управлении учетными записями других пользователей, предоставлении им полномочий на доступ к данным и выполнение операций, а также в исправлении сделанных ими ошибок. Например, бывают автоматизированные системы, в которых вводить и редактировать данные может любой пользователь, а удалять – только администратор. Кроме того, администратор может заниматься ведением нормативно-справочной информации, загрузкой и выгрузкой данных, открытием и закрытием расчетных периодов и т. п. С этой точки зрения руководство администратора является системным документом и приобретает смысл только в условиях конкретной системы с живыми пользователями. 56 Системы часто создаются на основе тиражируемых программных продуктов или аппаратно-программных комплексов. В составе таких решений нередко поставляется программный компонент под названием «Администратор», предназначенный для управления системой после ее развертывания. Структура руководства администратора существенным образом зависит от того, как устроена система, и какого обслуживания она требует. Типичная структура руководства администратора системы следующая: 1. Назначение системы 2. Принципы функционирования системы 3. Обязанности и задачи администратора 4. Обслуживание системы настройка параметров работы системы; ведение нормативно-справочной информации; учетные записи пользователей и управление ими; назначение пользователям прав доступа; загрузка и выгрузка данных. 5. Проблемы в работе системы и способы их решения Руководство по административному модулю программного или программно-аппаратного комплекса содержит примерно те же сведения, но в более общем виде. Например, в нем должно быть объяснено, как создать учетную запись пользователя, но не может быть указано, когда это следует делать. Такая конкретика возникает только при внедрении продукта в некотором конкретном месте и отражается в технологических инструкциях или регламентах. 57 Структура руководства по административному модулю программного или аппаратно-программного комплекса может иметь следующий вид: 1. Общие сведения о комплексе 2. Функционирование комплекса в рамках системы (рассматриваются несколько наиболее типичных случаев применения комплекса и перечисляются основные обязанности администратора в каждом из них) 3. Интерфейс пользователя административного модуля 4. Задачи по обслуживанию настройка параметров работы системы; ведение нормативно-справочной информации; учетные записи пользователей и управление ими; назначение пользователям прав доступа; загрузка и выгрузка данных. 5. Типичные проблемы в работе и способы их решения Руководство администратора не следует путать с руководством системного администратора. Первый документ говорит о том, как организовать и поддерживать целевое применение системы, второй – как обеспечить ее техническую работоспособность. 8.4. Руководство системного администратора Руководство системного администратора – вспомогательный документ для прикладных программных продуктов и основной для серверных и системных, не имеющих непосредственных пользователей. В случае небольших «монолитных» программ руководство системного администратора может оказаться документом небольшим 58 по объему и простым по структуре. Руководство системного администратора на программный или аппаратно-программный комплекс, как правило, ощутимо сложнее, поскольку в нем приходится описывать каждый компонент по отдельности и способы их интеграции как друг с другом, так и со сторонним программным обеспечением: серверами баз данных, почтовыми серверами, антивирусами, средствами шифрования и пр. В руководстве системного администратора должны быть изложены: назначение и область применения программы (или комплекса); состав программы, основные принципы ее функционирования; комплект поставки (если он не указан в отдельном документе); системные требования для программы или ее компонентов; предпочтительная очередность установки компонентов; процедура установки программы или каждого ее компонента; порядок обязательной первоначальной настройки программы; способы интеграции установленных копий компонентов между собой; интеграция программы со сторонним ПО, например, с сервером базы данных; способы и периодичность контроля правильности работы программы; порядок текущего обслуживания работающих копий программы; 59 порядок решения всевозможных вспомогательных задач; аварийные ситуации и способы их устранения. Кроме того, в руководстве системного администратора могут быть описаны: пользовательский интерфейс административной консоли; утилиты командной строки и синтаксис их запуска; конфигурационные файлы и правила их написания; язык для составления управляющих скриптов. Все зависит от того, какие средства для установки и настройки программы реализовали ее разработчики, какие именно инструменты есть у системного администратора. Методика изложения материала в руководстве системного администратора сильно зависит от того, каким образом программой можно управлять. Если большинство задач решается через административную консоль с графическим интерфейсом, то документ будет больше похож на руководство пользователя или руководство администратора. Если системному администратору придется составлять конфигурационные файлы и писать скрипты, документ будет ближе к руководству программиста. Приблизительная структура руководства системного администратора следующая: 1. Общие сведения о программе (комплексе) 2. Архитектура и принципы функционирования 3. Системные требования 4. Установка программы (комплекса) 5. Административная консоль и работа с ней 60 6. Файл конфигурации. Составление и правка 7. Обязательная начальная настройка программы (комплекса) 8. Проверка правильности функционирования программы (комплекса) 9. Мероприятия по текущему обслуживанию программы (комплекса) 10. Оптимизация работы программы (комплекса) 11. Аварийные ситуации и способы их устранения Объем и особенности изложения информации в руководстве системного администратора зависят от используемых технических средств (ПК, серверных комплексов, планшетов, периферийных устройств и т. д.), применяемого программного обеспечения и решаемых с его помощью конкретных задач. 8.5. Руководство программиста Программист – это специалист, который занимается разработкой алгоритмов и компьютерных программ на основе специальных математических моделей. Прикладные программисты занимаются в основном разработкой программного обеспечения прикладного характера, а также в их обязанности входит адаптация уже существующих программ под нужды отдельно взятой организации или пользователя. Нормативной базой для составления данного документа может являться ГОСТ 19.504-79 «ЕСПД. Руководство программиста. Требования к содержанию и оформлению», в котором выделяются следующие разделы: 61 назначение и условия применения программы (назначение и функции, выполняемые программой, объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т. п.); характеристики программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т. п.); обращение к программе (описание процедур вызова программы, способы передачи управления и параметров данных и др.); входные и выходные данные (описание организации используемой входной и выходной информации и, при необходимости, ее кодирования); сообщения (тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям). В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые. В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.). 8.6. Руководство системного программиста Системный программист – это разработчик операционных систем, программных комплексов, обеспечивающих слаженную работу компонентов компьютера, который практически не занимается прикладными программами. Системный программист выстраивает многоуровневую структуру, которая объединяет отдельные компоненты (работу процессора, сетевого оборудования, 62 оперативную память, выполнение прикладных программ и пр.) в модули, а модули – в компьютерную сеть. Нормативной базой для составления данного документа может являться ГОСТ 19.503-79 «ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению», в котором выделяются следующие разделы: общие сведения о программе (назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы); структура программы (сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами); настройка программы (описание действий по настройке программы на состав технических средств, выбор функций и др.); проверка программы (описание способов проверки, позволяющих дать общее заключение о работоспособности программы: контрольные примеры, методы прогона, результаты); дополнительные возможности (описание дополнительных разделов функциональных возможностей программы и способов их выбора); сообщения системному программисту (тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям). 63 В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые. В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.). Вопросы для самоконтроля: 1. Для чего необходимо руководство пользователя? 2. Чем руководство оператора отличается от руководства пользователя? 3. Что включает в себя руководство программиста? |