Документация, которая не врёт
<p>С документацией к API есть две крайности, и обе плохие: написанная руками врёт через полгода, сгенерированная целиком стирает всё осмысленное, что в неё написали.</p><p>Я перестал выбирать между ними и поделил файл: структура принадлежит коду и синхронизируется без спроса, проза принадлежит человеку и не трогается никогда. Заодно оказалось, что документацию можно проверять как golden-файл, и что проверить нельзя прозу, а вот её отсутствие можно.</p> <a href="https://habr.com/ru/articles/1080460/?utm_source=habrahabr&utm_medium=rss&utm_campaign=1080460#habracut">Читать далее</a>