module-docs

module-docs is a skill for Claude Code, Codex from sean-galloway/RTLDesignSherpa. It costs 88 tokens per session (456 once invoked), scanned A, original, MIT.

A documentation workflow for writing one reference page for each RTL hardware module. RTL, or register-transfer level code, describes how digital hardware moves and processes signals.

In plain words
What is it for?
Use it when adding or changing an RTL block, documenting its ports, parameters, architecture, timing, data model, and tests.
Why use it?
It keeps module documentation, source-code headers, and the generated documentation index aligned as interfaces change.

Skill for Claude CodeCodex

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.

agentmods
npx agentmods add skills/sean-galloway/rtldesignsherpa/module-docs
Any agent
npx skills add sean-galloway/RTLDesignSherpa --skill module-docs
Clone the repo
git clone --depth 1 https://github.com/sean-galloway/RTLDesignSherpa

Made for: Claude Code, Codex.

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 module-docs

README.md
[![agentmods](https://agentmods.dev/badge/skills/sean-galloway/rtldesignsherpa/module-docs.svg)](https://agentmods.dev/skills/sean-galloway/rtldesignsherpa/module-docs)
Your own site
<a href="https://agentmods.dev/skills/sean-galloway/rtldesignsherpa/module-docs"><img src="https://agentmods.dev/badge/skills/sean-galloway/rtldesignsherpa/module-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 88 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 456 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found 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 $0.00088 $0.00456
Opus 5 $0.00044 $0.00228
Sonnet 5 $0.00018 $0.00091
Haiku 4.5 $0.00009 $0.00046

Measured 5d ago against content hash e377904c94e1, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

module-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 5d 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.

.claude/skills/module-docs/SKILL.md · 29 lines

What it actually says

module-docs

READ FIRST: vault/handbook/INDEX.md (the handbook is the repo's memory; this skill is the signpost). Canonical: vault/handbook/authoring/module-doc-template.md - the section structure every per-module page follows, plus the SV header block that mirrors it.

The rules that get violated most:

  • One source per fact. A port list / parameter table stated in both the .sv and the .md rots. State it once; when you change ports, update BOTH in the same commit (the .sv header and the .md interface block).
  • Follow an existing sibling. New docs/markdown/rtl-amba/monitor/*.md pages copy the header table and section order of a peer (e.g. monbus_compressor.md), not a blank template.
  • Keep the book index in sync. A new page MUST be linked from its _book_<area>_index.md (e.g. docs/markdown/rtl-amba/_book_monitor_index.md), or the generated PDF book never includes it.
  • No emojis in pipeline docs - they break the LaTeX/PDF path. See [[doc-pipeline]].
  • Placement rules (which .md lives where) are a separate concern - see the doc-placement skill / [[doc-placement]].

The handbook root is vault/handbook/INDEX.md - design/, dv/, fpga/, authoring/ areas, atomic notes, wikilinked. When you learn a durable lesson in this domain, ADD IT TO THE HANDBOOK NOTE ([[module-doc-template]]), not to this skill.

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. 5d ago First seen · 29 lines · 88 tokens per session scan A e377904c94e1

Subscribe to this mod's changes

module-docs is a skill published in the GitHub repository sean-galloway/RTLDesignSherpa (23 stars, last pushed today), licensed MIT. It adds 88 tokens to every session and 456 once invoked, about $0.0004 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-08-30.

Related

Other skills, from other repositories

vdoc

Aggregate all per-module documentation into a single comprehensive IP document.

phamcuong21478/rtl-skills · 14 tokens

datasheets

Extract structured specifications from electronic component datasheet PDFs — pinouts, electrical characteristics, peripherals, topology, and features. Cache extractions per project for consumption by schematic and PCB analyzers. Primary consumer infrastructure for kicad, emc, spice, and thermal analyzers. Use this…

aklofas/kicad-happy · 156 tokens

readable-verilog-generator

Use when creating, writing, reviewing, annotating, repairing, refactoring, or validating readable Verilog RTL, including synthesizable Verilog-2001 .v files, existing-RTL analysis, semantic comment annotation, testbench scaffold planning, ASIC-quality review, local or remote Vivado/xsim validation, evidence-backed…

Eriemon/verilog-generator · 77 tokens

003-skills-inventory

Use when you need to generate a checklist document with Java system prompts from skills.xml, following the embedded section template and producing INVENTORY-SKILLS-JAVA.md. This should trigger for requests such as Create Java system prompts checklist; Generate INVENTORY-SKILLS-JAVA.md; Use @003-skills-inventory…

jabrena/plinth · 88 tokens

001-commands-inventory

Use when you need to generate a checklist document with embedded commands inventory, following the embedded template exactly and producing INVENTORY-COMMANDS-JAVA.md in the project root. This should trigger for requests such as Create embedded commands inventory checklist; Generate INVENTORY-COMMANDS-JAVA.md; Use…

jabrena/plinth · 92 tokens

002-agents-inventory

Use when you need to generate a checklist document with embedded agents inventory, following the embedded template exactly and producing INVENTORY-AGENTS-JAVA.md in the project root. This should trigger for requests such as Create embedded agents inventory checklist; Generate INVENTORY-AGENTS-JAVA.md; Use…

jabrena/plinth · 90 tokens