authoring-documentation

Guidelines for writing documentation files including 11ty templates, Eleventy shortcodes, JSDoc annotations, and markdown content. Use this skill whenever the user works with documentation markdown files, Vale prose linting errors, Eleventy shortcodes (dodont, example), frontmatter, JSDoc annotations that must pass Vale, or the documentation site. Also trigger when the user mentions Vale errors, adding terms to the vocabulary, suppressing Vale rules, or writing and fixing prose in .md or .ts files.

Ir para a instalação Revisar arquivos

Repositório: NVIDIA/elements
Última atividade na origem: 13 de agosto de 2026 às 13:59
Idioma detectado do SKILL.md: inglês
Estrelas: 102
Forks: 19

Opções de instalação

Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.

Instalar com um assistente de IA

Copie este prompt para o assistente de IA que você usa.

Follow https://skillsmp.com/skill-install/prompt.md to install only the Agent Skill at https://github.com/NVIDIA/elements/tree/main/.agents/skills/authoring-documentation.

Um comando direto ignora o prompt de revisão. Verifique a origem antes de executá-lo.

npx skills add https://github.com/NVIDIA/elements --skill authoring-documentation

O comando permanece em uma só linha. Role horizontalmente para revisá-lo antes de copiar.

Prefere uma cópia local? Baixe os arquivos disponíveis atualmente no SkillsMP.

Revise os arquivos de origem

Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.

SKILL.md

Instruções da origem · Visualização somente leitura

name: authoring-documentation
description: Guidelines for writing documentation files including 11ty templates, Eleventy shortcodes, JSDoc annotations, and markdown content. Use this skill whenever the user works with documentation markdown files, Vale prose linting errors, Eleventy shortcodes (dodont, example), frontmatter, JSDoc annotations that must pass Vale, or the documentation site. Also trigger when the user mentions Vale errors, adding terms to the vocabulary, suppressing Vale rules, or writing and fixing prose in .md or .ts files.

# 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 | ### Suppressing Rules Use sparingly, and re-enable immediately after the affected content: ```markdown  content here  ``` ### Key Files - `.vale.ini`:root config (rule toggles, file-type scopes, token ignores) - `config/vale/styles/Elements/`:custom rules (Branding, Terminology, Summary\*) - `config/vale/styles/config/vocabularies/Elements/accept.txt`:approved vocabulary ## References - [Documentation Guidelines](/projects/site/src/docs/internal/guidelines/documentation.md) - [Examples Guidelines](/projects/site/src/docs/internal/guidelines/examples.md) - [Vale Config](/.vale.ini) - [Custom Vale Rules](/config/vale/styles/Elements/)

Ver no GitHub

Voltar à pesquisa Voltar à instalação

elements

Use this skill by default for any UI-related work or with NVIDIA Elements (nve-*), including creating, editing, reviewing, or debugging HTML, CSS, layout, theming, components, applications, prototypes, Claude Artifacts, Codex Sites pages, and standalone UI artifacts.

2026-10-15

audit-consolidation

Audit an Elements project or directory for one concept implemented or owned in more than one place, including duplicate or parallel implementations that should share one internal module, related code scattered across feature directories, and older paths made redundant by newer ones. Use when the user asks for a consolidation or architecture cleanup audit, asks whether two components or utilities do the same thing, says a change keeps needing coordinated edits in more than one place, wants shared implementation candidates, or wants a plan to reduce maintenance complexity. Do not use for reviewing a diff or staged changes (use audit-code) or for removing copy-pasted text only.

2026-10-06

audit-simplification

Audit an Elements project, directory, or component for mechanisms that may not need to exist, including redundant state, attribute reflection, forwarding indirection, lifecycle plumbing, per-instance allocations, and custom synchronization that duplicates browser or Lit behavior. Use when the user says code feels over-engineered or heavier than it should be, asks whether a controller, field, service, or reflected attribute is necessary, or wants to reduce runtime overhead, memory, or boilerplate. Do not use for reviewing a diff or staged changes (use audit-code) or for deciding where duplicate code should live (use audit-consolidation).

2026-10-06

Ver todas deste repositório

authoring-documentation

Informações da origem

Opções de instalação

Instalar com um assistente de IA

Revise os arquivos de origem

Mais deste repositório

Instalar com um assistente de IA

Mais deste repositório