AIKraft/AI/Войти
AIKraft/Skills/Описание дизайна

Описание дизайна

Research a codebase and create architectural documentation describing how features or systems work. Use when the user asks to: (1) Document how a feature works, (2) Create an architecture overview, (3) Explain code structure for onboarding or knowledge transfer, (4) Research and describe a system's design. Produces markdown documents with Mermaid diagrams and stable code references suitable for hu

posit-dev official Дизайн

Что делает навык

Исследует кодовую базу и создает архитектурную документацию в формате Markdown, описывающую работу функций или систем. Документация ориентирована на людей и ИИ-агентов, содержит диаграммы Mermaid и стабильные ссылки на код.

Когда применять

  • Описание того, как работает конкретная функция
  • Создание обзора архитектуры системы
  • Объяснение структуры кода для онбординга или передачи знаний
  • Исследование и описание дизайна системы

Как работает

  1. Определить область исследования: уточнить у пользователя, какой компонент документировать, целевую аудиторию и расположение кодовой базы
  2. Провести первоначальный обзор: изучить структуру директорий, README, конфигурационные файлы и выявить ключевые модулы, затем согласовать план с пользователем
  3. Провести глубокое исследование: проследить пути выполнения кода, выявить зависимости, взаимодействия компонентов, опции конфигурации и места хранения данных
  4. Составить черновик документа по шаблону, включающему обзор, диаграмму Mermaid, описание компонентов, поток данных, конфигурацию и ссылки на код
  5. Утвердить место сохранения файла с пользователем и записать финальную документацию

Примеры запросов агенту

Опиши, как работает функция аутентификации в этом проекте
Создай обзор архитектуры модуля обработки платежей
Объясни структуру кода сервиса уведомлений для передачи знаний новому разработчику

Описание составлено по SKILL.md навыка, сверено 05.10.2026.

Как подключить

1Скачать навык
# возьмите папку навыка «describe-design» из репозитория: # https://github.com/posit-dev/skills
2Положить папку с SKILL.md к навыкам ассистента
# положите папку навыка туда, где ассистент ищет skills: cp -r describe-design/ ~/.claude/skills/describe-design/

Навык — папка с файлом SKILL.md (описание + инструкции) и опциональными скриптами. Ассистент (Claude, Claude Code и совместимые) подхватывает его по описанию и следует шагам.