Данный раздел определяет состав комплектов документации (далее по тексту КД) и описывает последовательность документировании целевой информационной системы. Порядок разработки документации — от общего к частному, т.е. в первую очередь готовится базовый комплект, в котором даётся общее описание системы и каждый последующий комплект расширяет и углубляет знания о целевой инфраструктуре.
Базовый комплект документации
Базовый комплект документации (КД-1) предполагает минимальный объем информации, необходимый для обслуживания информационной системы, и используется в несложных типовых конфигурациях. Среднее предприятие малого бизнеса имеет примитивную инфраструктуру, ограниченную одним или двумя маршрутизаторами, десятком рабочих станцией, сервером и несколькими устройствами для печати. Поэтому полный (КД-3) или расширенный (КД-2) комплекты документации избыточны для обслуживания таких объектов.
1. Общее описание предприятия
Здесь собраны данные для полевой работы (выезды) и прямого взаимодействия с ключевыми участниками или владельцами бизнес-процессов предприятия, в которые напрямую или опосредованно вовлечена наша компания. Также в этом разделе определяется домен предприятия.
1.1. Локации
В данном разделе приводятся данные, необходимые инженеру d19 для осуществления выезда и получения физического доступа к элементам информационной системы. Описываются офисы и обособленные подразделения предприятия, в которых присутствуют объекты обслуживания или значимые элементы инфраструктуры вне зоны нашей ответственности, но оказывающие критические влияние на информационную систему. Каждая локация, будь-то офис, розничный магазин, торговая точка и т.д., должна быть описана отдельно, согласно следующего шаблона:
Адрес
Описание маршрута
Необходимые пояснения в текстовом или графическом исполнении (стрелки или иные обозначения, нанесенные на Google или Яндекс карту), уточняющие местоположение локации. Особенно актуально для промзон с запутанной и не интуитивной адресацией.
Идентификатор локации
Назначается инженером для технических нужд (мониторинг, удаленный доступ и т.д.) и должен отвечать следующим требованиям:
- используются только строчные буквы латиницы, цифры и минус1 (”-”), например: rtl-16 или mf (rtl — торговая точка 16, mf — производство);
- не более 8 символов;
- должно иметь значение, являться аббревиатурой, иметь ассоциативную и/или мнемоническую связь с локацией, например: mk - мясокомбинат или hq - главный офис.
Зачем
Все ключевые объекты обслуживания доступны в технологической vpn-сети по своим внутренним доменным именам вида [устройство].[локация].[город].[домен предприятия]. Например: gw.mk.rov.atrus, db.hq.rov.atrus или b24.dtc.yar.php.
Ниже приведен перечень универсальный и устоявшихся названий для локаций, придумывайте свои идентификаторы только если ни одно из предложенных не подходит для локации.
| Идентификатор | Описание |
|---|---|
| hq | Head quarter — главный офис, штаб-квартира организации, центр принятия решений, основной офис |
| br | Branch — филиал компании или подчиненный штаб-квартире офис |
| mf | Manufacture — производство |
| st | Storage — склад продукции, складские помещения |
| dtc | Data center — Центр обработки данных, ЦОД |
| rtl | Retail — торговая точка |
План этажа
План этажа с обозначением расположения ключевых элементов инфраструктуры (см. 3. Структурная схема сети). При сборе информации можно использовать фотографию плана эвакуации, который в обязательном порядке2 должен присутствовать на каждом этаже здания.
Ключевых!
Обратите внимание, что в данном контексте АРМ, периферийные устройства, элементы СКС не относятся к ключевым элементам инфраструктуры, однако, их нанесение на план этажа не запрещается.
Режим работы
Указываются рабочие дни и часы, например: 5/2, 8:00 - 17:00.
Специфичные условия физического доступа
Наличие пропускного режима или проходной, требования к документам (паспорт, водительское удостоверение, иное), наличие списков доступа, участие заказчика в оформлении пропусков или устном разрешении на доступ.
1.2. Ответственные лица
Список внешних и внутренних ответственных лиц, которые способны оказывать влияние на информационную систему предприятия заказчика. Заполняется согласно следующего шаблона:
| ФИО | Конт. телефон | ЛПР | Внешний | Описание |
|---|---|---|---|---|
| Иванов Иван | +7 999 999 99 99 | нет | да | Обслуживает 1С |
| Петров Иван | +7 888 888 88 88 | да | нет | Директор |
| РТК | 8 800 800 80 80 | нет | да | Интернет, по адресу Локация №1 |
| Иванова Ирина | +7 777 777 77 77 | да | нет | Гл. бухгалтер, закупки через неё |
| Никитка | +7 666 666 66 66 | нет | да | Пишет СРМ |
2. Общее описание информационной системы
2.1. Список устройств и идентификаторы
Список ключевых элементов инфраструктуры заполняется согласно шаблона:
| Тип элемента ИС | Производитель | Модель | Идентификатор |
|---|---|---|---|
| Маршрутизатор | Mikrotik | RB3011UiAS-RM | gw-1 |
| Маршрутизатор | Mikrotik | RB1100AHX4 | gw-2 |
| Сервер | NoName | i5/1 Tb nvme/128 Gb ddr5 | srv-1 |
Ключевые элементы инфраструктуры
Ключевые элементы инфраструктуры приведены в описании структурной схемы сети:
- коммутаторы;
- маршрутизаторы;
- серверы.
Серверы в малом бизнесе
В данном контексте мы считаем сервером любое устройство (стоечный сервер, рабочая станция пользователя, бытовой NAS и т.д.), которое предоставляет бизнес-сервисы пользователям. Пример: общая папка для документов на рабочей станции сотрудника компании, в данном контексте, будет считаться “сервером”.
Идентификатор устройства назначается инженером и должен отвечать тем же требованиям что и Идентификатор локации.
2.2. Используемые бизнес-сервисы
Сервисы для предприятий или бизнес-сервисы — это приложения, онлайн-площадки или программные обеспечения, созданные для решения конкретных задач в компании. Они помогают автоматизировать производственные, административные, коммерческие и коммуникативные процессы, ускорить взаимодействие между сотрудниками и партнёрами. К бизнес-сервисам не относится программное обеспечение для обслуживания и управления информационной системой (средства виртуализации, приложения для резервного копирования, сетевые экраны, антивирусы и т.д.). Таблица используемых предприятием сервисов заполняется согласно следующего шаблона.
| Назначение | Приложение | Self-hosted | Ответственное лицо |
|---|---|---|---|
| Электронная почта | VK WorkSpace, Яндекс, Gmail, иное: заполняется инженером | + / - | см. 1.2. Ответственные лица |
| CRM-система | AmoCRM, Битрикс 24, иное: заполняется инженером | + / - | см. 1.2. Ответственные лица |
| Управление проектами и задачами | Jira, Slack, Trello, Asana, Битрикс24, иное: заполняется инженером | + / - | см. 1.2. Ответственные лица |
| Учет и финансовое управление | 1С, Сбис, иное: заполняется инженером | + / - | см. 1.2. Ответственные лица |
| Иное: заполняется инженером |
2.3. Структурная схема
Готовится согласно правил и требований оформления приведенным в 3. Структурная схема сети.
2.4. Специфичные регламенты обслуживания
Перечень специфичных регламентов обслуживания (СРО) составляется в произвольной форме и описывает особые мероприятия (специфичные конкретно для этого клиента), которые необходимо осуществлять с заданной периодичностью. Примеры:
Каждое 10 число месяца нужно осуществлять тестовое восстановление из случайного инкрементального бэкапа с проверкой.
В начале каждого месяца осуществлять сверку баз 1С и Сбиса.
3. Журнал изменений
Заполняется ответственным за ведение документации и имеет формат:
[дата, время]: суть изменений. [было (изменяемый текст]:[стало (измененный текст)]
Footnotes
-
- знак подчёркивания — не полностью совместим с DNS, при печати нужно нажимать шифт;
- точка — зарезервирована за DNS;
- двоеточие — непривычно, несовместимо с DNS
-
План эвакуации при пожаре в офисных зданиях обязателен, если здание отвечает хотя бы одному из нижеперечисленных условий (п. 5 Правил противопожарного режима):
- в здании одновременно могут находиться 50 и более человек;
- в здании хотя бы на одном этаже есть постоянные рабочие места для 10 и более человек. Если площадь этажа более 1 000 кв. м, рекомендуется условно поделить этаж на секции и сделать план для каждой из них.