Документация, которая нужна вам

Документация, которая нужна вам

Что нужно системному администратору вместо громоздкой и устрашающей документации? Вам нужно хранилище информации, полезное с точки зрения тайм-менеджмента. Возможно, у вашего шефа есть свои резоны требовать, чтобы вы вели документацию. Я советую вам исходить из собственных соображений — эгоистических. Стройте хранилища информации, которые будут служить вам и вашим целям тайм-менеджмента, а не каким-то посторонним целям вашего шефа или отдела контроля качества. Собственно, системному администратору требуются два хранилища информации:

• Хранилище, используемое клиентами. Это документы, доступ к которым, по вашему мнению, должны иметь все пользователи вашей сети. Например, сюда входит описание общей политики системного администрирования и процедур, которые необходимо соблюдать.

• Хранилище для внутреннего пользования ИТ-персоналом. Информация, нужная лично вам для работы, например контактная информация производителей, полученные вами инструкции по задачам и т. д.

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

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

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

В этих двух хранилищах вы должны собрать следующие материалы:

• Правила обращения за помощью (возможно, в виде простого дерева решений).

• Общие направления политики системного администрирования (со ссылками на соответствующие страницы документации отдела кадров и/или юридического отдела).

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

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

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

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

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

Хранилище, используемое клиентами

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

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

Как получить помощь

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

Как запросить новые возможности

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

Политика системного администрирования

Маркированный список ссылок на документы о политике, написанные вами, а также ссылки на соответствующие страницы документации отдела кадров или юридического отдела.

Свод всех установленных вами политик

Со ссылками на соответствующие страницы документации отдела кадров или юридического отдела.

Этого образца достаточно для любой небольшой группы системного администрирования, у которой пока еще нет подобного сайта. Если вы работаете в такой крупной информационно-технологической организации, что мой образец покажется вам смешным, то у вас, скорее всего, уже есть соответствующая домашняя страница или веб-сайт, и этот образец вам попросту не нужен. Тем не менее, я был удивлен обилием ИТ-организаций, на веб-сайтах которых отсутствует как минимум один из вышеперечисленных элементов. Я также считаю, что подразделения больших организаций сильно выиграли бы, обладая персональными хранилищами информации.

Политика системного администрирования — это правила, по которым живут пользователи ваших компьютеров и сетей. Сюда входят правила безопасности, соглашения об уровнях сервисной поддержки, правила пользования компьютерами и сетями, этикет, правила привилегированного доступа к информации и т. д. В разделе «Политика системного администрирования» приведите ссылки на существующие документы в формате HTML, MS Word или PDF. Если таких документов пока нет, не помещайте этот раздел на главную страницу. Однако внесите в свой список дел пункт о разработке подобных документов. Если у вас нет собственных идей на этот счет, прочитайте главу 7 (о безопасности) и главу 9 (об этике) книги «The Practice of System and Network Administration» (Практика системного и сетевого администрирования). Я рекомендую вам начать с правил пользования компьютерами и сетями. Если юристы или кадровики вашей фирмы разработали такие правила, укажите ссылки на соответствующие документы. Если приведенный образец показал, что у вас отсутствует политика системного администрирования, то это не так уж плохо.

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

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

Внутренняя ИТ-документация

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

Если у вас еще нет подобного хранилища, приведу образец:

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

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

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

Рассмотрим пункты этого списка более подробно.

Контактная информация производителей и условия сервисной поддержки

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

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

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

Процедуры системного администрирования

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

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

Если есть несколько способов выполнения некоторой процедуры, но для вашей системы годится только один, задокументируйте его (и поясните, почему следует применять именно его). Часто бывает, что документ с инструкциями, найденный в Интернете или пришедший вместе с программным продуктом, предлагает много путей, ведущих к одной цели, но вы на опыте убедились, что вам подходит лишь один из них. Сохраните весь документ и снабдите его комментариями, например: «Применить вариант 3», или «Не делать этого», или «Эта комбинация прошла на сервере В, но не годится на остальных». Выделите комментарии цветом. Проявите уважение к авторским правам создателей документа!

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

Другой тип процедур, подлежащий документированию, — процедуры, которые вы не любите выполнять. Конечно, неплохо было бы задокументировать все свои действия, но где взять время? Просто задокументируйте процедуры, которые вы не любите выполнять, и у вас будет материал, позволяющий обучить этим процедурам другого сотрудника. Лично я терпеть не могу создавать новые учетные записи. Хотя я максимально автоматизировал этот процесс, для меня это все еще головная боль. Есть вещи, которые невозможно автоматизировать, например такие пункты моей технологической карты, как «Навестить сотрудника в его первый рабочий день и поинтересоваться, есть ли у него вопросы», или «Повторить визит через неделю». Итак, я задокументировал команду, создающую учетную запись, действия по проверке корректности новой учетной записи, а также другие действия, которые необходимо выполнить, когда появляется новый сотрудник. Это не «Война и мир» и даже не документ, разбитый на абзацы. Это просто маркированный список с комментариями. Но теперь, когда процесс задокументирован, я надеюсь переложить его на кого-нибудь другого. В главе 2 я уже говорил о делегировании. Хорошее хранилище документов значительно упрощает делегирование заданий.

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

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

Схемы сети

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

Самые пылкие сисадмины, вероятно, будут настаивать на схеме, нарисованной в программе Visio, с реалистичными пиктограммами серверов, расположение которых должно быть показано с точностью до миллиметра, но это как мышеловка. Вам не случалось, засев за рисование какой-то схемы, вдруг обнаружить, что весь день ушел только на то, чтобы довести ее до совершенства? В этой мышеловке нет сыра! Потратьте 10 минут, а не 10 часов. Я предпочитаю инструменты, не предназначенные для детализации, что вынуждает меня ограничиваться лишь общей схемой, не увязая в деталях. Как правило, я создаю схемы в PowerPoint и заношу в хранилище оригинал и его PDF-копию.

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

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