Skill reference-docs
✓ VerificadoProporciona patrones y plantillas para escribir documentación técnica, de símbolos y de API que sea clara y fácil de escanear.
- Estrellas en GitHub
- 87
- Archivos
- 1
- Último commit
- 15 sept 2026
- Licencia
- Apache-2.0
- Herramientas permitidas
- —
¿Qué hace la skill reference-docs?
Proporciona patrones y plantillas para escribir documentación técnica, de símbolos y de API que sea clara y fácil de escanear.
Resumen generado a partir del SKILL.md de la skill.
Sobre la skill reference-docs
Los redactores técnicos y desarrolladores que necesiten crear documentación precisa y fácil de escanear para APIs, símbolos y especificaciones técnicas pueden usar este SKILL para mantener altos estándares de claridad. Proporciona plantillas estructuradas y patrones de escritura diseñados específicamente para usuarios experimentados que necesitan consultar detalles técnicos rápidamente en lugar de aprender un concepto nuevo.
Cuando un agente tenga la tarea de escribir material de referencia, debe cargar este SKILL junto con docs-style para asegurar que se cumplan los principios fundamentales de escritura. El SKILL genera contenido Markdown estructurado que incluye tablas de parámetros, descripciones de valores de retorno y ejemplos de código ejecutables. Se enfoca en describir el funcionamiento interno de un producto —como comandos, opciones y límites— sin desviarse hacia tutoriales o explicaciones. Al seguir las reglas establecidas, el resultado garantiza que cada ejemplo utilice valores realistas y que cada tabla contenga columnas consistentes para los campos obligatorios y opcionales.
Escrito a partir del SKILL.md de la skill. Cada caso de uso se verifica con una cita del mismo.
Cómo instalar la skill reference-docs
Cada comando copia la carpeta de la skill al directorio de skills del cliente. Reinicia el cliente o inicia una nueva sesión para cargarla.Instalar la skill reference-docs en Plugin
/plugin marketplace add existential-birds/beagle /plugin install beagle-docs@existential-birds
Instalar la skill reference-docs en Claude Code
~/.claude/skills/reference-docs/SKILL.md
$ npx degit existential-birds/beagle/plugins/beagle-docs/skills/reference-docs ~/.claude/skills/reference-docsInstalar la skill reference-docs en Claude Code (project)
.claude/skills/reference-docs/SKILL.md
$ npx degit existential-birds/beagle/plugins/beagle-docs/skills/reference-docs .claude/skills/reference-docsInstalar la skill reference-docs en Codex
~/.agents/skills/reference-docs/SKILL.md
$ npx degit existential-birds/beagle/plugins/beagle-docs/skills/reference-docs ~/.agents/skills/reference-docsInstalar la skill reference-docs en Gemini CLI
~/.gemini/skills/reference-docs/SKILL.md
$ npx degit existential-birds/beagle/plugins/beagle-docs/skills/reference-docs ~/.gemini/skills/reference-docsInstalar la skill reference-docs en Claude.ai
npx degit existential-birds/beagle/plugins/beagle-docs/skills/reference-docs reference-docs && zip -r reference-docs.zip reference-docs # claude.ai → Customize → Skills → + → Create skill → Upload a skill → reference-docs.zip
Verificaciones automáticas
Ejecutado 16 nov 2026Informe completo →Superó nuestras comprobaciones automáticas. No es una auditoría de seguridad: lee los scripts antes de dejar que un agente los ejecute. Cómo funcionan las verificaciones
- Repositorio de origen vinculado y accesibleexistential-birds/beagle/plugins/beagle-docs/skills/reference-docs is public and reachablegithub.com/existential-birds/beagle/tree/HEAD/plugins/beagle ↗Aprobado
- Licencia de código abierto (OSI)Apache-2.0spdx.org/licenses/Apache-2.0.html ↗Aprobado
- Commit o lanzamiento en el último añoLast commit 2026-09-15github.com/existential-birds/beagle/commits ↗Aprobado
- Sin descargar y ejecutar ni robo de credenciales en los scriptsNo scripts in the skill folderAprobado
- Sin instrucciones ocultas en SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/existential-birds/beagle/blob/HEAD/plugins/beagle ↗Aprobado
- Las herramientas preaprobadas están acotadasNo pre-approved tools; the agent asks before using onegithub.com/existential-birds/beagle/blob/HEAD/plugins/beagle ↗Aprobado
- SKILL.md sigue el formato de Agent SkillsValid name and description; says when to use it; 372 linesgithub.com/existential-birds/beagle/blob/HEAD/plugins/beagle ↗Aprobado
SKILL.md
Ver en GitHubReference Documentation Patterns
Reference documentation is information-oriented - helping experienced users find precise technical details quickly. This skill provides patterns for writing clear, scannable reference pages.
Dependency: Always use this skill in conjunction with docs-style for core writing principles. To confirm reference is the right type — rather than a tutorial, how-to, or explanation — see docs-style/references/diataxis-compass.md.
Purpose and Audience
- Who: Experienced users seeking specific information
- Goal: Quick lookup of technical details
- Mode: Not for learning, for looking up
- Expectation: Brevity, consistency, completeness
Document Structure Template
Use this template when creating reference documentation:
---
title: "[Symbol/API Name]"
description: "One-line description of what it does"
---
# [Name]
Brief description (1-2 sentences). State what it is and its primary purpose.
## Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| `param1` | `string` | Yes | What this parameter controls |
| `param2` | `number` | No | Optional behavior modification. Default: `10` |
## Returns
| Type | Description |
|------|-------------|
| `ReturnType` | What the function returns and when |
## Example
```language
import { symbolName } from 'package';
// Complete, runnable example showing common use case
const result = symbolName({
param1: 'realistic-value',
param2: 42
});
console.log(result);
// Expected output: { ... }
Related
- RelatedSymbol - Brief description
- AnotherSymbol - Brief description
## Writing Principles
### Describe, and Only Describe
Reference is austere, neutral, and authoritative — a map the reader can trust without independent verification. Its one job is to describe the machinery: commands, options, parameters, return values, limits, warnings. It does not instruct (that's How-To), teach (Tutorial), or argue (Explanation). When you feel the urge to explain *why* or walk the reader through a task, link out instead of inlining it; a digression interrupts and obscures the facts the reader came to consult.
### Structure Mirrors the Product
> "The structure of the documentation should mirror the structure of the product."
Organise reference so a reader can navigate the code and the docs in parallel — one reference entry per module, class, endpoint, or command, in the product's own order. Don't impose a narrative or thematic structure the product doesn't have; consistency of placement is what makes reference fast to consult.
### Brevity Over Explanation
- State facts, not rationale
- Avoid "why" - save that for Explanation docs
- Cut unnecessary words
**Do:**
```markdown
Returns the user's display name.
Avoid:
This function is useful when you need to get the user's display name
because it handles all the edge cases for you automatically.
Scannable Tables, Not Prose
Do:
| Name | Type | Description |
|------|------|-------------|
| `userId` | `string` | Unique user identifier |
| `options` | `Options` | Configuration object |
Avoid:
The first parameter is `userId`, which should be a string containing
the unique user identifier. The second parameter is `options`, which
is an Options object containing the configuration.
Consistent Format Across Entries
All reference pages for similar items should follow identical structure:
- Same heading order
- Same table columns
- Same code example format
- Same related links section
Every Example Must Be Runnable
- Include all imports
- Show complete, working code
- Use realistic values (not "foo", "bar", "test123")
- Include expected output when helpful
Code Example Patterns
Show Common Use Case First
## Example
### Basic Usage
```typescript
const user = await getUser('user-123');
console.log(user.name);
With Options
const user = await getUser('user-123', {
includeMetadata: true,
fields: ['name', 'email', 'role']
});
### Include Setup and Context
```markdown
```typescript
import { Client } from '@example/sdk';
// Initialize client (required once per application)
const client = new Client({ apiKey: process.env.API_KEY });
// Now use the function
const result = await client.users.list();
### Use Realistic Values
**Do:** `userId: 'usr_a1b2c3d4'`
**Avoid:** `userId: 'foo'`
**Do:** `email: 'jane.smith@company.com'`
**Avoid:** `email: 'test@test.com'`
## Parameter Documentation Patterns
### Required vs Optional
Clearly indicate which parameters are required:
```markdown
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `apiKey` | `string` | Yes | - | Your API key |
| `timeout` | `number` | No | `30000` | Request timeout in ms |
| `retries` | `number` | No | `3` | Number of retry attempts |
Complex Types
For object parameters, document the shape:
## Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| `options` | `UserOptions` | No | Configuration options |
### UserOptions
| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `includeDeleted` | `boolean` | No | Include soft-deleted users |
| `fields` | `string[]` | No | Fields to return |
| `limit` | `number` | No | Maximum results (default: 100) |
Enum Values
Document allowed values clearly:
| Name | Type | Values | Description |
|------|------|--------|-------------|
| `status` | `string` | `active`, `pending`, `suspended` | User account status |
Return Value Documentation
Simple Returns
## Returns
`User` - The requested user object, or `null` if not found.
Complex Returns
## Returns
| Property | Type | Description |
|----------|------|-------------|
| `data` | `User[]` | Array of user objects |
| `pagination` | `Pagination` | Pagination metadata |
| `total` | `number` | Total matching records |
Error Conditions
## Errors
| Error | Condition |
|-------|-----------|
| `NotFoundError` | User does not exist |
| `UnauthorizedError` | Invalid or expired API key |
| `RateLimitError` | Too many requests |
API Reference Specifics
HTTP Endpoints
## Endpoint
```http
GET /api/v1/users/{userId}
Path Parameters
| Name | Type | Description |
|---|---|---|
userId |
string |
The user's unique identifier |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
fields |
string |
No | Comma-separated list of fields |
Headers
| Name | Required | Description |
|---|---|---|
Authorization |
Yes | Bearer token |
X-Request-ID |
No | Request tracking ID |
Response
{
"id": "usr_a1b2c3d4",
"name": "Jane Smith",
"email": "jane@company.com"
}
## Component/Props Reference
For UI components:
```markdown
## Props
| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `variant` | `'primary' \| 'secondary'` | `'primary'` | Visual style |
| `size` | `'sm' \| 'md' \| 'lg'` | `'md'` | Button size |
| `disabled` | `boolean` | `false` | Disable interactions |
| `onClick` | `() => void` | - | Click handler |
## Slots
| Name | Description |
|------|-------------|
| `default` | Button content |
| `icon` | Icon to display before text |
Related Links Section
Always include links to related content:
## Related
- [createUser](/reference/create-user) - Create a new user
- [updateUser](/reference/update-user) - Modify user properties
- [deleteUser](/reference/delete-user) - Remove a user
- [User Authentication Guide](/guides/authentication) - How authentication works
Gates (completion order)
Use this sequenced workflow before treating a reference page as complete. Finish step n before n+1; each step has a Pass you can check on the written page alone (no “I verified internally”).
- Structure — Sections match your project template (typically Parameters, Returns, Example, Related; HTTP docs add Endpoint, Path/Query, Headers, Response). Pass: every required section exists, or a one-line omission note appears under Related (e.g. “No query parameters”).
- Tables — Parameters/returns/errors use tables with consistent columns per Consistent Format Across Entries and Required vs Optional. Pass: no blank Description cells; no
TBD/???for shipped APIs. - Runnable example — At least one example meets Every Example Must Be Runnable and Use Realistic Values. Pass: imports included; user-visible strings are realistic (not generic
foo/barunless the API is illustrative-only). - Related — Pass:
## Relatedcontains ≥1 Markdown link to another reference or guide, or one explicit sentence that there are no related symbols.
Checklist for Reference Pages
After the Gates (completion order) above, confirm:
- Title matches the symbol/API name exactly
- Description is one clear sentence
- All parameters documented with types
- Required vs optional clearly marked
- Default values specified for optional parameters
- Return type and structure documented
- At least one complete, runnable example
- Example uses realistic values
- Related pages linked
- Format matches other reference pages in the docs
When to Use Reference vs Other Doc Types
| User's mindset | Doc type | Example |
|---|---|---|
| "I want to learn" | Tutorial | "Build your first integration" |
| "I want to do X" | How-To | "How to configure SSO" |
| "I want to understand" | Explanation | "How our caching works" |
| "I need to look up Y" | Reference | "API endpoint reference" |
Reference and Explanation are the two cognition-oriented types and are easily confused: Reference states neutral facts to consult while working; Explanation discusses reasoning to read while reflecting. For the full compass procedure and distinctions, see docs-style/references/diataxis-compass.md.
Related Skills
- docs-style: Core writing conventions and components
- Diataxis compass: Type selection, the 2×2 map, and the quality model
- tutorial-docs: Tutorial patterns for learning-oriented content
- howto-docs: How-To guide patterns for task-oriented content
- explanation-docs: Conceptual documentation patterns
Archivos de esta skill
1Preguntas sobre la skill reference-docs
¿Cómo instalo la skill reference-docs en Claude Code?
Ejecuta npx degit existential-birds/beagle/plugins/beagle-docs/skills/reference-docs ~/.claude/skills/reference-docs. Claude Code carga las skills desde ~/.claude/skills (todos los proyectos) o .claude/skills (un proyecto) y usa una skill cuando su descripción coincide con la tarea.
¿Qué clientes pueden usar la skill reference-docs?
Cualquier cliente que lea el formato Agent Skills: Claude Code, Codex, Gemini CLI y claude.ai (subir como ZIP). Los scripts de la skill se ejecutan solo donde el cliente permite la ejecución de código.
¿Cuál es la diferencia entre la documentación de referencia y la de explicación?
La documentación de referencia expone hechos neutros para una consulta rápida durante el trabajo, mientras que la documentación de explicación analiza el razonamiento para una lectura reflexiva.