Я — главный инженер-программист в компании Swimm. Стартап, создающий инструмент документирования для разработчиков на основе парадигмы непрерывного документирования.
Что такое непрерывная документация
«Непрерывное документирование — это процесс создания и обновления документации постепенно и в рамках рабочего процесса разработки, обеспечивающий ее синхронизацию с кодовой базой».
Автор — который, как оказалось, является моим хорошим другом — утверждает 3 основных принципа.
Непрерывная документация означает, что документация является:
- Связана с кодом
- Всегда актуальна
- Создана тогда, когда лучше всего
Звучит хорошо в теории, верно?
Но как это работает на практике?
Один из способов — через Git Checks
Swimm автоматически проверяет любую документацию, размещенную на git, чтобы убедиться в ее актуальности. Если код, упомянутый в вашей документации, изменился, Swimm предупредит вас и позволит быстро и легко решить проблему. Таким образом, и ваш код, и ваша документация всегда точны и актуальны.
Я приглашаю вас ознакомиться с Swimm и присоединиться к нашей бесплатной открытой бета-версии. Я буду рад пообщаться с любым представителем сообщества dev.to, чтобы показать им различные варианты использования Swimm — как для команд, так и для отдельных пользователей.