> ## Documentation Index
> Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Tipos de contenido

> Elige el tipo de contenido adecuado para tus objetivos de documentación.

<Tip>
  Esta página explica los distintos tipos de contenido, cuándo usar cada uno y cómo abordar la redacción para cada tipo.
</Tip>

La documentación debe organizarse en torno al objetivo específico que quieres ayudar a las personas a alcanzar.

<div id="categorize-using-the-ditaxis-framework">
  ## Clasifica con el marco Diátaxis
</div>

El [marco Diátaxis](https://diataxis.fr) es una guía útil para categorizar el contenido según las necesidades de tu audiencia. La documentación, por lo general, puede agruparse en uno de estos tipos:

1. Tutoriales: contenido orientado al aprendizaje para usuarios nuevos
2. Guías prácticas: orientación basada en tareas para problemas específicos
3. Explicaciones: discusiones conceptuales orientadas a la comprensión
4. Referencia: descripciones técnicas de carácter informativo

Definir tipos de contenido te ayuda a planificar la documentación con un propósito claro y facilita que los usuarios encuentren lo que necesitan.

<Frame>
  <img src="https://mintcdn.com/anotherhorizon/JcCuRMYxa7xgY0h0/images/guides/best-practices/diataxis.webp?fit=max&auto=format&n=JcCuRMYxa7xgY0h0&q=85&s=74d8e745b8ec5c17c3813a6cff6449fd" alt="Diagrama del marco Diátaxis con cuatro cuadrantes que corresponden a los cuatro tipos de contenido: Tutoriales, Guías prácticas, Referencia y Explicación." width="1920" height="1080" data-path="images/guides/best-practices/diataxis.webp" />
</Frame>

<div id="picking-a-type">
  ## Elegir un tipo
</div>

| Pregunta                                   | Tutorial                      | Cómo hacerlo                    | Referencia                    | Explicación                |
| :----------------------------------------- | :---------------------------- | :------------------------------ | :---------------------------- | :------------------------- |
| ¿Cuál es el objetivo del usuario?          | Aprender mediante la práctica | Resolver un problema específico | Encontrar información precisa | Comprender conceptos       |
| ¿Cuál es el conocimiento del usuario?      | Principiante                  | Intermedio                      | Con experiencia               | Cualquier nivel            |
| ¿Cuál es el enfoque principal?             | Aprender haciendo             | Alcanzar un objetivo            | Proporcionar información      | Profundizar la comprensión |
| ¿Cómo está estructurado el contenido?      | Paso a paso                   | Problema-solución               | Datos organizados             | Discusiones conceptuales   |
| ¿Está orientado a tareas?                  | Sí, tareas guiadas            | Sí, tareas específicas          | No, informativo               | No, conceptual             |
| ¿Está diseñado para una progresión lineal? | Sí                            | No                              | No                            | No                         |

<div id="writing-for-each-type">
  ## Redacción para cada tipo
</div>

<div id="tutorials-learning-oriented">
  ### Tutoriales (enfocados en el aprendizaje)
</div>

* **Objetivo del público**: Aprender algo nuevo mediante instrucciones paso a paso.
* **Características**: Secuenciales y no requieren conocimientos previos.
* **Enfoque de redacción**:
  * Establece qué logrará el usuario al terminar la lectura.
  * Usa pasos claros e incrementales. Reduce al mínimo las decisiones que deba tomar el usuario.
  * Señala hitos a lo largo del proceso.
  * Minimiza la teoría y enfócate en acciones concretas.

<div id="how-to-guides-problem-oriented">
  ### Guías prácticas (orientadas a problemas)
</div>

* **Objetivo del público**: Realizar correctamente una tarea específica.
* **Características**: Orientadas a objetivos y suponen cierto conocimiento previo.
* **Enfoque de redacción**:
  * Escribe desde la perspectiva del usuario, no del producto.
  * Describe una secuencia lógica y omite detalles innecesarios.
  * Reduce el contexto a lo estrictamente necesario.

<div id="reference-information-oriented">
  ### Referencia (orientada a la Información)
</div>

* **Objetivo del público**: Encontrar detalles sobre la funcionalidad de un producto.
* **Características**: Clara, centrada en el producto, fácil de escanear.
* **Enfoque de redacción**:
  * Ser escaneable y concisa.
  * Priorizar la consistencia.
  * Evitar el contenido explicativo. Centrarse en ejemplos fáciles de copiar y modificar.

<div id="explanation-understanding-oriented">
  ### Explicación (orientada a la comprensión)
</div>

* **Objetivo del público**: Ampliar la comprensión general de un concepto o de una función muy compleja.
* **Características**: Teórica, potencialmente opinativa, de alcance amplio.
* **Enfoque de redacción**:
  * Proporcionar contexto, como decisiones de diseño o limitaciones técnicas.
  * Reconocer opiniones y alternativas.
  * Trazar conexiones con otras áreas del producto o de la industria.

<div id="tips-and-tricks">
  ## Consejos y trucos
</div>

1. **Mantén el propósito**: Antes de escribir, asigna a cada página un tipo de contenido específico y tenlo siempre presente a lo largo de todo el documento.
2. **Considera la frescura del contenido**: Independientemente del tipo de contenido, procura optimizar para que la documentación sea atemporal. Si algo refleja cómo se ve una función en una fecha concreta, probablemente encaje mejor en los cambios o en una entrada de blog que en tu documentación. Y si algo cambia con mucha frecuencia, evita incluirlo en tus docs.
3. **Piensa como tus usuarios**: Ten en cuenta distintos perfiles de usuario al organizar el contenido. Consulta [Understand your audience](/es/guides/understand-your-audience) para más información.
4. **Usa plantillas**: Empieza con las [plantillas de contenido](/es/guides/content-templates) que proporcionan la estructura básica para cada tipo de contenido.

Aunque el marco Diátaxis ofrece un punto de partida, una documentación exitosa requiere adaptarlo al contexto de tu producto. Empieza por comprender los principios del marco y luego ajústalos para atender las necesidades de tus usuarios.

<div id="related-pages">
  ## Páginas relacionadas
</div>

<CardGroup cols={2}>
  <Card title="Plantillas de contenido" icon="file-code" href="/es/guides/content-templates">
    Copia y modifica las plantillas para cada tipo de contenido.
  </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="Entiende a tu audiencia" icon="users" href="/es/guides/understand-your-audience">
    Investiga y define la audiencia de tu documentación.
  </Card>

  <Card title="Navegación" icon="compass" href="/es/guides/navigation">
    Organiza la estructura de tu documentación de forma eficaz.
  </Card>

  <Card title="Mejora tu documentación" icon="chart-line" href="/es/guides/improving-docs">
    Usa datos y métricas para mejorar la documentación.
  </Card>
</CardGroup>
