Как формировать документацию в живом проекте?
Підписуйтеся на Telegram-канал «DOU #tech», щоб не пропустити нові технічні статті
Всем привет!
Хотел бы обсудить сложившуюся ситуация и как то определится с планом действий в этом направлении. Так что буду признателен за ваши советы, ваш интеллект и ваш опыт.
Постараюсь изложить все супер кратко и доходчиво, а уже в комментариях с заинтересованными лицами постараюсь по существу обсудить все более детальней.
Короче говоря — у нас есть проект Х который уже существует более 6 лет.
Он живой, на нем бегает около 200/300к пользователей и в нем идут постоянные доработки и развивается существующего функционал.
Есть большое желание проект Х переписать на новую архитектуру. Возможно даже улучшить или полностью переосмыслить/доработать ранее написаный функционал. Некоторые вещи уже были переписаны и даже живут как отдельные микросервисы.
Но существует проблема с документацией. Она как бы и есть, но проще сказать что её вовсе нет. По сколько в некоторых местах она просто устарела, а в других местах на каком то этапе перестала наполнятся. Можно сказать что ядро проекта хорошо документировано и поддерживается, но это только
Собственно, хотел бы услышать от вам советы, или получить рекомендации работы в этом направлении, возможно какие то best practice ссылочки может.
Лично мои мысли, а возможно в дальнейшем и действия в этом направлении — планирую поверх процесса разработки наложить модель работы с документацией таким образом, что бы если команда сталкивается с написанием нового функционала или доработкой старого, она сперва должна разобрать написаный код или отразить его в документации. Думаю что стоит рассматривать должность technical writer, но я не представляю как его интегрировать в команду, знания по проекту ему можно передавать месяцами. К тому же, хотелось бы интегрировать такого человека более менее безболезненно в плане продуктивности всей команды.
Ваши мысли/мнения/опыт/best practice по этому поводу?
21 коментар
Додати коментар Підписатись на коментаріВідписатись від коментарів