Автогенерация документации, попробуем обобщить
-
40 мин
При документировании любого проекта периодически возникают мысли: делаю избыточную работу, не успеваю за фичами, это еще рано документировать, работает же все не так. И рано или поздно приходит идея попробовать синхронизировать документацию с кодом, так чтобы она создавалась в автоматическом режиме или, как минимум, проверялись на соответствие.
Чтобы решения, связанные с автогенерацией документации были действительно эффективными нужно учитывать три вещи:
- Технологические подходы.
- Принципы организации совместной работы на стыки ролей, ограничения и как их преодолевать.
- Критерии оценки эффективности полученного решения.