ПРАКТИЧЕСКОЕ ЗАНЯТИЕ №7

Написание руководства системного программиста (администратора) заданной программы

Цели работы:

• 
  изучение нормативно правовой документации, регламентирующей разработку документации на программные средства.
  
• 
  приобретение навыков разработки руководства системного программиста ПС.
  

Время выполнения: 4 часа.

Краткие теоретические материалы

Если программа более-менее проста, пользователь может установить ее себе на компьютер самостоятельно. Поддерживать ее работоспособность, например, выполнить переустановку, если возникнут какие-нибудь проблемы, он тоже, как правило, в состоянии.

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

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

Руководство системного администратора — программный документ, предоставляющий специалисту информацию, необходимую для выполнения этой работы.

В ЕСПД специалист, сходный по обязанностям с современным системным администратором,

называется системным программистом, а адресованный ему документ — руководством системного программиста.

Содержание документа "Руководство системного программиста (администратора)"

Если речь идет о сложных программных или аппаратно- программных комплексах, то системный программист (администратор) - это квалифицированный специалист, которому приходится принимать нетривиальные решения.

Чтобы удовлетворить его потребности в информации, составителю документации необходимо понимать

---

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

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

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

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

Итак, в руководстве системного администратора должны быть изложены:

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

Нередко в руководстве системного администратора вдобавок приходится описывать:

• 
  пользовательский интерфейс административной консоли;
  
• 
  утилиты командной строки и синтаксис их запуска;
  
• 
  конфигурационные файлы и правила их написания;
  
• 
  язык для составления управляющих скриптов.
  

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

---

Методика и стиль изложения материала

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

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

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

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

Структура руководства системного программиста, приведена в ГОСТ 19.503-79:

• 
  Общие сведения о программе.
  
• 
  Структура программы.
  
• 
  Настройка программы.
  
• 
  Проверка программы.
  
• 
  Дополнительные возможности.
  
• 
  Сообщения системному программисту.
  

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

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

Задания для выполнения

1. 
   Подготовить документ (*.doc), содержащий структуру основных разделов руководства системного программиста стандартного форматирования: шрифт TimesNewRoman, 14 пт, поля, межстрочный интервал - стандартные, как в техническом задании, имя файла - <ФИО студента. Руководство системного программиста>.
   
2. 
   На основании технического задания на разработку (практическая работа 1), заполнить разделы руководства системного программиста "Общие сведения о программе", "Структура программы", "Настройка программы".
   
3. 
   Сохранить документ с именем (Фамилия, инициалы студента. Наименование работы Руководство системного программиста
   

---

Контрольные вопросы:

1. 
   Какие разделы входят в Руководство системного программиста?
   
2. 
   Что нужно учесть при изложении материала руководства?
   
3. 
   Почему руководство системного программиста иногда называют руководством системного администратора?
   

КРИТЕРИИ ОЦЕНКИ
Оценку «отлично» обучающийся получает,

если работа полностью выполнена и при защите работы ответы педагогу на вопросы по ходу выполнения работы, даны исчерпывающие

Оценку «хорошо» обучающийся получает:

1) если работа полностью выполнена, но при защите работы ответы педагогу на вопросы по ходу выполнения работы, даны не полностью. 2) если работа выполнена полностью, но с замечаниями, но при защите работы ответы педагогу на вопросы по ходу выполнения работы, даны исчерпывающие

Оценку «удовлетворительно» обучающийся получает

1) если работа выполнена не полностью, при защите работы ответы педагогу на вопросы по ходу выполнения работы, даны частично. 2) если работа выполнена полностью, но не защищена

Оценку «неудовлетворительно» обучающийся получает,

если работа выполнена менее чем на 50%

---

Смотрите также файлы

• 2. 4 Непрерывное повышение профессионального мастерства современного педагога и система наставничества в Школе Минпросвещения России.docx

• Салтыковская гимназия 143900 Г. о. Балашиха, мкр. Салтыковка, Носовихинское шоссе, д. 230 тел.факс 84955299669.docx

• 1. Жалобы и объективные данные при железодефицитной анемии. Жалобы.docx

• Установки на компьютер. Установка выполняется специальным пакетным менеджером или инсталлятором и включает в себя.pptx

• 1 Техникоэкономическая характеристика предметной области и предприятия (Установление границ рассмотрения).docx