gen-docs

gen-docs is a skill for Claude Code from rockyflux/yq-workflow. It costs 58 tokens per session (824 once invoked), scanned A, a copy of gen-docs, MIT.

A documentation generator that examines a module's structure and creates README.md and DESIGN.md templates. It can extract items such as Python classes and functions, dependencies, languages, and directory structure.

In plain words
What is it for?
Use to create README and design-document skeletons, then fill in usage details, decisions, examples, and limitations.
Why use it?
It provides a consistent documentation starting point for new or undocumented modules.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Good fit Use to create README and design-document skeletons, then fill in usage details, decisions, examples, and limitations.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/rockyflux/yq-workflow/gen-docs
Install

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.

Any agent
npx skills add rockyflux/yq-workflow --skill gen-docs
Clone the repo
git clone --depth 1 https://github.com/rockyflux/yq-workflow

Made for: Claude Code.

Wrote 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.

agentmods badge for gen-docs

README.md
[![agentmods](https://agentmods.dev/badge/skills/rockyflux/yq-workflow/gen-docs.svg)](https://agentmods.dev/skills/rockyflux/yq-workflow/gen-docs)
Your own site
<a href="https://agentmods.dev/skills/rockyflux/yq-workflow/gen-docs"><img src="https://agentmods.dev/badge/skills/rockyflux/yq-workflow/gen-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 58 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 824 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin 100% copy Near-identical to another mod in the catalogue.
Token cost

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.

ModelPer sessionOnce invoked
Fable 5.1 $0.00058 $0.00824
Opus 5 $0.00029 $0.00412
Sonnet 5 $0.00012 $0.00165
Haiku 4.5 $0.00006 $0.00082

Measured 4d ago against content hash 0cbba7ebec8d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

gen-docs 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 4d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/doc_generator.js), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

Origin

This is a copy

100% identical to gen-docs — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

templates/skills/tools/gen-docs/SKILL.md · 117 lines

What it actually says

📝 造典关卡 · 文档生成器

核心原则

无文档不成模块
文档是模块的身份证
没有身份证的模块不允许上线

自动生成

运行文档生成脚本(跨平台):

# 在 skill 目录下运行
node scripts/doc_generator.js <模块路径>
node scripts/doc_generator.js <模块路径> --force  # 强制覆盖已存在的文档
node scripts/doc_generator.js <模块路径> --json   # JSON 输出

生成内容

README.md 骨架

自动生成的 README.md 包含:

  • 模块名称 — 从目录名提取
  • 描述 — 从代码文档字符串提取(如有)
  • 特性列表 — 待填充
  • 依赖 — 从 requirements.txt/pyproject.toml 提取
  • 使用方法 — 基础模板
  • API 概览 — 从代码提取类和函数列表
  • 目录结构 — 自动扫描生成

DESIGN.md 骨架

自动生成的 DESIGN.md 包含:

  • 设计概述 — 目标与非目标模板
  • 架构设计 — 架构图占位符
  • 核心组件 — 从代码提取类列表
  • 设计决策 — 决策记录表格模板
  • 技术选型 — 自动检测语言和依赖
  • 权衡取舍 — 已知限制和技术债务模板
  • 安全考量 — 威胁模型和安全措施模板
  • 变更历史 — 初始版本记录

智能分析

支持的语言

语言 分析能力
Python 类、函数、文档字符串、依赖
Go 目录结构、依赖
TypeScript 目录结构、依赖
Rust 目录结构、依赖
其他 基础目录结构

提取的信息

  • 模块名称(目录名)
  • 主要编程语言
  • 代码文件列表
  • 类和函数定义(Python)
  • 文档字符串(Python)
  • 依赖列表
  • 入口点文件

自动触发时机

场景 触发条件
新建模块 模块创建开始时
缺失文档 检测到模块缺少文档时

使用流程

1. 运行 doc_generator.js 生成骨架
2. 填充 TODO 标记的内容
3. 补充设计决策和理由
4. 添加使用示例
5. 运行 /verify-module 校验完整性

生成后检查清单

README.md

  • 填充模块描述
  • 补充特性列表
  • 添加使用示例
  • 确认依赖完整

DESIGN.md

  • 明确设计目标
  • 记录设计决策
  • 说明技术选型理由
  • 列出已知限制

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

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.

  1. 4d ago First seen · 117 lines · 58 tokens per session scan A 0cbba7ebec8d

Subscribe to this mod's changes

gen-docs is a skill published in the GitHub repository rockyflux/yq-workflow (2 stars, last pushed 3mo ago), licensed MIT. It adds 58 tokens to every session and 824 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to gen-docs, differing in 0 lines, and is treated as a copy.

Related

Other skills, from other repositories

orbit-notion

Open Orbit briefing skill — selected by the Orbit pipeline when Notion is the user's only connected connector, or when the user explicitly scopes their daily digest to Notion. Pulls the past 24 hours of document edits, comments, mentions, and database row changes from the user's authenticated Notion connection and…

nexu-io/open-design · 117 tokens

instrument-data-to-allotrope

Convert laboratory instrument output files (PDF, CSV, Excel, TXT) to Allotrope Simple Model (ASM) JSON format or flattened 2D CSV. Use this skill when scientists need to standardize instrument data for LIMS systems, data lakes, or downstream analysis. Supports auto-detection of instrument types. Outputs include full…

anthropics/knowledge-work-plugins · 123 tokens

baoyu-youtube-transcript

A tool for downloading the written captions, subtitles, chapter information, speaker labels, and cover image from a YouTube video using its URL or ID.

JimLiu/baoyu-skills · 107 tokens

feishu

Work with Feishu or Lark bots, docs, sheets, bitables, approval flows, and OpenAPI/MCP setup without hardcoding credentials.

Hmbown/CodeWhale · 33 tokens

read

Reads URLs and PDFs by fetching source content, defaulting to concise summaries for plain read requests and clean Markdown when asked to convert, save, quote, cite, or feed downstream work. Use when users ask in any language to read, fetch, check, summarize, quote, cite, convert, or save a URL or PDF. Not for local…

tw93/Waza · 78 tokens

overleaf-sync

A two-way connection between a local paper folder and Overleaf, a web-based LaTeX editor for writing research papers. It lets you move changes between the local files and the shared Overleaf project.

wanshuiyin/Auto-claude-code-research-in-sleep · 97 tokens