Я обнаружил, что ЛЮБАЯ документация лучше, чем НЕТ документации. Соответствующая сумма обычно определяется количеством времени, которое мы должны сделать, или тем, насколько мы ненавидим телефонные звонки и электронные письма поддержки.
Похоже, что ваши нынешние члены команды имеют некоторые нереалистичные ожидания своих воспоминаний, или они стыдятся своих навыков письма и не хотят практиковать.
Я понимаю, что нахожусь в меньшинстве (майор английского, который начал заниматься разработкой программного обеспечения в аспирантуре) здесь, так как я не считаю документацию рутинной работой. Это ценный профессиональный инструмент. Возможно, мне не так сложно писать, как некоторым моим коллегам, но это в основном потому, что я больше занимаюсь этим. Я не считаю проект завершенным, если в нем нет документации, и обычно я пишу его по чисто эгоистичным причинам: чтобы я мог дать людям что-нибудь почитать вместо того, чтобы принимать телефонные звонки и электронные письма, или чтобы я мог вспомнить, о чем мы говорили в прошлый раз месяц или около того, я могу сослаться на то, как я что-то сделал, если мне нужно поддержать это посреди ночи.
Лучший способ приблизиться к документации - написать ее КАК ВАМ, точно так же, как писать тестовый код. Удивительно, как несколько предварительно написанных шаблонов (с заголовками, заглушками кода и т. Д.) Могут сделать документацию проще и быстрее. Таким образом, вы можете зафиксировать изменения, как они происходят, и у вас будет меньше возможностей для покрытия с течением времени. Таким образом, вы более эффективны, так как можете обращаться к документации по мере необходимости и вносить в нее изменения. Например, выполнение вики облегчает обновления, и вы можете избежать проблем с версией документа, если последние и лучшие версии всегда находятся в сети в одном и том же месте, и вы можете просто отправлять ссылки людям, которым необходимо их прочитать.
Если вы потратите немного времени на документирование, вы ВСЕ будете работать быстрее, особенно когда кто-то новый присоединится к команде, так как им не придется тратить все это время на выяснение всего. Выяснение вещей - это интересная часть нашей работы, но это не весело, когда нужно делать это в спешке, чтобы наладить производство. Мы бы сэкономили много времени, если бы написали еще пару заметок.
У вашей команды такие же проблемы с тестированием или написанием тестового кода? Если нет, это будет легче продать.
Ваша документация полезна во многих отношениях:
1) Для вас, прямо сейчас, и для ваших коллег, когда вы работаете над проектом.
2) Для ваших клиентов. Наличие документации (включая диаграммы), которую вы можете показать пользователям, облегчает обсуждение на собраниях, особенно если вы обсуждаете сложные системы. Даже если документация неполная, с нее нужно начинать.
3) Людям, которые унаследуют вашу работу (а может, и вам, через три года). Многие из моих младших сотрудников думают, что они будут помнить вещи навсегда. Я знаю, что не запомню этого на прошлой неделе, если не запишу. Наличие документации избавляет вас от необходимости тратить полдня на то, чтобы вспомнить, как вы что-то структурировали, и на то, чтобы снова все выяснить.
4) Для вас и других, если ситуация становится политической или спорным. Как человек, который делает записи на собраниях, чтобы не засыпать и бороться со скукой, я часто был единственным с письменной версией решения. Человек, который записал это, выигрывает спор. Вспомните это в следующий раз, когда кто-то скажет: «Помните ту встречу, которую мы провели прошлой зимой в конференц-зале 4, когда мы обсуждали Х? Фред был там, и кто этот парень из Бухгалтерии?»