关于 k6-docs
用于在 k6-DefinitelyTyped、k6-docs 和 k6 仓库中编写或审阅文档的 Skill，面向维护 k6 类型、用户文档和发行说明的工作。它提供分支工作流程、参考资料以及代码示例验证要求。
主要功能
- 01编写或审阅文档
- 02覆盖三个 k6 相关仓库
- 03提供工作流程与快速参考
- 04要求验证代码示例
- 05未经确认不自动推送
适用场景
- 01为 k6 编写用户文档
- 02审阅 k6 功能文档
- 03更新发行说明并验证示例
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/k6-docs确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
references/agent-browser-reference.mdrepository-structure.mdsubagent-prompts.mdtesting-workflow.mdtroubleshooting.mdtypescript-patterns.mdreferences/checklists/documentation.mdrelease-notes.mdtypescript.mdreferences/templates/documentation.mdrelease-notes.mdreferences/workflows/review.mdwrite.mdscripts/check_agent_browser.shfetch_pr.shfind_branch.shformat_typescript.shtest_typescript.shupdate_team_members.shvalidate_links.sh详细介绍
k6 文档
在三个代码仓库中编写或审阅 k6 功能相关文档：k6-DefinitelyTyped（TypeScript 类型）、k6-docs（用户文档）和 k6（发行说明）。
工作流
选择符合用户意图的工作流：
- **编写文档：**遵循 references/workflows/write.md
- **审阅文档：**遵循 references/workflows/review.md
快速参考
关键规则
- 绝不自动推送——务必先询问
- 绝不使用
&&或;链接命令——每条命令单独运行（避免失败） - 仅编写面向用户的功能文档——不要记录内部实现
- 所有编号列表项都使用
1.（不要使用1.、2.、3.） - 提交前，使用 k6@master 测试每个代码示例
- 提交中不得包含
Co-Authored-By: Claude或 AI 署名
验证示例（提交前务必执行）
k6 文档和发行说明中的每个代码示例都必须能在 k6@master 上顺利运行。最基本的流程：
# 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
如果运行失败：阅读错误信息，在源文件（文档或发行说明）中修复示例，然后重新运行。不要提交无法在当前 master 上顺利运行的示例。有关使用并行子 Agent 处理多个示例的完整工作流，请参阅 references/testing-workflow.md。
评论
支持 Markdown