AIKraft/Skills/docs-write

docs-write

Пишет документацию в разговорном, понятном стиле Metabase. Подходит для создания или редактирования файлов (markdown, MDX).

MEMetabase official Документы ★ 49.6k

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

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

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

  • Создание новых файлов документации в форматах markdown или MDX
  • Редактирование существующих статей для упрощения языка и устранения формальностей
  • Проверка и исправление заголовков, ссылок и форматирования кода
  • Написание пошаговых инструкций с ясным разделением действий и объяснений

Как работает

  1. Определите целевую аудиторию и уровень сложности, чтобы не упрощать сложные темы и не усложнять простые
  2. Напишите черновик, начиная с действий (что делать), а затем объясняя причины, используя заголовки с конкретным смыслом
  3. Прочитайте текст вслух, чтобы убедиться в естественности звучания, и удалите всё, что не помогает читателю
  4. Проверьте примеры на работоспособность, используйте обратные кавычки только для кода, а жирный шрифт для элементов интерфейса
  5. Сделайте ссылки описательными, используйте американское написание и серийные запятые
  6. Запустите команду prettier для файла: bun run prettier --write <file-path>

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

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

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

  • Инструмент bun (для запуска prettier)
  • Файл метабаз-гайда по стилю (@./../_shared/metabase-style-guide.md)

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

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

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

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