Зарегистрируйте heck из всего.
Был поток на Slashdot недавно о стартовой документации, которая вдохновила меня записывать свои мысли о документации.
Мои ключевые пункты были:
Принцип № 1: это никогда не делается
Документация является продолжающимся усилием, которое будет всегда отставать от того, что работает. Изменения делаются специальными, вещи, перемещенные или прекращенные или введенные в эксплуатацию наугад. Документация никогда не будет нагонять.
Необходимо продать людей, оплачивающих счета на значении проведения времени (и поэтому, деньги) при совершенствовании под управлением документации. Часто те переговоры идут как это: "помните, когда я должен был потратить $TIME, выясняющий, как $THING был поврежден? Хорошо, когда я был закончен, был этот $THING детализации технических замечаний, так, чтобы следующий парень, который придет, не должен был понимать все это".
Необходимо сделать это, даже при том, что Вы никогда не будете заканчивать.
Принцип № 2: единственной вещью, хуже, чем никакая документация, является неправильная документация
Это - больше трюизма, чем принцип. Документация может убаюкать Вас в ложное чувство, что что-то находится в известном состоянии и что, если что-то идет не так, как надо, у Вас может поэтому быть рабочий запуск при фиксации его.
Важно подтвердить эту проблему.
Принцип № 3: Вы пишете документацию для своего преемника
Разногласия составляют 95% из чего-либо, что Вы документируете Вас, никогда не должен будет относиться к снова. Документация является набором мудрости для будущего, не для Вас. Таким образом, необходимо предположить, что аудитория знает мало или ничто о специфических особенностях того, как вещами является путь, они.
И будет преемник. Я не знаю о Вас, но я не планирую быть в этих определенных средах для остальной части моей жизни. Возможности приходят и уходят, и когда они прибывают, иногда Вы идете. Но жизнь продолжается позади Вас, и чем более гладким можно сделать жизнь для преемника, тем лучше. Иначе у Вас мог бы быть набор бывших клиентов, которые бесшумно говорят незавидные вещи о Вас. Мне нравится говорить, что это - те же 50 парней, работающих везде в IT в Оттаве, потому что Вы продолжаете сталкиваться с ними везде. Помощь Вашему преемнику могла бы открыть двери для Вас в будущем.
Теперь до некоторой степени существует всегда степень "вины предыдущий парень", когда проблема подходит. Это - часть бизнеса. Я сделал это сам. Но несколько раз когда я уничтожал предыдущего парня как некоторого идиота, я узнал иначе, что он действительно имел свое действие вместе и знал больше о том, что продолжалось, чем я сделал в то время.
Принцип № 4: "Почему" часто более важно, чем "Как"
При рассмотрении системы большинство из нас начинает думать, думает как то, какого черта похож на это это? Существуют почти всегда очень определенные причины сделанного выбора конфигурации. При этих обстоятельствах, "Почему" диктует, "Как", и необходимо удостовериться, что читатель понимает, определенные проблемы, решаемые при исследовании курения, остаются решения.
Принцип № 5: Это должно быть легко, или Вы не сделаете этого
Это означает, что необходимо очень знать инструментах, а также тех, кто собирается использовать инструменты.
Совершенствование вещей должно быть легким. Если необходимо сделать какой-либо вид из усилия, то Вы найдете оправдания постараться не делать его, когда это будет лучше всего сделано, который сразу является после изменения.
Если Ваши инструменты не будут легки для других использовать, то они не будут использовать его. Это может особенно наносить вред в среде команды, начиная с большего команда добирается, более вероятно Вы встретитесь с членом команды, которому не нравится Ваш выбор инструментов.
Лично, мне нравится Wiki за документы. Однако проблема состоит в том, что Wiki не вызывает структуру на Вас, таким образом, структура должна быть наложена снаружи. Это всегда ведет для конфликта где-нибудь, поскольку у кого-то еще есть лучшая/отличавшаяся идея.
В некоторых местах я использовал Word и документы Visio, "опубликованные" к PDF, при этом "последний" PDF считали авторитетным. Это хорошо в этом, у Вас затем есть набор, который можно вручить работодателю/преемнику. PDFs, если правильно датированный, может обеспечить хронологическую запись того, что произошло, хотя тот, по которому не легко переместиться через. Это плохо в этом, я не люблю Word или Visio и был вынужден привести основное понимание в порядок этих инструментов для эффективного выражения мыслей.
Мой текущий работодатель играет с идеей документов Word на портале Sharepoint. Мы должны будем просто видеть, как далеко мы добираемся там
Конечно, необходимо заботиться. В конце концов, любое задание, которое стоит сделать, является заданием, которое стоит преуспеть.
1.) Это было уже сказано, но этому нужно повторение для повторения. Документ, документ, документ. Используйте электронные таблицы Excel, почтовую бумагу, иглу и пергамент, если Вы имеете к. Несколько тысяч ноутбуков меда как в фильме "Se7en" в случае необходимости. Так или иначе разметьте его ясный, краткий и легкий для чтения для того, кто бы ни оказывается перед необходимостью заменять Вас, когда Вы поражены метеором.
2.) После того как Вы начали документировать все, необходимо быть в настроении записи. Время для запуска параллельного проекта, детализирующего изменения последних нескольких лет, внесенные на серверах. Начните создавать процесс управления изменениями, но пройдите его исторически. Удостоверьтесь, что Вы отмечаете, как часто Вы изменили те диски на некоторых из тех привередливых серверов. Какого количества они стоят и т.д. Они предоставляют большие метрики Вам для доверия так или иначе, даже если тот метеор скучает по Вам и вынимает собаку соседа вместо этого.
3.) Реализуйте систему контроля, которая контролирует и почтовые критические отказы. Что то, что, Вы говорите? У Вас уже есть тот? Сладкий! Теперь зарегистрируйте его. Как это работает, что Вы контролируете, почему Вы контролируете его.
4.) У Вас есть обязанность взять его к Вашим типам управления снова. И снова, и снова. Так много раз, как Вы можете. Будьте вежливы. Будьте почтительны, но прибудьте, перенося, какова стоимость для бизнеса была бы, если бы тот метеор снизился и Вы исчезли.
Это не ответственность, которую можно сдуть, это - этическое требование задания и comisserate к позиции, которую Вы занимаете как общеизвестный 'хранитель и опекун ключей к королевству'.
Думайте о нем этот путь. Если можно избежать и забыть worriyng об этом и чувствовать хорошо выполнение этого, то, почему не Вы расчесывающий учет fileshares, чтобы зарплаты компании видели, какой и сколько еще те типы управления делают, чем Вы. Почему Вы не использующий конфиденциальные корпоративные данные для Вашего собственного использования? Почему Вы не читающий электронную почту людей?
Проще говоря, (и надо надеяться) Вы не делаете этих вещей из-за хорошего твердого смысла нравов и этики. Вы знаете, целое право от неправильного вида вещи. Таким образом следует, если у Вас есть это, затем Вы знаете, что это - ясно Ваша обязанность зарегистрировать и подготовить контрмеры против сценария худшего случая.
То существо, Ваше непрерывное работой и расслабляющее прохождение отпуска в Гавайи.:)
(Без метеора, который является.)
Если Вы хотите понизить кривую обучения для своей замены, лучшая вещь, которую можно сделать, состоит в том, чтобы описать документацию набора и процессов. Возможно самый легкий способ сделать, который должен настроить систему Wiki где-нибудь и просто продолжать добавлять к ней. Часть его станет устаревшей, но что не, будет неоценимо.
Много сообщений выше оценки важности документации являются пятном на, но существует еще один аспект к тому, чтобы быть "парнем" на работе, которую Вы хотите высматривать.
Если Вы - единственный человек, который знает, как управлять всем, отпуска/рождения/чрезвычайные ситуации трудно обработать, и Вы никогда не можете продвигаться или изучать другие положения в компании (если это интересует Вас). Если Вы не можете вырастить и изучить и развернуть Ваши навыки, можно закончить в положении по линии, где Вы ищете задание, и Ваше резюме показывает, что Вы провели 10 лет как КОБОЛ/программиста Fortran или OS\2/Novell/NT администратора.
Рост и универсальный тренинг важны для разработки как системный администратор. Вместо того, чтобы быть "парнем", что целая сеть зависит от, быть "парнем", который всегда готов показать новому парню, что сделать и кто всегда интересуется получением дополнительной информации о бизнесе.
Ключ здесь детализирован и подробная документация. Это - что-то, что очень важно не только в случае, если Вы выведены из строя, но и если они сделали, чтобы младший человек вошел, и Вы хотите поехать в отпуск (или движение к более зеленым пастбищам). Наличие надлежащих документов и ссылок может быть очень полезно для кого-то еще для подхождения к скорости в сети.
Я принял это положение (Администратор Sys / Ведущий Dev) от парня, у которого был его собственный особенный метод выполнения всего. Эти 17 серверов, которые мы имеем, все настраиваются немного отличающиеся. Существует столько процедур и ручной обработки проблем здесь, и едва любая из нее была зарегистрирована (документация в значительной степени включала однострочное объяснение каждого сервера и его роли). Это заставило меня переоценить много процессов в офисе. Каждый раз я изучаю что-то, ее добавленное к Wiki. Я также делегирую некоторую работу сервера к другому devs, таким образом, они могут, по крайней мере, узнать минимальную информацию о небольших заданиях.
Запись документации сосет, но думайте, на что она была бы похожа для входа в положение ни с кем.
Документация является огромным соглашением. Где я в, у меня есть противоположная проблема как у Вас действительно, мы недавно вставляем новую систему POS/ОТСЛЕЖИВАНИЯ ЗАКАЗОВ (мы - гравюра и компания по продвижениям), и я, имеют проблему того, чтобы заставлять людей записать в системе информацию о настройке. Люди главным образом низкого уровня, поскольку менеджер сделает это к ее заказам, потому что она раньше делала это ко всем заказам, помещая его в ОЧЕНЬ СТАРУЮ базу данных доступа. Я так хочу пойти безбумажный, и это совершенно возможно в нашем бизнесе, но я просто не могу заставить людей вводить информацию о заказе на работу, черт возьми.
Так, продолжайте корпеть при получении разрешения. Или если Вы чувствуете себя прекрасно, сделайте это в свободное время. Это могла бы быть хорошая вещь для Вашего будущего в компании, не говоря уже о Вашем преемнике.
ре: я должен заботиться?
Если Ваш офис не на 100% дисфункционален, люди собираются заметить, что Вы заставляете вещи работать более гладко. То, что Вы заботитесь о благополучии компании и не просто привязке Вашего 'indispensibility'. Компания, которая никогда полагается на Вас не уезжающий / никогда получение лучшего предложения, не функционирует очень хорошо. Это - чей-то JOB, чтобы заметить удержание в такой вещи от компании.
Я лично ЛЮБЛЮ работать с людьми, которые документируют и хотят работу, они закончили стоять самостоятельно и не постоянно требовать их участия. Когда Вы документируете и помещаете вещи, Вы уже сделали позади Вас, Вы открываете больше времени для работы над будущими проектами.
У нас есть в основном та же ситуация. Вот почему директор нанял меня для добавления еще одного узла знания.
Но честно, это не Ваше место для заботы. Это - бизнес управления, чтобы оценить риски и обратиться к ним.
Я нашел, что Добивающийся цели подход помогает преобладать над начальным умственным барьером, препятствующим тому, чтобы Вы документировали Вашу работу правильно. Вместо того, чтобы думать о документации как о монолитной задаче, которая будет препятствовать тому, чтобы Вы делали "реальную" работу, подразделите ее на крохотные блоки. Каждый раз, когда Вы натыкаетесь на лакомый кусочек информации, которую Ваш преемник должен знать, записать его. Затем зарезервируйте час или два каждую неделю, чтобы рассмотреть, разъяснить и категоризировать Ваше знание.
Не документировать. Не делитесь знаниями с другими. Путем документирования вещей Вы делаете себя менее ценными. Вам заплатят меньше. Ваша премия будет меньше. Ваша обеспеченность работой будет уменьшена. Почему Вы сделали бы это?
Надлежащий баланс - то, где Вы не становитесь взволнованными излишне во время сна или отпуска. Иначе Вы обесцениваете себя.