Plantillas de contenido de documentación

Copia y adapta plantillas MDX listas para usar: guías prácticas, tutoriales, explicaciones de conceptos y referencias de API en tu documentación.

Utiliza estas plantillas como punto de partida para crear documentación. Personaliza las plantillas para tu documentación y tu audiencia.

1. Copia la plantilla que se corresponda con tu tipo de contenido.
2. Reemplaza los marcadores de posición y el contenido de ejemplo con tu contenido real.
3. Ajusta las secciones según sea necesario.
4. Elimina las secciones que no sean relevantes.

¿No estás seguro de qué plantilla usar? Lee sobre tipos de contenido para comprender cuándo utilizar cada uno.

​

Plantilla de guía práctica

Usa guías prácticas cuando los usuarios necesiten llevar a cabo una tarea específica y ya tengan cierta familiaridad con tu producto. Las guías prácticas están orientadas al objetivo y van directamente a la solución.

How-to guide template

---
title: "[Titles should start with a verb]"
description: "[Do specific task] to [achieve outcome]."
---

Start with a brief statement of what this guide helps users accomplish.

## Prerequisites (optional)

List only what's necessary:

- Required setup or configuration
- Permissions needed
- Related features that should be configured first

## [Encabezado orientado a la acción que describe la tarea]

Proporcione instrucciones directas enfocadas en lograr el objetivo.

1. Abra [ubicación] y navegue a [lugar específico]
2. Haga clic en [botón u opción]
3. Ingrese [información requerida]
4. Haga clic en [botón de confirmación]

```language
// Include code examples that users can copy and modify
```

<Tip>
  Include practical tips that help users avoid common mistakes or work more efficiently.
</Tip>

## Verify the result (optional)

If success is ambiguous, explain how users can confirm they completed the task successfully.

## Troubleshooting (optional)

Address common issues users might encounter:

- **Problem description**: Solution or workaround
- **Another common issue**: How to resolve it

## Related tasks

Link to related how-to guides or next steps.

​

Plantilla de tutorial

Usa tutoriales cuando quieras ayudar a usuarios nuevos a aprender mediante práctica directa. Los tutoriales guían a los usuarios paso a paso a través de una experiencia de aprendizaje completa con un resultado claro.

Tutorial template

---
title: "[Action verb] [specific outcome]"
description: "Aprende cómo [specific outcome] mediante [method or approach]."
---

Usa un párrafo de introducción para explicar qué pueden esperar aprender los usuarios y qué pueden hacer después de completar este tutorial.

## Requisitos previos

Lista lo que los usuarios necesitan antes de comenzar:

- Conocimientos o habilidades requeridos
- Herramientas, cuentas o permisos
- Compromiso de tiempo (opcional)

## Step 1: [First action]

Proporciona instrucciones claras y específicas para el primer paso.

```language
// Include code examples where helpful
```

Explica qué logra este paso y por qué es importante.

## Step 2: [Second action]

Continúa con pasos secuenciales que se basan en el trabajo anterior.

Señala hitos y marcadores de progreso para que los usuarios sepan que van por buen camino.

## Step 3: [Third action]

Mantén los pasos enfocados en acciones concretas en lugar de teoría.

Minimiza las elecciones que los usuarios necesitan tomar.

## Próximos pasos

Resume lo que los usuarios aprendieron y sugiere próximos pasos lógicos:

- Tutoriales relacionados para probar
- Guías prácticas para tareas comunes
- Recursos adicionales para profundizar en el aprendizaje

​

Plantilla de explicación

Usa explicaciones cuando los usuarios necesiten comprender conceptos, decisiones de diseño o cómo funcionan las funciones complejas. Las explicaciones proporcionan contexto y profundizan la comprensión en lugar de dar instrucciones paso a paso.

Explanation template

---
title: "About [concept or feature]"
description: "Understand [concept] and how it works within [product or context]."
---

Start with a clear statement of what this explanation covers and why understanding it matters.

Define the concept in plain language. Explain what it is, what it does, and why it exists.

Use analogies or comparisons to familiar concepts when helpful.

## How [concept] works

Explain the underlying mechanics, architecture, or process.

<Frame>
  <img src="/path/to/diagram.png" alt="Diagram showing how [concept] works" />
</Frame>

Break down complex ideas into digestible sections.

## Why [design decision or approach]

Provide context about why things work the way they do.

Discuss trade-offs, alternatives that were considered, or constraints that influenced the design.

## Cuándo usar [concepto]

Ayuda a los usuarios a entender cuándo este concepto o enfoque es más apropiado.

- **Caso de uso 1**: Cuándo tiene sentido este enfoque
- **Caso de uso 2**: Otro escenario donde esta es la opción correcta
- **No recomendado para**: Situaciones donde las alternativas son mejores

## Relationship to other features

Draw connections to related concepts or features in your product.

Explain how this concept fits into the broader system or workflow.

## Common misconceptions

Address misunderstandings or clarify subtle distinctions.

## Further reading

Link to related explanations, tutorials, or reference documentation.

​

Plantilla de referencia

Utiliza documentación de referencia cuando los usuarios necesiten consultar detalles específicos sobre las características de tu producto. La documentación de referencia prioriza la precisión, la consistencia y la facilidad para revisarla rápidamente.

Reference template

---
title: "Referencia de [nombre de característica o API]"
description: "Referencia completa de propiedades, parámetros y opciones de [característica o API]."
---

Provide a one-sentence description of what this feature or API does.

## Properties

<ParamField body="property1" type="string" required>
  Brief description of the property.
</ParamField>

<ParamField body="property2" type="number">
  Brief description with default value if applicable.
</ParamField>

<ParamField body="property3" type="boolean" default="false">
  Brief description.
</ParamField>

## Parameters

<ParamField body="parameterName" type="string">
  Description of what this parameter does and when to use it.

```language
// Example showing typical usage
```
</ParamField>

<ParamField body="anotherParameter" type="object">
  Description of the parameter.

  Available options:

  - `option1`: Description of this option.
  - `option2`: Description of this option.
</ParamField>

## Examples

### Basic example

```language title="Basic usage"
// Minimal example showing common use case
```

### Advanced example

```language title="Advanced configuration"
// Example with multiple options configured
```

## Response

If documenting an API, describe the response structure.

<ResponseField name="field1" type="string" required>
  Description of the response field.
</ResponseField>

<ResponseField name="field2" type="number">
  Description of another response field.
</ResponseField>

Example response:

```json
{
  "field1": "value",
  "field2": 123
}
```

## Related references

Link to related reference documentation.

​

Páginas relacionadas

Tipos de contenido

Elige el tipo de contenido adecuado para los objetivos de tu documentación.

Estilo y tono

Escribe documentación eficaz con un estilo coherente.

Dar formato al texto

Aprende a dar formato al texto y a dar estilo al contenido.