Vue-FAQ

Техническую документацию часто оформляют как отдельный репозиторий. Но сейчас удобней ее иметь в каждом проекте, чтобы генерить с помощью AI доку из контекста текущего репозитория.

Кроме монорепы, git submodules и других наворотов для решения этой задачи есть еще один - `ln -s`

Символьная ссылка на docs директорию в другие проекты не захламляет git, но тот же Cursor отлично видит её содержимое.

Параллельное составление актуальной документации полезно еще и тем, что IDE AI может использовать ее как часть контекста (не надо по 10 раз объяснять, как тут что работает)

Так же IDE AI можно научить при необходимости обновлять документацию после каждого рефакторинга

#ai #ide #documentation

👍4

www.tgoop.com/vuefaq/1265

852 viewsApr 14 at 07:03

Техническую документацию часто оформляют как отдельный репозиторий. Но сейчас удобней ее иметь в каждом проекте, чтобы генерить с помощью AI доку из контекста текущего репозитория.

Кроме монорепы, git submodules и других наворотов для решения этой задачи есть еще один - `ln -s`

Символьная ссылка на docs директорию в другие проекты не захламляет git, но тот же Cursor отлично видит её содержимое.

Параллельное составление актуальной документации полезно еще и тем, что IDE AI может использовать ее как часть контекста (не надо по 10 раз объяснять, как тут что работает)

Так же IDE AI можно научить при необходимости обновлять документацию после каждого рефакторинга

#ai #ide #documentation

BY Vue-FAQ