Документируй все это.
Недавно на Slashdot была тема о запуске документации, которая вдохновила меня записать свои мысли о документации.
Моими ключевыми моментами были:
Принцип № 1: это никогда не делается
Документация - это постоянное усилие, которое всегда будет отставать от того, что находится в производстве. Изменения вносятся нерегулярно, вещи перемещаются, прекращаются или вводятся в эксплуатацию наугад. Документация никогда не догонит.
Вы должны продать людям, оплачивающим счета, стоимость потраченного времени (и, следовательно, денег) на поддержание текущей документации в актуальном состоянии. Часто эти разговоры звучат так: «помните, когда мне приходилось тратить $ TIME на выяснение того, как был сломан $ THING? Ну, когда я закончил, была эта техническая заметка с подробным описанием $ THING, так что следующий парень, который придет, не будет Я должен все это выяснить.
Вы должны сделать это, даже если вы никогда не закончите.
Принцип № 2: единственное, что хуже, чем отсутствие документации, является неправильной документацией
Это скорее трюизм, чем принцип. Документация может ввести вас в заблуждение о том, что что-то находится в известном состоянии, и что если что-то пойдет не так, вы можете начать исправление.
Важно признать эту проблему.
Принцип № 3: вы пишете документацию для вашего преемника
Вероятность того, что вы делаете документ, составляет 95%, и вам никогда не придется обращаться к нему снова. Документация - это собрание мудрости для будущего, а не для вас. Таким образом, вы должны предположить, что ваша аудитория мало или ничего не знает о специфике того, как вещи являются такими, какие они есть.
И будет преемник. Я не знаю о вас, но я не планирую находиться в этих конкретных условиях до конца своей жизни. Возможности приходят и уходят, и когда они приходят, иногда вы уходите. Но жизнь продолжается за тобой, и чем плавнее ты можешь сделать жизнь для своего преемника, тем лучше. В противном случае у вас может быть коллекция бывших клиентов, которые тихо говорят нелестные слова о вас. Мне нравится говорить, что в Оттаве везде работают одни и те же 50 парней, потому что вы постоянно сталкиваетесь с ними повсюду. Помощь вашему преемнику может открыть двери для вас в будущем.
Теперь в определенной степени всегда есть степень «обвинять предыдущего парня», когда возникают проблемы. Это часть бизнеса. Я сделал это сам. Но в нескольких случаях, когда я расценивал предыдущего парня как своего рода идиотку, я иначе узнал, что он действительно действовал вместе и знал о происходящем больше, чем я в то время.
Принцип № 4: «Почему» часто важнее, чем «Как»
Глядя на систему, большинство из нас начинает думать, думает, как, черт возьми, это так? Почти всегда есть очень конкретные причины для выбора конфигурации. В этих обстоятельствах «Почему» диктует «Как», и вы должны убедиться, что читатель понимает конкретные проблемы, решаемые при изучении коптильных остатков вашего решения.
Принцип № 5: это должно быть легко, иначе ты этого не сделаешь
Это означает, что вы должны быть очень осведомлены о ваших инструментах, а также о тех, кто собирается использовать ваши инструменты.
Вести вещи в актуальном состоянии должно быть легко. Если вам нужно приложить какие-либо усилия, то вы найдете оправдания, чтобы не делать это, когда это лучше всего сделать, то есть сразу после изменения.
Если другие пользователи не могут использовать ваши инструменты, они не будут ими пользоваться. Это может быть особенно вредным в командной среде, поскольку чем больше команда становится, тем больше вероятность того, что вы встретите члена команды, которому не нравится ваш выбор инструментов.
Лично мне нравится вики для документов. Однако проблема в том, что вики не навязывает вам какую-либо структуру, поэтому структура должна быть навязана извне. Это всегда приводит к конфликту где-то, так как у кого-то есть более или менее хорошая идея.
В некоторых местах я использовал документы Word и Visio, «опубликованные» в PDF, причем «последний» PDF считается авторитетным. Это хорошо, потому что у вас есть коллекция, которую вы можете передать своему работодателю / преемнику. Документы в формате PDF, если их правильно датировать, могут предоставить историческую запись о том, что произошло, хотя и такую, по которой нелегко ориентироваться. Плохо, что мне не нравятся Word или Visio, и я был вынужден получить базовое представление об этих инструментах для эффективной передачи идей.
Мой нынешний работодатель играет с идеей документов Word на портале Sharepoint. Нам просто нужно посмотреть, как далеко мы доберемся