AIKraft/Skills/writing-docs

writing-docs

Помогает писать и редактировать документацию Remotion. Используйте при создании страниц документации, редактировании MDX-файлов в packages/docs или написании текстов для документации.

RERemotion official Документы ★ 61.9k

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

Навык помогает писать и редактировать документацию Remotion в формате MDX, обеспечивая соблюдение технических и языковых стандартов. Он решает задачу создания согласованных, точных и легко читаемых страниц API и руководств для разработчиков.

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

  • Создание новой страницы документации для функции или компонента Remotion
  • Редактирование существующих MDX-файлов в packages/docs для исправления форматирования или стиля
  • Аудит и оптимизация существующей документации на предмет соответствия гайдлайнам
  • Добавление новой записи в боковую панель навигации (sidebars.ts)

Как работает

  1. Создать новый .mdx файл в packages/docs/docs и добавить ссылку на него в packages/docs/sidebars.ts с учетом существующего порядка сортировки
  2. Написать текст, используя обращение на 'you', избегая эмоциональных фраз и жирного выделения терминов
  3. Оформить названия API: функции и хуки в backticks с круглыми скобками (), компоненты в угловых скобках < >
  4. Для описания параметров использовать заголовки (### или ####), добавляя знак ? для опциональных параметров и <AvailableFrom> для указания версии
  5. Добавить секцию ## Compatibility с компонентом <CompatibilityTable> перед секцией ## See also
  6. Запустить команду bun render-cards.ts в packages/docs для генерации превью карточек

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

Напиши документацию для новой функции getVideoInfo() в отдельном MDX-файле, следуя гайдлайнам по форматированию API
Отредактируй страницу документации для компонента <Player>, добавив секцию совместимости и указав версию появления
Проверь документацию пакета @remotion/my-package на наличие отсутствующих индикаторов версий <AvailableFrom> и исправь форматирование названий функций

Что понадобится

  • Среда выполнения Node.js с пакетным менеджером bun
  • Доступ к репозиторию Remotion с папкой packages/docs
  • Команда bun render-cards.ts для генерации превью

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

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

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

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