Написание руководства для администратора

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

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

Руководство администратора не имеет собственного стандарта оформления. Выполняется этот документ по РД 50-34.698-90, содержащему общие требования к содержанию документации на автоматизированные системы.

Руководство администраторов часто путают с руководствами системных программистов (администраторов). Это неверно, ведь цель данного документа – организация и поддержка целевого применения АСУ, а не обеспечение ее технической работоспособности.

Содержание и структура

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

Оформление

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

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

Оформите заявку и задавайте все интересующие вас вопросы по телефону
+7(499)755-74-33 e-mail Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра. или через форму заказа.

Примеры и рекомендации удобных инструкций

Снова здравствуй, уважаемый хабралюд!

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

Всем, кому интересно, прошу под хабракат.

KISS

Принцип Keep It Simple Stupid хорошо известен в программировании, но почему-то его редко используют для написания инструкций и руководящих документов, предпочитая растекаться мыслею по древу. В 70% ситуаций эта документация необходима только для того, что бы отмахаться от наших бодрых регуляторов, но при этом забывают, что с этой документацией придётся работать, причём не всегда технически подкованным и грамотным в области информационной безопасности людям.

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

1. Старайтесь разделять инструкцию для пользователей от инструкции для администраторов и офицеров безопасности. причём первые не должны содержать ссылок на вторые (они могут содержать отсылки друг к другу).
2. Делайте пошаговые инструкции, вида «взял и сделал». То есть инструкции должны описывать алгоритм действий того, на кого она направлена.
3. Каждый пункт описывайте, как отдельное действие с обязательным указанием ответственного и контактами, если они необходимы.
4. Для большей наглядности можете дополнительно нарисовать в инструкцию блок-схему действий. Это поможет пользователю наглядно понять и оценить действия, так же и вам доступно объяснить алгоритм при обучении.
5. Психологический момент — инструкция будет плохо выполняться и работать, если пользователям понятно и доступно не объяснят алгоритм на пальцах и примерах. Поэтому — НЕ ЗАБЫВАЙТЕ ПРО ОБУЧЕНИЕ!

Пример инструкции для пользователей

Ниже приведен пример инструкции по заведению аккаунта пользователя в корпоративной сети.

Clear screen/clear desk

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

Хорошим примером из лучших практик здесь является политики чистого стола и чистого экрана. Их можно описать так же, как я приводил пример ранее, но это будет выглядеть немного глупо, так как действия там простейшие. Лучше просто сделать набором правил:

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

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

Помимо использования, автоматизированную систему необходимо также устанавливать и настраивать. Каким образом решается этот вопрос (ГОСТ 34)?

Назначение руководства администратора

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

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

– выполняет определенные действия по настройке программы;

– управляет учетными записями пользователей;

– настраивает права доступа;

– исправляет ошибки в данных;

– обеспечивает информационную поддержку.

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

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

– Описание области применения и способа использования системы.

– Описание логики работы системы в виде основных правил и принципов ее работы.

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

– Подробное описание порядка и способа выполнения каждой из операций функции администратора.

– Описание вида и порядка действий по обслуживанию системы.

– Описание вероятных ошибок и неполадок в работе системы и способов их устранения.

Стандарты для руководства администратора

Содержание и оформление Руководства администратора как эксплуатационного документа также регулируется государственными стандартами, так что и здесь необходимо соблюдать их требования. Несмотря на то, что не существует отдельного ГОСТа на создание Руководства администратора, его структура и оформление регламентируется РД 50-34.698, где описаны общие требования к содержанию документации.

Заключение

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

– разработка руководства пользователя;
– создание руководства программиста;
– разработка руководства оператора.

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

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

При подготовке каждого руководства администратора учитывается:

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

 Мы будем рады внести свой вклад в совершенствование ваших разработок!

Практическая работа № 2 «Составление руководства системного администратора».

Тема занятия: Составление руководства системного администратора ПП.

Цель выполнения задания: научиться создавать и редактировать руководство системного администратора для ПП.

Оборудование (приборы, материалы, дидактическое обеспечение) Инструкционные карты, мультимедийные презентации, персональные компьютеры.

ОСНОВНЫЕ ТЕОРЕТИЧЕСКИЕ ПОЛОЖЕНИЯ

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

Общие сведения о программе.

1. Структура программы.

2. Настройка программы.

3. Проверка программы.

4. Дополнительные возможности.

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

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

1. Общие сведения о программе (комплексе).

2. Архитектура и принципы функционирования.

3. Системные требования.

4. Установка программы (комплекса).

5. Административная консоль и работа с ней.

6. Файл конфигурации. Составление и правка.

7. Обязательная начальная настройка программы (комплекса).

8. Проверка правильности функционирования программы (комплекса).

9. Мероприятия по текущему обслуживанию программы (комплекса).

10. Оптимизация работы программы (комплекса).

11. Аварийные ситуации и способы их устранения.

Особенности

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