Crear un caso práctico

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

Como parte de la temporada 2021 de Documentos, las organizaciones deben enviar una evaluación final y un caso de éxito. Usa nuestra plantilla de casos 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 casos de éxito incluirá estas secciones:

  • Planteamiento del problema: ¿Qué problema intentabas resolver con documentación nueva o mejorada?
  • Propuesta abstracta: un breve resumen de la propuesta de organización original
  • Descripción del proyecto: una descripción narrativa del proyecto. Se incluyen los siguientes:
    • Cómo creaste tu propuesta (y el vínculo a la página original de ideas para el proyecto).
    • Cómo reclutaste y seleccionaste a un escritor técnico o a otros participantes.
    • Quién trabajó en el proyecto (usa nombres de usuario si los participantes lo solicitan).
    • Cuánto tiempo tardó el proyecto en completarse (si se completó).
    • ¿Qué salió bien?
    • ¿Qué fue inesperado? ¿Qué obstáculos o contratiempos te enfrentaste?
    • ¿Qué documentación se creó, actualizó, mejoró o quitó?
  • ¿Este proyecto generó procesos o procedimientos nuevos o actualizados 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 las comparativas que esperabas?
    • ¿Cambiaron las métricas que elegiste? ¿Quitaste o agregaste métricas?
    • Según tus métricas, ¿tu proyecto es exitoso? (puede ser demasiado temprano para saberlo).
    • ¿Con qué frecuencia deseas recopilar métricas en el futuro?
  • Resumen:
    • En 2 o 4 párrafos, resume tu experiencia del proyecto. ¿Qué aprendiste? ¿Qué cambiarías en el futuro? ¿Qué consejo les darías a los proyectos que intentan resolver un problema similar con la documentación?

Guía sobre el caso de éxito

  • Llevar un registro semanal de las actualizaciones del proyecto te ayudará a crear tu caso práctico. Para 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 culpabilización y muéstrala constructivamente. Recuerda que los casos prácticos son públicos.
  • Usa el mismo tono en tu caso práctico como lo harías en una entrada de blog o instructivo; no seas demasiado formal.