Идея писать документацию - хороша :) Но из опыта скажу - серьёзная документация требует организационного решения: - кто и когда должен писать какие разделы, - как его этому обучить и на это мотивировать, - кто и когда будет контролировать соответствие написанной документации реальности. Описания этого решения в тексте явно не хватает :)
Хороший комментарий! Мы решили эту проблему так: - собрали команду из людей, которые больше всего заинтересованы в расширении внутренней инфраструктуры - мы работаем как студия, поэтому для нас внутренние улучшения устроены как проект на заказ. Я выступаю в роли заказчика, а команда вместе с ПМом в роли исполнителей
Альтернатива этому - суперзнающий лид как на картинке. Вскоре его задолбают вопросами и он будет отвечать: "смотрите код". В результате разработчик будет делать задачу в два раза дольше, не зная нюансов.
Когда работаешь на проекте, где есть документация, то сразу понимаешь, что работа по её составлению была проделана не зря.
Но самое сложное в документации - не писать её, а поддерживать в актуальном состоянии.
Идея писать документацию - хороша :)
Но из опыта скажу - серьёзная документация требует организационного решения:
- кто и когда должен писать какие разделы,
- как его этому обучить и на это мотивировать,
- кто и когда будет контролировать соответствие написанной документации реальности.
Описания этого решения в тексте явно не хватает :)
Хороший комментарий! Мы решили эту проблему так:
- собрали команду из людей, которые больше всего заинтересованы в расширении внутренней инфраструктуры
- мы работаем как студия, поэтому для нас внутренние улучшения устроены как проект на заказ. Я выступаю в роли заказчика, а команда вместе с ПМом в роли исполнителей
Отличная статья! Интересно еще, почему вы используете только селф-хостед решения (для гита например)?
прикольно когда СЕО компании из поста задает вопрос в комментах)))
это намного более безопасно, плюс чтобы нам не пришлось в срочном порядке искать альтернативы, в случае "необычных" ситуаций)
Грамотный и систематический подход это здорово, но сколько уйдёт времени на создание всего этого?(ну точнее создании той же базы знаний)
Альтернатива этому - суперзнающий лид как на картинке. Вскоре его задолбают вопросами и он будет отвечать: "смотрите код". В результате разработчик будет делать задачу в два раза дольше, не зная нюансов.
Когда работаешь на проекте, где есть документация, то сразу понимаешь, что работа по её составлению была проделана не зря.
Но самое сложное в документации - не писать её, а поддерживать в актуальном состоянии.