EO
В случае с тайпскрипт, эта «документация» это типы, которые всегда проверяются компилятором.
В идеале, комбинировать TS и TSDoc, а в TSDoc делать код блоки с примерами пользования. Во время билда, так же запускать и эти примеры как часть тестов.
Тогда у вас будут и типы, и документация для пользователей, которая ещё и тесты в себе дополнительные несёт, что документация не устарела.
Мне очень нравится как это реализовано в Rust