mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
e72b4fb295
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
287 lines
8.2 KiB
Plaintext
287 lines
8.2 KiB
Plaintext
---
|
|
title: "Plantillas de contenido de documentación"
|
|
sidebarTitle: "Plantillas de contenido"
|
|
description: "Copia y modifica plantillas MDX listas para usar para guías prácticas, tutoriales, explicaciones conceptuales y páginas de referencia de API en tu documentación."
|
|
keywords: ["plantillas de documentación", "plantilla de guía práctica", "plantilla de tutorial", "plantilla de referencia", "plantillas MDX"]
|
|
---
|
|
|
|
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.
|
|
|
|
<Tip>
|
|
¿No estás seguro de qué plantilla usar? Lee sobre [tipos de contenido](/es/guides/content-types) para comprender cuándo utilizar cada uno.
|
|
</Tip>
|
|
|
|
<div id="how-to-guide-template">
|
|
## Plantilla de guía práctica
|
|
</div>
|
|
|
|
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.
|
|
|
|
````mdx 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.
|
|
````
|
|
|
|
<div id="tutorial-template">
|
|
## Plantilla de tutorial
|
|
</div>
|
|
|
|
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.
|
|
|
|
````mdx 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
|
|
````
|
|
|
|
<div id="explanation-template">
|
|
## Plantilla de explicación
|
|
</div>
|
|
|
|
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.
|
|
|
|
```mdx 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.
|
|
```
|
|
|
|
<div id="reference-template">
|
|
## Plantilla de referencia
|
|
</div>
|
|
|
|
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.
|
|
|
|
````mdx 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.
|
|
````
|
|
|
|
<div id="related-pages">
|
|
## Páginas relacionadas
|
|
</div>
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Tipos de contenido" icon="shapes" href="/es/guides/content-types">
|
|
Elige el tipo de contenido adecuado para los objetivos de tu documentación.
|
|
</Card>
|
|
|
|
<Card title="Estilo y tono" icon="pen" href="/es/guides/style-and-tone">
|
|
Escribe documentación eficaz con un estilo coherente.
|
|
</Card>
|
|
|
|
<Card title="Dar formato al texto" icon="text" href="/es/create/text">
|
|
Aprende a dar formato al texto y a dar estilo al contenido.
|
|
</Card>
|
|
</CardGroup> |