Руководство администратора
Руководство администратора – это составная часть эксплуатационной документации, которая разрабатывается на любую программу или автоматизированную систему. При помощи руководства администратора ответственные пользователи системы получают возможность управлять ее функционированием – выполнять определенные операции по обеспечению порядка работы АСУ, распределять права доступа к ней, редактировать данные и исправлять ошибки.
Руководство администратора не имеет собственного стандарта оформления. Выполняется этот документ по РД 50-34.698-90, содержащему общие требования к содержанию документации на автоматизированные системы.
Руководство администраторов часто путают с руководствами системных программистов (администраторов). Это неверно, ведь цель данного документа – организация и поддержка целевого применения АСУ, а не обеспечение ее технической работоспособности.
Содержание и структура
В этот документ входят конкретные сведения, с указанием не только способа проведения тех или иных операций, но и точного времени, в которое эти операции следует проводить. Структура руководств администратора зависит, прежде всего, от конкретного программного продукта. Разработка этого документа проходит с учетом специфических требований системы к эксплуатации и обслуживанию.
Оформление
Руководство администратора – это сложный эксплуатационный документ, который требует углубленных знаний не только в стандартизации, но и в области разработки и применения программных продуктов. В нашей компании работают профессионалы, которые могут грамотно и качественно составить этот документ, причем сделать это в кратчайшие сроки.
Мы не единожды сталкивались с оформлением эксплуатационной документации, поэтому обладаем в данном деле солидным опытом, который с радостью используем для ваших нужд. С нами разработка любой документации на программы или автоматизированные системы перестанет быть проблемой!
Оформите заявку и задавайте все интересующие вас вопросы по телефону
+7(499)755-74-33 e-mail Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра. или через форму заказа.
Помимо использования, автоматизированную систему необходимо также устанавливать и настраивать. Каким образом решается этот вопрос (ГОСТ 34)?
Назначение руководства администратора
Проектная документация на автоматизированную систему очень важна, так как является определяющей в процессе разработки и представляет собой то видение системы, которое будет в дальнейшем реализовано. Однако, не менее важны и эксплуатационные документы, которые позволят использовать и обслуживать систему правильно, эффективно и с минимальными затратами.
Одним из необходимых в процессе эксплуатации системы документов является Руководство администратора. Роль администратора системы заключается в том, чтобы организовывать и поддерживать работу конечных пользователей, тогда как обеспечение технической работоспособности системы обычно обеспечивается другими людьми. Таким образом, администратор лишь управляет работой системы, например:
– выполняет определенные действия по настройке программы;
– управляет учетными записями пользователей;
– настраивает права доступа;
– исправляет ошибки в данных;
– обеспечивает информационную поддержку.
Состав типового руководства администратора
Указанный выше список может меняться и дополняться в зависимости от особенностей конкретной АС. Необходимо предусмотреть все возможные функции, которые будет выполнять администратор программы, и предоставить четкие и понятные инструкции для выполнения конкретных действий. Для этого в документ Руководство администратора обычно включают такие разделы, как:
– Описание области применения и способа использования системы.
– Описание логики работы системы в виде основных правил и принципов ее работы.
– Описание функций администратора и перечень операций, необходимых для выполнения каждой из функций.
– Подробное описание порядка и способа выполнения каждой из операций функции администратора.
– Описание вида и порядка действий по обслуживанию системы.
– Описание вероятных ошибок и неполадок в работе системы и способов их устранения.
Стандарты для руководства администратора
Содержание и оформление Руководства администратора как эксплуатационного документа также регулируется государственными стандартами, так что и здесь необходимо соблюдать их требования. Несмотря на то, что не существует отдельного ГОСТа на создание Руководства администратора, его структура и оформление регламентируется РД 50-34.698-90, где описаны общие требования к содержанию документации.
Стоимость разработки руководства администратора
Наименование документа |
Наименование стандарта |
Стоимость разработки |
---|---|---|
Руководство администратора на АС |
РД 50-34.698 |
от 80 тыс. р. |
В заключение хочется сказать, что, несмотря на все принципы и правила, у каждой системы всегда существуют особенности установки и настройки, которые нужно учесть в документации. Обратитесь к нам, и мы поможем вам преодолеть эти трудности и сэкономим ваше время!
Возможно, вас также заинтересует:
– разработка руководства пользователя;
– создание руководства программиста;
– разработка руководства оператора.
Содержание
- Руководство администратора
- Назначение руководства администратора
- Состав типового руководства администратора
- Стандарты для руководства администратора
- Стоимость разработки руководства администратора
- Руководство администратора
- Содержание и структура
- Оформление
- Руководство системного администратора
- Назначение руководства системного администратора
- Состав типового руководства системного администратора
- Стандарты для руководства системного администратора
- Руководство системного администратора
- Руководство пользователя
- Содержание
- Содержание
- Стандарты
Руководство администратора
Помимо использования, автоматизированную систему необходимо также устанавливать и настраивать. Каким образом решается этот вопрос (ГОСТ 34)?
Назначение руководства администратора
Проектная документация на автоматизированную систему очень важна, так как является определяющей в процессе разработки и представляет собой то видение системы, которое будет в дальнейшем реализовано. Однако, не менее важны и эксплуатационные документы, которые позволят использовать и обслуживать систему правильно, эффективно и с минимальными затратами.
Одним из необходимых в процессе эксплуатации системы документов является Руководство администратора. Роль администратора системы заключается в том, чтобы организовывать и поддерживать работу конечных пользователей, тогда как обеспечение технической работоспособности системы обычно обеспечивается другими людьми. Таким образом, администратор лишь управляет работой системы, например:
– выполняет определенные действия по настройке программы;
– управляет учетными записями пользователей;
– настраивает права доступа;
– исправляет ошибки в данных;
– обеспечивает информационную поддержку.
Состав типового руководства администратора
Указанный выше список может меняться и дополняться в зависимости от особенностей конкретной АС. Необходимо предусмотреть все возможные функции, которые будет выполнять администратор программы, и предоставить четкие и понятные инструкции для выполнения конкретных действий. Для этого в документ Руководство администратора обычно включают такие разделы, как:
– Описание области применения и способа использования системы.
– Описание логики работы системы в виде основных правил и принципов ее работы.
– Описание функций администратора и перечень операций, необходимых для выполнения каждой из функций.
– Подробное описание порядка и способа выполнения каждой из операций функции администратора.
– Описание вида и порядка действий по обслуживанию системы.
– Описание вероятных ошибок и неполадок в работе системы и способов их устранения.
Стандарты для руководства администратора
Содержание и оформление Руководства администратора как эксплуатационного документа также регулируется государственными стандартами, так что и здесь необходимо соблюдать их требования. Несмотря на то, что не существует отдельного ГОСТа на создание Руководства администратора, его структура и оформление регламентируется РД 50-34.698-90, где описаны общие требования к содержанию документации.
Стоимость разработки руководства администратора
Руководство администратора на АС
В заключение хочется сказать, что, несмотря на все принципы и правила, у каждой системы всегда существуют особенности установки и настройки, которые нужно учесть в документации. Обратитесь к нам, и мы поможем вам преодолеть эти трудности и сэкономим ваше время!
Источник
Руководство администратора
Руководство администратора – это составная часть эксплуатационной документации, которая разрабатывается на любую программу или автоматизированную систему. При помощи руководства администратора ответственные пользователи системы получают возможность управлять ее функционированием – выполнять определенные операции по обеспечению порядка работы АСУ, распределять права доступа к ней, редактировать данные и исправлять ошибки.
Руководство администратора не имеет собственного стандарта оформления. Выполняется этот документ по РД 50-34.698-90, содержащему общие требования к содержанию документации на автоматизированные системы.
Руководство администраторов часто путают с руководствами системных программистов (администраторов). Это неверно, ведь цель данного документа – организация и поддержка целевого применения АСУ, а не обеспечение ее технической работоспособности.
Содержание и структура
Руководство администратора обычно состоит из:
Описания назначения и порядка использования программного продукта.
Описания общих принципов логики функционирования системы.
Перечисления администраторских обязанностей и связанных с ними операций.
Регламента выполнения каждой операции – очередность, периодичность, обязательность.
Перечня мероприятий по обслуживанию системы с указанием порядка проведения:
• Настройка и параметризация
• Справочно-нормативные данные
• Описание управления учетными записями
• Способы назначения прав доступа
• Ввод и вывод информации
Описания возможных проблем или неполадок функционирования системы, методов их устранения.
В этот документ входят конкретные сведения, с указанием не только способа проведения тех или иных операций, но и точного времени, в которое эти операции следует проводить. Структура руководств администратора зависит, прежде всего, от конкретного программного продукта. Разработка этого документа проходит с учетом специфических требований системы к эксплуатации и обслуживанию.
Оформление
Руководство администратора – это сложный эксплуатационный документ, который требует углубленных знаний не только в стандартизации, но и в области разработки и применения программных продуктов. В нашей компании работают профессионалы, которые могут грамотно и качественно составить этот документ, причем сделать это в кратчайшие сроки.
Мы не единожды сталкивались с оформлением эксплуатационной документации, поэтому обладаем в данном деле солидным опытом, который с радостью используем для ваших нужд. С нами разработка любой документации на программы или автоматизированные системы перестанет быть проблемой!
Оформите заявку и задавайте все интересующие вас вопросы по телефону +7(499)755-74-33 e-mail Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра. или через форму заказа.
Источник
Руководство системного администратора
Помимо использования, автоматизированную систему необходимо также устанавливать и настраивать. Каким образом решается этот вопрос (ГОСТ 19)?
Назначение руководства системного администратора
Системный администратор – это сотрудник, должностные инструкции которого подразумевают обеспечение штатной работы парка компьютерной техники, сети и программного обеспечения (ранее должность называлась «системный программист»). Соответственно, именно этот человек будет заниматься установкой вашего программного обеспечения на конкретных технических средствах, будь то персональный компьютер с определенными характеристиками, либо промышленный серверный комплекс.
Руководство системного администратора призвано максимально подробно раскрыть информацию о комплексе технических средств, необходимых для работы вашего программного обеспечения, а также описать процесс и особенности установки, настройки и поддержки работоспособности вашего ПО.
Состав типового руководства системного администратора
В системе ЕСПД требования к содержанию и оформлению данного руководства регулируются стандартом ГОСТ 19.503-79. В соответствии с ним, документ должен содержать следующие разделы:
1) Общие сведения о программе – назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
2) Структура программы – сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
3) Настройка программы – описание инструкций по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.).
4) Проверка программы – описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).
5) Дополнительные возможности – описание дополнительных разделов функциональных возможностей программы и способов их выбора.
6) Сообщения системному программисту – тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.
Стандарты для руководства системного администратора
Руководство системного администратора выполняется в соответствии с требованиями ГОСТ 19.503.
Источник
Руководство системного администратора
Руководство системного администратора составляют на основании ГОСТ 19.503-79
Руководство системного администратора — программный документ, предоставляющий специалисту информацию, необходимую для выполнения работы по установке программ и поддержанию работоспособности всего программного обеспечения, используемого в рамках тех или иных систем.
Руководство системного администратора — вспомогательный документ для прикладных программных продуктов и основной для серверных и системных, которые не имеют непосредственных пользователей.
В руководстве системного администратора должны быть изложены:
– назначение и область применения программы;
– состав программы, основные принципы ее функционирования;
– комплект поставки (если он не указан в отдельном документе);
– системные требования для программы или ее компонентов;
– предпочтительная очередность установки компонентов;
– процедура установки программы или каждого ее компонента;
– порядок обязательной первоначальной настройки программы;
– способы интеграции установленных копий компонентов между собой;
– интегрирование программы со сторонним ПО, например, с сервером БД;
– способы и периодичность контроля правильности работы программы;
– порядок текущего обслуживания работающих копий программы;
– порядок решения всевозможных вспомогательных задач;
– аварийные ситуации и способы их устранения.
Дополнительно в руководстве системного администратора можно описать:
– пользовательский интерфейс административной консоли;
– утилиты командной строки и синтаксис их запуска;
– конфигурационные файлы и правила их написания;
– язык для составления управляющих скриптов.
Структура руководства системного программиста имеет вид:
1. Общие сведения о программе.
2. Архитектура и принципы функционирования.
3. Системные требования.
4. Установка программы.
5. Административная консоль и работа с ней.
6. Файл конфигурации. Составление и правка.
7. Обязательная начальная настройка программы.
8. Проверка правильности функционирования программы.
9. Мероприятия по текущему обслуживанию программы.
10. Оптимизация работы программы.
11. Аварийные ситуации и способы их устранения.
В качестве примера приведено содержание руководства системного администратора для программы ТурбоБухгалтер 6.5. Сетевая версия.
ТурбоБухгалтер — одна из наиболее популярных в нашей стране программ автоматизации бухгалтерского учета. Сетевая версия программы позволяет организовать совместную работу нескольких бухгалтеров с общим набором данных. Клиент-серверная архитектура и применение протокола TCP/IP для обмена данными между клиентской и серверной частями делает возможной работу бухгалтеров в режиме удаленного доступа (например, из дома). Программа ТурбоБухгалтер разработана компанией ДИЦ. Руководство системного администратора на серверную часть разработано «Философтом».
Терминология и условные обозначения
Требования к конфигурации аппаратуры и программного обеспечения
Требования к квалификации администратора
1 Сетевая версия программы и принципы ее работы
1.1 Назначение сетевой версии программы
1.2 Базовые понятия и определения
1.2.2 Базы данных и табличные журналы
1.2.3 Структура баз данных
1.3 Порядок работы с сетевой версией программы
1.4 Необходимое условие корректной работы сетевой версии программы
2 Установка сервера турбо бухгалтер 6.5
3 Пользовательский интерфейс сервера
3.1 Запуск программы Турбо Бухгалтер Сервер
3.4 Панель инструментов
3.5 Строка состояния
3.6 Список пользователей
4 Настройка плана сервера
4.1 Порядок выполнения настройки. Редактор плана сервера
4.2 Настройка баз данных, табличных журналов и их разделов
4.3 Структура баз данных: редактирование и реорганизация
4.4 Настройка схем доступа
4.5 Настройка перечня пользователей
4.6 Завершение работы с редактором плана сервера
5 Установка связи сервера с клиентскими рабочими местами
5.1Подключение клиентских мест к Серверу Турбо Бухгалтер 6.5
5.2. Отладка связи между клиентскими местами и программой-сервером.
5.3 Основные неполадки и способы их устранения
6 Управление работой клиентских модулей с сервера
6.1 Просмотр изменений, вносимых пользователями в данные
6.2 Отправка сообщений пользователям
6.3 Закрытие клиентских мест
6.4 Отключение клиентских мест
6.5 Потеря связи с клиентским местом
7 Взаимодействие пользователей с программой-сервером
7.1 Отключение от программы-сервера
7.2.Типичные неполадки при взаимодействии пользователя с программой-сервером
8 Оптимизация и настройка программы-сервера
8.1 Подготовительные и заключительные операции
8.2 Проверка наличия связи
8.3 Режим регистрации изменений записей общих данных
8.4 Пароль администратора сервера
8.5 Дополнительные параметры
9.Ведение резервных копий (зеркалирование) баз данных
9.1 Понятие и порядок зеркалирования
9.2 Настройка зеркалирования
9.3 Экспорт зеркалирования баз данных
9.4 Импорт зеркалирования баз данных
Приложение A. Перенос баз данных и табличных журналов на сервер
Приложение B. Возможности работы в глобальных сетях
Источник
Руководство пользователя
Руководство пользователя (англ. user guide или user manual), руководство по эксплуатации, руководство оператора — документ, назначение которого — предоставить людям помощь в использовании некоторой системы. Документ входит в состав технической документации на систему и, как правило, подготавливается техническим писателем.
Большинство руководств пользователя помимо текстовых описаний содержит изображения. В случае программного обеспечения, в руководство обычно включаются снимки экрана, при описании аппаратуры — простые и понятные рисунки или фотографии. Используется стиль и язык, доступный предполагаемой аудитории, использование жаргона сокращается до минимума либо подробно объясняется.
Содержание
Содержание
Типичное руководство пользователя содержит:
Все главы и пункты, а также рисунки и таблицы, как правило, нумеруются, с тем, чтобы на них можно было сослаться внутри документа или из другого документа. Нумерация также облегчает ссылки на части руководства, например, при общении пользователя со службой поддержки.
Стандарты
Структура и содержание документа Руководство пользователя автоматизированной системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и содержание документов Руководство оператора, Руководство программиста, Руководство системного программиста регламентированы ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.
Источник