Главная / Программирование и IT / Аудит дизайн-системы: сверка документации и кода

Аудит дизайн-системы: сверка документации и кода

Описание промпта

Инструмент для автоматического выявления расхождений между документацией CLAUDE.md и текущим состоянием кодовой базы. Помогает поддерживать актуальность дизайн-токенов, компонентов и правил.

Что делает этот промпт

Автоматизирует процесс аудита дизайн-системы, выявляя расхождения между технической документацией (CLAUDE.md) и реализацией в коде. Помогает поддерживать консистентность UI.

Преимущества

Экономит время на ручной проверке, предотвращает дрейф дизайн-токенов, обеспечивает актуальность документации для разработчиков и дизайнеров.

Для кого подходит

Frontend-разработчики, UI/UX дизайнеры, технические писатели, лиды команд, поддерживающие дизайн-системы.

Инструкция по использованию промпта

Вставь содержимое CLAUDE.md в поле {{CLAUDE_MD_CONTENT}} и укажи путь или загрузи файлы кодовой базы в {{CODEBASE_PATH_OR_FILES}}. AI проанализирует данные и вернет структурированный отчет.

Что нужно предоставить

Необходимо предоставить содержимое файла CLAUDE.md и доступ к кодовой базе (через путь или загруженные файлы).

Что ожидать в результате

Markdown-отчет со статистикой расхождений, списком критических действий и готовыми фрагментами кода для обновления документации.

Рекомендации

Для точности убедись, что CLAUDE.md соответствует последней версии дизайн-системы. При больших кодовых базах рекомендуется проверять модули по частям.

Ограничения

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

Переменные

CLAUDE_MD_CONTENT

Обязательная

Содержимое файла документации дизайн-системы CLAUDE.md

CODEBASE_PATH_OR_FILES

Обязательная

Путь к кодовой базе или содержимое файлов для анализа

Промпт открыт для всех. Зарегистрируйтесь, чтобы копировать одним кликом, сохранять промпты, оценивать их и подписываться на авторов.

Текст промпта

Claude Войти для копирования

Выступи в роли аудитора дизайн-системы, выполняющего проверку синхронизации документации и кода.

Твоя задача — сравнить текущую документацию CLAUDE.md с реальной кодовой базой и подготовить отчет о расхождениях (drift report).

## Вводные данные
- **CLAUDE.md:** {{CLAUDE_MD_CONTENT}}
- **Текущая кодовая база:** {{CODEBASE_PATH_OR_FILES}}

## Что проверить:

1. **Новые не задокументированные токены**
- Цвета в коде, отсутствующие в CLAUDE.md
- Значения отступов (spacing), используемые, но не определенные
- Новые размеры шрифтов или начертания

2. **Устаревшие токены, все еще в коде**
- Токены, помеченные как устаревшие, но используемые в коде
- Количество оставшихся ссылок на каждый устаревший токен

3. **Новые не задокументированные компоненты**
- Компоненты, созданные после последнего обновления CLAUDE.md
- Отсутствие в разделе библиотеки компонентов

4. **Измененные компоненты**
- Изменения в пропсах (добавлены/удалены/переименованы)
- Новые варианты, не описанные в документации
- Визуальные изменения (использование других токенов)

5. **Сломанные ссылки**
- Ссылки в CLAUDE.md на несуществующие токены
- Измененные пути к файлам
- Устаревшие пути импорта

6. **Нарушения конвенций**
- Код, нарушающий правила CLAUDE.md (inline-цвета, отсутствие состояний фокуса и т.д.)
- Количество и локация каждого типа нарушений

## Вывод
Создай отчет в формате Markdown, содержащий:
- **Сводная статистика:** количество новых токенов, устаревших токенов, измененных компонентов
- **Список действий**, приоритизированный по серьезности (критические → несоответствия → косметические)
- **Обновленные разделы CLAUDE.md**, готовые к копированию (только измененные части)

Аудит дизайн-системы: сверка документации и кода

Поделитесь в социальных сетях

Комментарии