Con esta plantilla configuras proyectos de documentación técnica de forma rápida y sistemática y detectas riesgos potenciales antes. Descarga gratis nuestra plantilla y lleva tu proyecto al éxito.
Estructura general del plan del proyecto
¿Te enfrentas a un proyecto de documentación grande? Entonces deberías tomarte el tiempo para planificarlo a fondo. Ya sea una guía de instalación, guía del administrador, referencia de API o notas de versión, crear documentación es un arte en sí mismo. Para ayudar, hemos creado esta plantilla gratuita. Está dividida en Planificación, Desarrollo de contenidos en sprints, Publicación y Análisis posterior al proyecto. Trabajamos deliberadamente en sprints ágiles para incorporar comentarios rápidamente y dirigir las iteraciones de forma controlada.
¿Por qué bloques de tiempo de 1 día?
Las tareas de la plantilla están establecidas intencionadamente en un día. Considera estos tiempos solo como marcadores de posición. El esfuerzo real depende del número, alcance y profundidad de los documentos necesarios: cuantos más artefactos, más ciclos de revisión y más largo el proyecto. Sustituye más adelante los marcadores por estimaciones realistas.
Estima mejor el esfuerzo: consejos y trucos
Empieza con una lista de entregables (¿qué documentos, versiones, idiomas?) y define tus públicos objetivo/personas. Revisa tus fuentes disponibles (especificaciones, historias de usuario, código, tickets) y planifica ciclos de revisión (internos/externos) de forma realista. Considera reglamentación/calidad (terminología, traducciones), la cadena de herramientas (docs-as-code, build, madurez de la guía de estilo) y riesgos (cambios de release, recursos).
Fase 1 – Planificación
En la planificación defines objetivos, entregables y responsabilidades y creas la base para sprints fluidos.
Consejo práctico:
Utiliza el modelo RACI para definir responsabilidades:
- Responsable (realiza el trabajo)
- Autoridad (toma la decisión)
- Consultado (participa)
- Informado (se mantiene al tanto)
Así es como debes proceder:
- Crea una lista de todas las actividades
- Asigna R/A/C/I por actividad. Registra las responsabilidades en una tabla
- Resuelve conflictos comunicando como máximo un rol A por actividad
Fase 2 – Desarrollo de contenidos en sprints de 2 semanas
Aquí el contenido se crea de forma iterativa. Agrupamos el Sprint 1–∞ bajo un mismo paraguas y actualmente planificamos sprints de dos semanas—una seña de planificación ágil de proyectos: ciclos cortos, comentarios tempranos y progreso visible.
Cómo ejecutar tus sprints de manera eficaz:
- Define un objetivo de sprint medible: p. ej., “Capítulos 1–3 de la Guía del Administrador en calidad lista para revisión”.
- Acota en el tiempo las entrevistas con stakeholders/SME: prepara una guía; captura los resultados en un registro listo para decisión. Contexto:
- Recoge revisiones externas de forma estructurada: involucra usuarios piloto o soporte; etiqueta incidencias/comentarios de manera coherente
Fase 3 – Publicación
Convierte el contenido entregable en artefactos de alta calidad (HTML, PDF, opcionalmente ePub) que se publiquen de forma impecable y coherente.
Consejo práctico:
Mantén el contenido modular (temas, includes, atributos) y automatiza las exportaciones vía CI. Recomendamos AsciiDoc como lenguaje de documentación. Nosotros mismos lo usamos para nuestra documentación.
Fase 4 – Análisis posterior al proyecto
Anclas el aprendizaje en el equipo y mejoras procesos, herramientas y colaboración para la próxima versión.
Consejo para la retrospectiva:
Pregúntense: ¿Qué salió bien? ¿Qué no salió bien? ¿Qué cambiaremos?
Así aprendes de tus ideas para futuros proyectos y finalizas nueva documentación más rápido, con menor coste y mayor calidad.
Consejo: No subestimes la gestión de riesgos. Ya hemos adjuntado algunos riesgos potenciales en el proyecto. Úsalos como base para identificar más riesgos y definir contramedidas.)
Próximos pasos – cómo usar la plantilla
- Descarga la plantilla: Descarga la plantilla aquí y ábrela en Merlin Project
- Evalúa el esfuerzo y sustituye marcadores: Cambia duraciones de 1 día por estimaciones basadas en tu lista de entregables y las métricas del primer sprint.
- Define RACI: Asigna R/A/C/I por actividad, resuelve conflictos, versiona en el repositorio y enlaza de forma visible.
- Confirma la cadencia de sprints: Ancla sprints de dos semanas en el calendario (bloquea espacios para planificación/revisión/retro). Mantén el backlog según DoR.
- Activa comprobaciones en CI: Configura linter, verificador de enlaces, pipeline de capturas y formatos de exportación en CI; define umbrales de fallo.
- Ejecuta un documento piloto: Empieza con un documento pequeño pero representativo, mide el lead time, refina definiciones (DoR/DoD).
- Escala: Tras el piloto, amplía la lista de artefactos (guía de instalación → guía del administrador → referencia de API) y planifica la capacidad según ciclos medidos.
Si tienes preguntas sobre esta entrada del blog o quieres comentarla, esperamos tu publicación en nuestro foro.
Si tiene alguna pregunta sobre este artículo del blog o desea debatirlo, esperamos su contribución en nuestro foro.
