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

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

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

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

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

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

В системе ЕСПД требования к содержанию и оформлению данного руководства регулируются стандартом ГОСТ 19.503-79. В соответствии с ним, документ должен содержать следующие разделы:
1) Общие сведения о программе – назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
2) Структура программы –  сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
3) Настройка программы – описание инструкций по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.).
4) Проверка программы – описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).
5) Дополнительные возможности – описание дополнительных разделов функциональных возможностей программы и способов их выбора.
6) Сообщения системному программисту – тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.

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

Руководство системного администратора выполняется в соответствии с требованиями ГОСТ 19.503.

Стоимость разработки руководства системного администратора

Наименование документа	Наименование стандарта	Стоимость разработки
Руководство системного администратора на ПО	ГОСТ 19.503	от 80 тыс. р.

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

Возможно, вас также заинтересует:

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

---

Утвержден ИТВБ.00074-01 32 01-ЛУ

ПРИКЛАДНОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ

МУНИЦИПАЛЬНЫЙ МОДУЛЬ РАСПРЕДЕЛЁННОЙ АВТОМАТИЗИРОВАННОЙ СИСТЕМЫ ГОСУДАРСТВЕННОГО БАНКА ДАННЫХ О ДЕТЯХ

(ММ ППО АС ГБД)
Руководство системного программиста (администратора)

Подп. и дата
Инв. № дубл.
Взам. инв. №
Подп. и дата
Инв. № подл.

ИТВБ.00074-01 32 01
Листов 

2007

СОДЕРЖАНИЕ

1.ОБЩИЕ СВЕДЕНИЯ О ПРОГРАММЕ

1.1.Требования к техническим средствам

Для работы ММ ППО АС ГБД необходимы технические средства, описанные в таблице 1.1.

Таблица 1.1. Требования к техническим средствам

Наименование	Кол-во
1. Системный блок Intel Pentium III 1GHz или более мощный	1
2. Оперативная память не менее 1Gb	1
3. Дисковое пространство 6 Gb	1
4. Монитор 15′ LCD	1
5. Клавиатура PS/2	1
6. Манипулятор типа «мышь» (оптическая)	1
7. Источник бесперебойного питания (APC Smart-UPS 620 VA SC620I)	1
8. Cетевой фильтр (PILOT)	1

1.2.Требования к общему программному обеспечению (ОПО)

Требования к общему программному обеспечению (ОПО), необходимому для ММ ППО АС ГБД, представлены в таблице 1.2.

Таблица 1.2. Требования к ОПО

Наименование	Кол-во
1. ОС Microsoft Windows XP	1
2. Microsoft Office 2003	1

2.СТРУКТУРА ПРОГРАММЫ

ППО АС ГБД представляет из себя три различных уровня, взаимодействующих друг с другом последовательно (исключение составляет обмен производной информацией):

Рис. 2.1. Структура взаимодействия компонентов системы банка данных

3.НАСТРОЙКА И ПРОВЕРКА ПРОГРАММЫ

3.1.Microsoft Office 2003

Для того чтобы начать установку MS Office 2003, необходимо запустить файл Setup.exe в дистрибутиве MS Office 2003.

Рис. 3.2. Лицензионное соглашение MS Office 2003

Чтобы продолжить установку необходимо прочитать лицензионное соглашение и принять его, поставив галочку в единственном поле. После этого станет доступна кнопка Next (продолжение установки).

Рис. 3.3. Личные данные пользователя

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

Рис. 3.4. Серийный номер MS Office 2003
В этом окне вводится уникальный серийный номер установочного дистрибутива MS Office 2003. Серийный номер обычно указан на коробке с диском или на самом диске.

Рис. 3.5. Выбор вида установки и пути установки

В данном окне необходимо выбрать тип установки Typical Install. Путь установки – путь к любой папке жесткого диска, в которой будет находится устанавливаемая программа.

Рис. 3.6. Выбор компонентов

В данном окне необходимо обязательно отметить галочками следующие компоненты: Word, Excel. И нажать кнопку Next.

Рис. 3.7. Расширенные опции компонентов.

В данном окне ничего изменять не надо. Необходимо просто нажать кнопку Next.

Рис. 3.8. Процесс установки MS Office 2003

После проведенных выше операций появится окно установки MS Office 2003, с полосой прогресса установки.

Рис. 3.9. Завершение установки.

После завершения установки появляется окно завершения установки. Нажимаем кнопку Finish. Теперь на вашем компьютере установлен Microsoft Office 2003 необходимый для работы системы АИСТ ГБД(ФМ).

3.2.Установка АИСТ ГБД (ММ)

Рис. 3.10. Выбор пути установки.

После запуска установщика (Setup.exe) появляется окно мастера установки с предложением ввести путь установки и указать для кого устанавливается приложение. В качестве пути можно указать любую папку

Рис. 3.11. Выбор пути установки.

Рис. 3.12. Завершение установки.

После нажатия кнопки Close, установка АИСТ ГБД (ММ) будет завершена. Запуск АИСТ ГБД (ММ) производится с помощью ярлыка на рабочем столе

Рис. 3.13. Завершение установки.

3.3.Настройка приложения АИСТ ГБД (ММ) для работы с базой данных.

3.3.1.Вход в приложение

Рис. 3.14. Выбор сертификата.

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

Рис. 3.15. Главное окно программы.

После выбора сертификата, пользователь попадает в главное окно программы.

3.3.2.Настройка хранилища данных

Следующим шагом необходимо настроить работу программы с локальным хранилищем данных и с удаленной системой.

Рис. 3.16. Меню администрирования.

Настройка системы осуществляется с помощью пункта «Настройка системы» меню «Администрирование».

Рис. 3.17. Окно настройки источников данных.

Для работы системы необходимо настроить локальное и внешнее хранилища данных.

Локальное хранилище данных для регионального модуля является база данных MySql. Для работы с этим хранилищем необходимо выбрать в качестве типа хранилища «MySql», в качестве адреса сервера указать адрес компьютера, на котором установлен сервер MySql. Задать значение порта, на который настроен сервер MySql, а также задать имя и пароль учетной записи, с которой будет осуществляться подключение к базе данных(имя пользователя ставится в значение root, а пароль в значение, указанное при установке сервера).

Далее необходимо настроить удаленное хранилище верхнего уровня. Для этого необходимо выбрать пункт Используется, и в качестве типа хранилища указать MS SQL. В качестве адреса сервера и порта задать адрес и порт сервера базы данных федерального модуля, а в качестве логина и пароля – значения логина и пароля учетной записи, выделенной для конкретного региона (уточняется у администратора федерального модуля).

3.3.3.Настройка прав пользователей

Рис. 3.18. Окно настройки прав пользователей

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

Группа «Анкеты детей» — содержит набор прав, относящихся к работе с анкетами детей.

Просмотр анкеты ребенка – позволяет пользователю просматривать анкету ребенка.

Редактирование и ввод анкет детей – позволяет пользователю редактировать и заводить новые анкеты детей.

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

Возврат анкеты ребенка из архива в базу – позволяет пользователю вернуть снятую с учета анкету ребенка.

Ввод и изменение принятых мер по устройству ребенка – позволяет пользователю вводить и изменять принятые меры по устройству ребенка.

Вывод списка анкет в формате Excel – позволяет пользователю получить список анкет в формате Excel.

Печать, просмотр и сохранение запросов – позволяет пользователю производить соответствующие действия с запросами. Запросы представляют собой текстовые документы, созданные на основе шаблонов.

Экспорт анкет для Web-сайта – позволяет пользователю производить экспортирование вторичных данных о ребенке для последующего размещения их на сайте.

Групповое указание принятых мер – позволяет пользователю задавать принятые меры сразу для нескольких анкет детей.

Групповое изменение органов опеки – позволяет пользователю изменять поле «орган опеки» у нескольких анкет детей.

Групповой сброс в архив по возрасту – позволяет пользователю осуществить сброс в архив нескольких анкет детей с указанием причины списания «достижение 18 лет».

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

Анкеты граждан:

Просмотр анкет граждан – позволяет пользователю просматривать анкеты граждан.

Редактирование и ввод анкет граждан – позволяет пользователю производить изменение и ввод анкет граждан.

Прекращение учета сведений о гражданах – позволяет пользователю списывать в архив анкеты граждан.

Возврат анкеты граждан из архива в базу – позволяет пользователю вернуть списанные анкеты обратно в базу.

Печать, просмотр и сохранение запросов – позволяет пользователю производить соответствующие действия с запросами. Запросы – текстовые документы, созданные на основе шаблонов.

Прочие возможности:

Редактирование справочников – позволяет пользователю вносить изменения в имеющиеся справочники.

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

Управление пользователями – позволяет пользователю изменять права других пользователей.

Настройка источников данных – позволяет пользователю настраивать параметры локального и удаленного доступа к хранилищам данных.

3.3.4.Очередь пакетов

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

Рис. 3.19. Окно очереди пакетов.

Для обмена информацией с верхним уровнем необходимо нажать кнопку «Синхронизация» (если синхронизация не была выполнена автоматически). После этого неотправленные анкеты отправятся на верхний уровень, а если подключение не доступно, то формируются пакеты для отправки на съемном носителе. Открыть пришедшие анкеты можно с помощью кнопки «Открыть». Статус пакетов отображается в поле «Статус пакета».

Синхронизация проводится в обязательном порядке не менее одного раза в день.

4.ПЕРЕЧЕНЬ СОКРАЩЕНИЙ

ППО	Прикладное программное обеспечение
ФМ	Федеральный модуль
РМ	Региональный модуль
ММ	Муниципальный модуль
ГБД	Государственный банк данных
РБ	Региональный банк данных
ФБ	Федеральный банк данных
ФИО	Фамилия Имя Отчество

Лист регистрации изменений
Номера листов (страниц)	Всего листов (страниц) в докум.	№ докумен-       та	Входящий № сопрово- дительно- го докум. и дата	Подп.	Да- та
Изм	изменен- ных	заменен- ных	новых	аннули- рован-   ных

Руководство
пользователя должно содержать следующие
разделы:

• назначение
  программы;

• условия выполнения
  программы;

• выполнение
  программы;

• сообщения оператору.

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

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

В разделе «Условия
выполнения программы» должны быть
указаны условия, необходимые для
выполнения программы (минимальный и/или
оптимальный состав аппаратных и
программных средств и т.п.).

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

В разделе «Сообщения
оператору» должны быть приведены:

• тексты сообщений,
  выдаваемых в ходе выполнения программы;

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

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

Руководство
системного программиста должно содержать
следующие разделы:

• общие сведения о
  программе;

• структура программы;

• настройка программы;

• проверка программы;

• дополнительные
  возможности;

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

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

В обоснованных
случаях допускается раздел «Дополнительные
возможности» не приводить, а в наименованиях
разделов опускать слово «программа»
или заменять его наименованием программы.

В разделе «Общие
сведения о программе» должны быть
указаны:

• назначение и
  функции программы;

• сведения о
  технических и программных средствах,
  обеспечивающих выполнение данной
  программы.

В разделе «Структура
программы» должны быть приведены:

• сведения о структуре
  программы, ее составных частях;

• сведения о связях
  между составными частями;

• сведения о связях
  с другими программами.

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

При необходимости
приводят поясняющие примеры.

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

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

В разделе «Сообщения
системному программисту» должны быть
указаны:

• тексты сообщений,
  выдаваемых в ходе выполнения настройки,
  проверки и выполнения программы;

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

12. Требования по оформлению пояснительной записки

Все текстовые
документы
оформляются по ГОСТ 7.32-2001 и должны
соответствовать РД 40-050-87.

Текстовый
материал должен содержать следующие
структурные элементы: титульный лист,
задание (в том числе техническое задание),
реферат, содержание, обозначения и
сокращения, введение, основную часть в
соответствии с утвержденным заданием,
заключение, список использованных
источников, приложения. При необходимости
по согласованию с преподавателем
отдельные части текстового материала
могут быть опущены или добавлены.
Структурные элементы должны начинаться
с нового листа. В основной части только
заголовок раздела отделяется сверху и
снизу межстрочным интервалом (МСИ).
Межстрочный
интервал машинописного текста –
полуторный (множитель 1,2 процессора
«Word»).

Текст необходимо
оформлять с соблюдением следующих
размеров полей: левое
– 20 мм; правое – 10 мм; верхнее – 20 мм;
нижнее – 20 мм. Страницы текста и
иллюстрации должны соответствовать
формату А4.

Текст должен быть
выполнен с использованием компьютера
и принтера на одной стороне листа белой
бумаги. Цвет шрифта должен быть черным,
высота букв, цифр и других значков – не
менее 1,8 мм (кегль не менее 12). Разрешается
использовать компьютерные возможности
акцентирования внимания на определенных
терминах, формулах, теоремах, применяя
шрифты разной гарнитуры. Величина
абзацного отступа должна быть 10 мм.

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

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

Примеры оформления
титульного листа приведены в приложениях
Б-Я.

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

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

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

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

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

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

Содержание

Перечень условных
обозначений

Введение

Список использованных
источников

Приложение

Нумерация страниц
– арабскими цифрами в центре нижней
части листа без точки. Нумерация страниц
в текстовом документе должна быть
сквозной: первой страницей является
титульный лист, второй – задание (и
техническое задание (ТЗ) при его наличии),
затем – реферат, содержание и т.д. На
титульном листе и задании (в том числе
и ТЗ, реферате) номер страницы не ставят.

Разделы текстового
документа должны иметь порядковые
номера в пределах всего документа. В
тексте название раздела пишется без
кавычек. Подразделы нумеруются арабскими
цифрами в пределах каждого раздела.
Номер подраздела должен состоять из
номера раздела и номера подраздела,
разделённых точкой (например, 2.4). Пункты
нумеруются также арабскими цифрами в
пределах каждого подраздела по такой
же схеме, например: 2.4.1 (первый пункт
четвертого подраздела второго раздела).

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

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

Как и любое
предложение текстового документа,
математическая формула имеет свой
алфавит и порядок написания. Формулы,
представляющие собой уравнения и
неравенства, пишутся с красной строки,
а связывающие их слова (где, следовательно,
откуда, так как и т.п.) в начале следующей
строки без абзаца. Уравнения и формулы
следует выделять в отдельную строку,
выше и ниже которой должно быть оставлено
не менее одного МСИ.

Знаки препинания
ставят на продолжении основной строки
формулы, непосредственно за ней.

Формулы следует
нумеровать арабскими цифрами в пределах
всего текста в круглых скобках в крайнем
правом положении на строке, или в пределах
раздела. Одну формулу обозначают (1). При
ссылке на формулу указывать ее полный
номер в круглых скобках, например, «…
в формуле (3.10)…».

Иллюстрации
(чертежи, рисунки, графики, схемы,
компьютерные распечатки, диаграммы,
фотоснимки), в том числе и цветные,
следует располагать непосредственно
после текста, в котором они упоминаются
впервые, или на следующей странице. Они
должны соответствовать требованиям
госстандартов Единой системы
конструкторской документации (ЕСКД).
Иллюстрации, за исключением приложений,
следует нумеровать арабскими цифрами
сквозной нумерацией или в пределах
раздела. Иллюстрация обозначается
посередине строки её номером и названием:
Рис. 1. Детали прибора.

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

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

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