Предположим, большое предприятие открывает новый офис (укажите здесь случайное местоположение) и хочет, чтобы новые коллеги как можно быстрее ускорились. Также предположим, что это очень типичное предприятие со сложной средой, большой историей и почти полным отсутствием документации.
Уже решено, что новые коллеги получат документацию в стиле «как» для наиболее типичных задач и документацию по архитектуре семе для некоторых из более сложных систем.
Есть идеи по улучшению этого процесса? И, более конкретно, как должен выглядеть такой документ, чтобы быть полезным?
Я бы потратил время, которое у вас есть, на написание документа, который дает хороший обзор общей картины со всеми основными компонентами, независимо от их области. Затем они могут использовать его в качестве справочника и обзора того, что им, возможно, потребуется изучить. Так, например, если у вас большие кластеры, нарисуйте их. Если они сетевые администраторы, по крайней мере, составьте приличную схему сети компании.
С этого момента я начинал документировать все необычное в окружающей среде, а затем все, что было особенно продвинутым или сложным.
Если это должности более низкого уровня, на которых они будут выполнять в основном повторяющиеся задачи, то для меня есть смысл, но если это более продвинутые должности, то большая картина в сочетании с необычной / сложной документацией, которую я описал, имеет наибольший смысл.
Я создал вики в нашем офисе, чтобы собирать фрагменты знаний, поскольку у разработчиков было время писать материал. Босс был готов разрешить только «полные и полные документы», поэтому вместо этого ему понадобился sharepoint. Поскольку ни у одного разработчика не было времени на создание «скучных и полных документов», ничего не было написано, и, поскольку PHB запретил вики, мы вернулись туда, где были пару лет назад.
Если системы должным образом задокументированы, никаких дополнительных действий не требуется. Любой достойный системный администратор должен уметь определять, что нужно сделать и как это сделать, на основе системной документации, хотя опытный сотрудник, конечно, сделает все для него еще проще.
Когда система должным образом задокументирована, весь ИТ-персонал может оказаться сбитым с толку этим пресловутым автобусом, и новый персонал должен иметь возможность очень быстро набрать скорость без посторонней помощи. Если в вашей организации это не так, необходимо срочно исправить.
Начните с создания внутренней вики и используйте эту базу как место для документирования. Я занимаюсь этим на работе уже некоторое время, и информация там постепенно появляется по мере необходимости.