Статьи с меткой: CI/CD
Относитесь к документации как к сборочному артефакту: проверяйте структуру, ссылки, примеры и правила публикации до того, как изменения увидят читатели. CI не решит, полезно ли объяснение читателю, но способен отсеять множество предсказуемых дефектов до того, как на них потратит время человек.
Если модель может массово создавать и обновлять документацию, контроль должен масштабироваться вместе с ней. Ограничивайте входные данные, сохраняйте происхождение, валидируйте структуру и отделяйте генерацию от привилегированного шага публикации.
Линтинг стиля полезен, когда ловит расползание терминологии, рискованные формулировки и повторяемые редакционные дефекты. Держите набор правил небольшим, объяснимым и достаточно тихим, чтобы авторы доверяли падению проверки. Линтер способен проверить тысячи предложений за секунды, поэтому хочется закодировать в нём каждое редакционное предпочтение.