Как вы описываете внедрённые в проект технологии и решения?
Всем привет!
Подскажите, как вы сопровождаете доработки, внедрения и интеграции по проекту?
Пример: проведена интеграция, в ходе которой возник ряд технических нюансов, которые нужно учесть тем, кто будет поддерживать проект в дальнейшем (путь даже и вы, ваша команда).
Задача: чтобы вернувшись позже к интеграции для её доработки, развития или поиска неисправностей вами или другим разработчиком, была некая вводная, мимо которой, грубо говоря, — не пройти и без которой работа не будет полноценной (построение костылей, упущение из внимания важных деталей).
Помоему в мире Битрикс такое не принято. Сопровождать должно быть дорого. (юмор). У нас база знаний в Битрикс 24 туда пишем. В вики можно, но там оформлять сложнее. Гит тоже удобно, но коммиты надо развернуто расписывать, но если их много становится то тоже сложновато, но всё равно можно встать на модуль и посмотреть, что с ним делалось.
README.md в корне репозитория - и мимо не пройти. Ну, если проект на github, bitbucket etc.
//TODO: notice в конкретных местах кода. IDE цепляют такие метки и обращают на себя внимание
