Crear un caso práctico

Fase actual:
La temporada 2021 del programa Documentos finalizó el 14 de diciembre de 2021. Consulta el cronograma.

Como parte de la temporada de documentos 2021, las organizaciones deben enviar una evaluación final y un caso de éxito. Usa nuestra plantilla de caso de éxito y el caso de éxito de muestra como guías para crear el caso de éxito de tu propio proyecto.

El formulario de evaluación final estará disponible al menos un mes antes del 30 de noviembre de 2021 a las 6:00 p.m. (UTC).

Descripción general del caso de éxito

La plantilla de caso de éxito incluirá las siguientes secciones:

  • Planteamiento del problema: ¿qué problema intentabas resolver con documentación nueva o mejorada?
  • Resumen de la propuesta: Es un breve resumen de la propuesta original de la organización.
  • Descripción del proyecto: una descripción narrativa del proyecto. Incluye lo siguiente:
    • Cómo creaste tu propuesta (y vincula a la página de ideas del proyecto original)
    • Cómo reclutaste y seleccionaste a un escritor técnico u otros participantes.
    • Quién trabajó en el proyecto (usa nombres de usuario si los participantes lo solicitan).
    • Cuánto tiempo tardó en completarse el proyecto (si se completó)
    • ¿Qué salió bien?
    • ¿Qué fue inesperado? ¿A qué obstáculos o obstáculos te enfrentaste?
    • ¿Qué documentación se creó, actualizó, mejoró o quitó?
  • ¿Este proyecto generó algún proceso o procedimiento nuevo o actualizado en tu organización?
  • Métricas:
    • ¿Qué métricas se eligieron para medir el éxito del proyecto?
    • ¿Pudiste recopilar esas métricas?
    • ¿Se correlacionaron con los comportamientos o comparativas que esperabas?
    • ¿Cambiaron las métricas que elegiste? ¿Quitaste o agregaste alguna métrica?
    • Según tus métricas, ¿tu proyecto es exitoso? (Puede ser muy pronto para saberlo).
    • ¿Con qué frecuencia tienes la intención de recopilar métricas en el futuro?
  • Resumen:
    • En 2 o 4 párrafos, resume tu experiencia en el proyecto. ¿Qué aprendiste? ¿Qué cambiarías en el futuro? ¿Qué consejo le darías a proyectos que intentan resolver un problema similar con la documentación?

Orientación para los casos de éxito

  • Mantener un registro semanal de las actualizaciones del proyecto te ayudará a crear tu caso de éxito. Cada semana, registra el progreso del proyecto (incluidos los vínculos a solicitudes de extracción, problemas o conversaciones, cuando sea útil), lo que salió bien (o no), lo que aprendiste y las preguntas que se hicieron.
  • Cuando escribas tu caso práctico, sé amable. Evita culpabilizar y mantén la postura constructiva. Recuerda que los casos de éxito son públicos.
  • Usa el mismo tono en tu caso de éxito que usarías para una entrada de blog o un instructivo. No seas demasiado formal.