Что еще автоматизировать

Поиск

Мы живем в мире нейронок, почему бы не скормить вашу документацию какой-нибудь нейронке и сделать так, чтобы стейкхолдеры вашей документации не сами изучали, серфили и искали ответы, а за них это делала нейронка.

Будьте осторожны! Если документация попадает под РИД (результаты интеллектуальной деятельности), то скорее всего скормить ее никому нельзя.

Если под РИД не попадает, то сделать своего агента можно с помощью DocsGPT. Потребуется собственный API-ключ для любой коммерческой модели ИИ или придется развернуть локальную опенсорсную модель Ollama или llama_cpp.

Обновление изображений

Одна из самых актуальных, но нерешенных автором задач — автоматическое поддержание актуальности изображений в документации.

Например, у нас есть в документации изображение какого-нибудь экрана, который собран из некоторого набора компонентов: шапки, инпутов, кнопок и прочего. А теперь представим, что в дизайн-системе сколько-нибудь меняется компонент шапки и это влияет на его визуальное представление, в этот момент все экраны в документации, на которых встречается шапка становятся неактуальными.

Нужно автоматизировать процесс пересборки всех экранов в документации, которые используют компонент шапки.

Front matter

Если вы внедрили у себя использование Front matter, то можно автоматизировать проверку структуры и содержания: