authoring-documentation

authoring-documentation is a skill for Claude Code, Codex from NVIDIA/elements. It costs 109 tokens per session (863 once invoked), scanned A, original, Apache-2.0.

Documentation-writing guidance for Markdown files, Eleventy templates, shortcodes, JSDoc comments, and frontmatter. Eleventy is a tool that turns templates and content into a documentation website.

In plain words
What is it for?
Use it when creating or editing documentation, API guides, internal guidelines, Eleventy content, JSDoc annotations, or Vale lint fixes.
Why use it?
It helps documentation meet the site's structure, formatting, cross-reference, and prose-linting requirements.

Skill for Claude CodeCodex ✓ vendor

Written for no agent in particular: nothing here depends on one. Also seen: installed under .agents/ (shared by several agents).

Good fit Use it when creating or editing documentation, API guides, internal guidelines, Eleventy content, JSDoc annotations, or Vale lint fixes.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/nvidia/elements/authoring-documentation
About the project

NVIDIA Elements is a design system and agent-oriented toolkit for building operational interfaces for AI/ML, robotics, and autonomous-vehicle software. Its CLI and MCP tools provide component APIs, design tokens, examples, imports, validation, and setup guidance across several web frameworks.

NVIDIA/elements · 102 stars · on GitHub · nvidia.github.io

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 NVIDIA/elements --skill authoring-documentation
Clone the repo
git clone --depth 1 https://github.com/NVIDIA/elements

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 authoring-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/nvidia/elements/authoring-documentation/github.svg)](https://agentmods.dev/skills/nvidia/elements/authoring-documentation)
Your own site
<a href="https://agentmods.dev/skills/nvidia/elements/authoring-documentation"><img src="https://agentmods.dev/badge/skills/nvidia/elements/authoring-documentation/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.

agentmods 80×15 button for authoring-documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/nvidia/elements/authoring-documentation"><img src="https://agentmods.dev/badge/skills/nvidia/elements/authoring-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 109 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 863 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. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.1 $0.00109 $0.00863
Opus 5.5 $0.00044 $0.00345
Sonnet 5.5 $0.00022 $0.00173
Haiku 4.5 $0.00011 $0.00086

Measured 1mo ago against content hash 552ad6fcfe25, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

authoring-documentation 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 1mo 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.

.agents/skills/authoring-documentation/SKILL.md · 75 lines

How it starts

The opening of the file, as written. The whole thing — 75 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation (*.md)

You MUST review @projects/site/src/docs/internal/guidelines/documentation.md before making any documentation changes.

When to Use This Skill

  • Creating or updating markdown documentation files
  • Working with 11ty templates in the documentation site
  • Using or creating Eleventy shortcodes
  • Writing API documentation or component guides
  • Updating internal guidelines or developer documentation
  • Fixing Vale prose-linting errors in markdown or JSDoc

Key Principles

  1. Frontmatter Required: All documentation files must include proper frontmatter with title and layout
  2. Eleventy Shortcodes: Use built-in shortcodes for common patterns (code examples, callouts, etc.)
  3. Clear Structure: Use proper heading hierarchy and table of contents for long documents
  4. Code Examples: Include working code examples with proper syntax highlighting
  5. Cross-References: Link to related documentation and guidelines using proper paths

Prose Linting (Vale)

How Vale Runs

  • Pre-commit (via lint-staged): automatically lints staged non-test *.ts and *.md files
  • CI:runs as part of pnpm run ci
  • Manual:pnpm run lint:vale from the repo root (pass specific files as args to narrow scope)

Rule Sets by File Type

  • *.md:Vale, Google, write-good, Elements (full rule set)
  • *.ts:Vale, write-good, Elements (no Google rules or spelling checks to reduce noise on code identifiers)
  • *.examples.ts:same as *.ts plus three summary rules: SummaryStyle, SummaryActionable, SummaryGerund

Common Errors and Fixes

Rule Trigger Fix
Google.Latin e.g., i.e. Use "for example," "that is"
Google.Passive Passive voice Rewrite in active voice
Google.Quotes Punctuation outside quotes Move commas/periods inside quotation marks
Elements.Branding nvidia, Nvidia Always use NVIDIA
Elements.Terminology web component Use Web Component / Web Components
Vale.Spelling Unknown term Add the term to config/vale/styles/config/vocabularies/Elements/accept.txt
Elements.SummaryStyle Weak openers like "This example demonstrates" Lead with what the example does or when to use it

Read the full file on GitHub · 75 lines

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. 1mo ago First seen · 75 lines · 109 tokens per session scan A 552ad6fcfe25

Subscribe to this mod's changes

authoring-documentation is a skill published in the GitHub repository NVIDIA/elements (102 stars, last pushed today), licensed Apache-2.0. It adds 109 tokens to every session and 863 once invoked, about $0.0004 per session on Opus 5.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

vue-application-structure

Establishes or reviews the directory layout, component conventions, composable design, Pinia store structure, and Vue Router configuration for a Vue 3 TypeScript application. Invoked when the user asks to structure a Vue app, set up the project layout, or review Vue architecture.

soulcodex/agentic · 63 tokens

react-application-structure

Establishes or reviews the directory layout, feature boundaries, state design, routing approach, and data-fetching conventions for a React 18+ TypeScript application. Invoked when the user asks to structure a React app, set up a scalable architecture, or review React project organization.

soulcodex/agentic · 63 tokens

vue-component-design

Designs or reviews Vue 3 component APIs. Handles prop drilling decisions, applies compound component patterns with provide/inject, defines minimal public API surfaces with typed props/emits/slots, and enforces Vue 3.4+ composition conventions. Invoked when creating new components, refactoring existing ones, or…

soulcodex/agentic · 70 tokens

next-application-structure

Establishes or reviews directory layout, server/client boundaries, routing, data-fetching strategy, and testing structure for Next.js 14+ App Router TypeScript applications. Invoked when the user asks to structure a Next app, set App Router conventions, or review architecture for React parity.

soulcodex/agentic · 64 tokens

react-component-design

Designs or reviews React component APIs. Handles prop drilling decisions, composition patterns, controlled/uncontrolled contracts, and minimal public API surfaces for React 18+ TypeScript components. Invoked when creating new components, refactoring existing ones, or reviewing component contracts.

soulcodex/agentic · 56 tokens

beui

Pick and install beUI (@beui) animated React components through public MCP or the shadcn registry. Use when building motion UI, agent/chat interfaces, toasts, docks, bottom sheets, drawers, popovers, sliders, loaders, 404 pages, or any beui.dev component. Maps user intent to exact @beui install slugs instead of…

starc007/ui-components · 81 tokens