Esta página explica los diferentes tipos de contenido, cuándo usar cada uno y cómo enfocar la redacción para cada tipo.
Clasifica con el marco Diátaxis
- Tutoriales: contenido orientado al aprendizaje para usuarios nuevos
- Guías prácticas: orientación basada en tareas para problemas específicos
- Explicaciones: discusiones conceptuales orientadas a la comprensión
- Referencia: descripciones técnicas de carácter informativo
Elegir un tipo
| 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 |
Redacción para cada tipo
Tutoriales (enfocados en el aprendizaje)
- 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.
Guías prácticas (orientadas a problemas)
- 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.
Referencia (orientada a la Información)
- 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.
Explicación (orientada a la comprensión)
- 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.
Consejos y trucos
- 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.
- 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.
- Piensa como tus usuarios: Ten en cuenta distintos perfiles de usuario al organizar el contenido. Consulta Understand your audience para más información.