Инструкция по развертыванию

Инструкция по развертыванию

Общие сведения

Документация: эксплуатационная
Предмет: программный комплекс, прикладная платформа, аппаратно-программный комплекс
Аудитория: технические специалисты, создающие систему на основе комплекса
Задачи: обеспечить ввод в эксплуатацию всех частей комплекса
Стандарты: ГОСТ 2.601-2006, ГОСТ 2.610-2006
Схожие документы: инструкция по монтажу, пуску, регулированию и обкатке изделия

Цели и задачи

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

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

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

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

Развертывание аппаратно-программного комплекса обычно включает в себя:

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

Развертывание программной платформы обычно включает в себя:

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

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

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

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

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

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

Примеры

Программный комплекс GELICS. Инструкция по развертыванию

Программный комплекс GELICS предназначен для использования в составе систем контроля доступа в помещения и систем пожарной сигнализации. Комплекс разработан Инженерной компанией А8. Комплект эксплуатационной документации на него, в том числе, инструкцию по развертыванию разработала компания «Философт».

1. Введение 
1.1. Состав и назначение документа  
1.2. Принятые соглашения  
2. Системные требования  
2.1. Компьютерная техника 
2.2. Операционная система и сетевые настройки  
2.3. Требования к квалификации персонала 
3. Установка ПК GELICS 
3.1. Порядок установки 
3.2. Установка серверного компонента ПК GELICS
3.3. Развертывание базы данных системы
3.4. Установка клиентской части ПК GELICS 
Приложение A. Состав документации 
Глоссарий 

© «Философт», 2008–2017

+7 (499) 500-44-77

mail@philosoft.ru

SpyLOG