Getting it into your agent
One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.
npx skills add rockyflux/yq-workflow --skill yq-doc-gengit clone --depth 1 https://github.com/rockyflux/yq-workflowWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/skills/rockyflux/yq-workflow/yq-doc-gen)<a href="https://agentmods.dev/skills/rockyflux/yq-workflow/yq-doc-gen"><img src="https://agentmods.dev/badge/skills/rockyflux/yq-workflow/yq-doc-gen/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/skills/rockyflux/yq-workflow/yq-doc-gen"><img src="https://agentmods.dev/badge/skills/rockyflux/yq-workflow/yq-doc-gen.svg" alt="Reviewed on agentmods" width="80" height="20"></a>What it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00036 | $0.01106 |
| Opus 5 | $0.00018 | $0.00553 |
| Sonnet 5 | $0.00007 | $0.00221 |
| Haiku 4.5 | $0.00004 | $0.00111 |
Grade A, and why
yq-doc-gen scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
What it actually says
📝 YQ 文档生成器
核心原则
无文档不交付
文档服务读者，不服务作者记忆
先给可执行骨架，再补业务细节
使用场景
- 用户要求生成 README、DESIGN、Runbook、发布说明、交付说明或变更记录
- 功能或模块已完成，需要把关键决策与影响面沉淀为可复用文档
- 需要为评审、测试、运维、接手开发提供上下文
- 需要把会话中的临时结论转化为长期可维护资产
路由到其他技能
- 主要目标是架构方案设计：转
yq-system-design - 主要目标是编码实现：转
yq-code-gen - 主要目标是发布分支、PR、提交整理：转
yq-git-helper - 主要目标是测试用例设计与补全：转
yq-test-gen
执行流程
- 明确文档类型、目标读者与使用场景（开发、评审、运维、交接）。
- 收集输入材料：实现变更、配置项、接口、依赖、测试与验证证据。
- 提炼关键信息：目标、边界、核心决策、影响范围、风险与回滚策略。
- 输出结构化骨架（先完整目录，再补内容），对未知项显式标注 TODO。
- 进行可用性检查：读者是否能“按文档完成任务”。
推荐输出模板
README 骨架
# <模块名>
## 概述
## 功能特性
## 快速开始
## 配置与依赖
## 使用示例
## API / 接口概览
## 目录结构
## 常见问题（可选）
DESIGN 骨架
# <模块名> 设计说明
## 设计目标与非目标
## 背景与约束
## 架构与核心流程
## 核心组件职责
## 关键设计决策（含取舍）
## 数据与接口模型
## 安全与稳定性考虑
## 测试与验证策略
## 已知限制与后续计划
## 变更历史
交付 / 运行文档骨架（可选）
# 交付说明 / Runbook
## 变更摘要
## 影响范围
## 部署与回滚步骤
## 验证步骤
## 监控与告警关注点
## 风险与应急预案
## 后续行动项
文档质量检查清单
- 读者与使用场景是否明确
- 是否给出可执行步骤（不是只有概念描述）
- 决策是否包含“为什么这样做”的理由
- 风险、限制与回滚策略是否完整
- 术语、命名、路径是否与代码一致
- TODO 项是否可追踪（责任人/条件/后续动作）
Related Skills
- 上游通常来自
yq-code-review、yq-security-scan、yq-dependency-check - 文档中若需要补充架构取舍，可回看
yq-system-design - 完成交付材料后通常接
yq-git-helper
Recommended Next Step
- 默认交给
yq-git-helper，把文档、验证结果和风险说明整理进提交或 PR 叙事 - 如果文档暴露出实现或配置缺口，回跳
yq-code-gen或yq-config-gen
常见问题
- 只记录“做了什么”，未说明“为什么做、影响什么”
- 复制会话内容，缺乏结构化沉淀
- 文档没有操作步骤，无法用于交接或应急
- 忽略边界条件与已知限制，导致后续误用
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 8d ago First seen · 131 lines · 36 tokens per session scan A 81029052f9c0
yq-doc-gen is a skill published in the GitHub repository rockyflux/yq-workflow (2 stars, last pushed yesterday), licensed MIT. It adds 36 tokens to every session and 1,106 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.
Other skills, from other repositories
systematic-debugging
Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.
local-ai-agents
Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…
next-cache-components-adoption
Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…
insight-error-page
Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…
next-cache-components-optimizer
Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…
next-partial-prefetching-adoption
Turn on Partial Prefetching in a Next.js app and work through the insights it surfaces. Use when the user wants to enable or adopt Partial Prefetching, flip the partialPrefetching flag, opt routes in with export const prefetch = 'partial', audit Link prefetch={true} behavior, preserve existing prefetched UI with…