К основному содержанию
скилл CX Codex

k6-docs — скилл для Claude Code: что делает и как установить

Скилл для составления и проверки документации k6, генерации типов TypeScript и подготовки заметок к релизу.

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add grafana/skills --skill k6-docs -a claude-code
Открыть на GitHub

Что делает k6-docs

Скилл координирует работу сразу в трёх репозиториях экосистемы: k6-DefinitelyTyped, k6-docs и основном k6. С его помощью агент пишет пользовательскую документацию, обновляет типы TypeScript и готовит списки изменений. Правила запрещают документировать внутреннее устройство инструментов: описываются только функции для конечных пользователей.

Перед фиксацией изменений каждый пример кода обязательно запускается на ветке master репозитория k6. Без локально склонированного репозитория k6 проверить примеры не удастся. Команды нельзя объединять через && или ;, агент обязан выполнять каждый шаг изолированно. Также запрещён автоматический git push без спроса и запрещено добавлять строки Co-Authored-By: Claude в историю коммитов.

Какие задачи решает

  • составить и отредактировать пользовательскую документацию по k6
  • сгенерировать определения типов TypeScript для k6-DefinitelyTyped
  • подготовить заметки к релизу и список изменений в репозитории k6
  • проверить примеры кода на актуальной ветке k6@master

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

  • Проверь документацию нового API в репозитории k6-docs
  • Сгенерируй типы TypeScript для нового модуля в k6-DefinitelyTyped
  • Подготовь release notes для k6 и запусти примеры кода на master

Как установить k6-docs

1Через Skills CLI (Vercel)

npx skills add grafana/skills --skill k6-docs -a claude-code

2Вручную: положить файлы

~/.claude/skills/k6-docs/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/k6-docs/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о k6-docs

Как установить k6-docs в Claude Code?

Выполните команду npx skills add grafana/skills --skill k6-docs -a claude-code в терминале.

Что делает скилл k6-docs?

Он помогает создавать и проверять документацию k6, генерировать типы TypeScript и составлять changelog. Каждый пример скрипта скилл проверяет запуском на ветке master.

Какие ограничения действуют при сохранении изменений?

Скилл запрещает отправлять код в удалённый репозиторий без подтверждения и блокирует добавление меток авторства искусственного интеллекта вроде Co-Authored-By: Claude.

Исходный текст

SKILL.md · Apache-2.0
---
name: k6-docs
license: Apache-2.0
description: Write or review k6 documentation across the three k6 repositories - k6-DefinitelyTyped (TypeScript types), k6-docs (user documentation), and k6 (release notes / changelog). Applies k6 doc style conventions, generates TypeScript type definitions, drafts release notes, and validates examples by running them against k6@master. Use when working on k6 documentation, the k6 changelog, the k6 release notes, k6 API reference, k6 TypeScript types, load testing docs, or when the user asks to write, edit, or review anything in the k6, k6-docs, or k6-DefinitelyTyped repos - even if they don't explicitly say "documentation".
---

# k6 Documentation

Document or review k6 features across three repositories: k6-DefinitelyTyped (TypeScript types), k6-docs (user documentation), and k6 (release notes).

## Workflow

Pick the workflow that matches the user's intent:

- **Write documentation:** follow [references/workflows/write.md](references/workflows/write.md)
- **Review documentation:** follow [references/workflows/review.md](references/workflows/review.md)

## Quick References

- [Repository structure & feature type identification](references/repository-structure.md)
- [TypeScript patterns & troubleshooting](references/typescript-patterns.md)
- [Testing workflow with parallel subagents](references/testing-workflow.md)
- [agent-browser command reference](references/agent-browser-reference.md)
- [Troubleshooting guide](references/troubleshooting.md)

## Critical Rules

- **Never push automatically** - always ask first
- **Never chain commands with `&&` or `;`** - run each command separately (prevents failures)
- **Only document user-facing features** - not internal implementation
- **Use `1.` for every numbered list item** (not `1.`, `2.`, `3.`)
- **Test every code example** against k6@master before committing
- **No `Co-Authored-By: Claude` or AI attribution** in commits

## Validating examples (always run before committing)

Every code example in k6 documentation **and release notes** must execute cleanly against `k6@master`. The minimum loop:

```bash
# 1. cd into the k6 repo (not k6-docs or k6-DefinitelyTyped)
cd ~/path/to/k6

# 2. Make sure you're on master at the latest commit (the contract is k6@master)
git checkout master
git pull

# 3. Run each example as a separate command (no &&)
go run . run /path/to/script.js
```

If the run fails: read the error, fix the example in the source (doc or release note), re-run. Do not commit a change whose example doesn't run clean against current `master`. For the full multi-example workflow with parallel subagents, see [references/testing-workflow.md](references/testing-workflow.md).

© grafana · Apache-2.0 · grafana/skills

Похожие скиллы

Всё по теме «Тексты и документация» →
performance-testing kindlmann Помогает настроить нагрузочные тесты k6 и замеры Core Web Vitals через Lighthouse CI, превращая бюджеты производительности в блокирующие проверки в пайплайне. CX Codex +1 1 100установок stress-testing aj-geddes Скилл для нагрузочного стресс-тестирования: помогает найти точку отказа, проверить автоскейлинг и восстановление после перегрузки. CX Codex +1 497установок load-test-builder patricio0312rev Собирает нагрузочные и стресс-тесты на k6, Artillery или autocannon и помогает встроить их в CI как проверку производительности. CX Codex +1 316установок qa-dashboard kindlmann Собирает дашборды и отчёты по тестам: Allure, Grafana, ReportPortal. Пригодится, когда результаты прогонов нужно показать команде или руководству. CX Codex +1 1 100установок convex-docs convex Проверяет установленную в проекте версию Convex и подтягивает актуальную документацию в markdown вместо устаревшего кода из памяти модели. CX Codex +1 36 100установок api-docs ruvnet Скилл собирает документацию по исходникам на TypeScript и JavaScript: находит публичные экспорты, разбирает JSDoc, дописывает недостающие комментарии и выдаёт OpenAPI 3.0 для HTTP-эндпоинтов. CX Codex +1 891установок

Из того же набора47

oncall-irm Помогает агенту настроить маршрутизацию алертов, дежурные ротации и жизненный цикл инцидентов в Grafana IRM / OnCall. CX Codex +1 4 200установок send-data Помогает настроить отправку метрик, логов, трейсов и профилей в Grafana Cloud. Пригодится при настройке Alloy, OTLP-экспортёров, Prometheus remote write и Helm-чартов. CX Codex +1 4 200установок fleet-management Скилл для управления парком коллекторов Grafana Alloy: один раз описать пайплайн, раскатать его на нужные коллекторы по атрибутам и без перезапуска. CX Codex +1 4 200установок cost-management Скилл разбирает счёт Grafana Cloud по командам и сервисам и подсказывает, как урезать метрики, логи и трейсы. CX Codex +1 4 200установок testing Настраивает проверки доступности, нагрузочные тесты k6 и наблюдаемость фронтенда через Grafana Cloud. Нужен перед релизом и для поиска сбоев. CX Codex +1 4 200установок cue-kind-definition Помогает описывать ресурсы приложения в CUE: схемы spec и status, версии, ограничения полей и кодогенерация через grafana-app-sdk. CX Codex +1 4 200установок reconciler-logic Помогает создавать реконсилеры и вотчеры для приложений на grafana-app-sdk. Настраивает цикл согласования, атомарные обновления статуса и фильтры ресурсов. CX Codex +1 4 200установок app-sdk-concepts Скилл помогает начинать разработку приложений для Grafana App Platform: выбрать режим, создать каркас и связать CUE-схемы с Go-логикой. CX Codex +1 4 200установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой