Agent Skills
› grafana/skills
› k6-docs
k6-docs
GitHub用于在k6相关仓库中编写、审查文档及生成TypeScript类型定义，并验证示例代码可执行性的技能。
触发场景
用户要求撰写或编辑k6文档
用户要求审查k6发布说明
用户要求生成TypeScript类型定义
安装
npx skills add grafana/skills --skill k6-docs -g -y
SKILL.md
Frontmatter
{
"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
- Review documentation: follow references/workflows/review.md
Quick References
- Repository structure & feature type identification
- TypeScript patterns & troubleshooting
- Testing workflow with parallel subagents
- agent-browser command reference
- Troubleshooting guide
Critical Rules
- Never push automatically - always ask first
- Never chain commands with
&∨- run each command separately (prevents failures) - Only document user-facing features - not internal implementation
- Use
1.for every numbered list item (not1.,2.,3.) - Test every code example against k6@master before committing
- No
Co-Authored-By: Claudeor 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:
# 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)
# First check for local work: if this prints anything, stop and ask the user before switching branches
git status --porcelain
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.
版本历史
-
8fb72a5
当前 2026-11-02 18:44
修复agent-browser安装版本锁定问题，并在git checkout前增加本地变更检查以防止误操作。
- b583762 2026-07-06 00:36
