Plantilla de caso de éxito de la temporada de Documentos

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

Usa estos encabezados de las plantillas para crear tu propio informe de caso de éxito.

Título

Organización o proyecto: Nombre de la organización (vínculo a la página o al sitio de la temporada de Documentos de tu organización)

Descripción de la organización: Una presentación concisa que proporciona una descripción general breve de lo que hace tu organización o proyecto.

Autores: Opcional: Mencione los autores del caso de éxito; use los nombres de usuario si así se lo solicitan.

Planteamiento del problema

¿Qué problema intentabas resolver con documentación nueva o mejorada?

Resumen de la propuesta

Un breve resumen de tu propuesta de organización original. Si es posible, incluye un vínculo a la página de la propuesta en el sitio de tu proyecto.

Descripción del proyecto

Cómo crear la propuesta

¿Cómo llegaste a la propuesta de la temporada de Documentos? ¿Qué proceso usó tu organización para tomar una decisión sobre una idea? ¿Cómo solicitaste e incorporaste comentarios?

Presupuesto

Incluya una sección breve en su presupuesto. ¿Cómo estimaste el trabajo? ¿Hubo algún gasto inesperado? ¿Terminó gastando menos que el premio del subsidio? ¿Tienes otros fondos además de Season of Docs que pudiste utilizar?

Participantes

¿Quién trabajó en este proyecto (usa nombres de usuario si los participantes lo solicitaron)? ¿Cómo encontraste y contrataste a tu escritor técnico? ¿Cómo encontraste otros voluntarios o participantes pagados? ¿Qué roles cumplieron? ¿Alguien se retiró? ¿Qué aprendiste sobre la selección de personal, la comunicación y la gestión de proyectos?

Cronograma

Proporciona una breve descripción general del cronograma de tu proyecto (si el proyecto está en curso, indica la fecha de finalización estimada o los hitos intermedios).

Resultados

¿Qué se creó, actualizó o cambió de alguna manera? Incluye vínculos a la documentación publicada, si está disponible. ¿Hubo algún entregable en la propuesta que no se creó? Enuméralos también.

Métricas

¿Qué métricas elegiste para medir el éxito del proyecto? ¿Pudiste recopilar esas métricas? ¿Las métricas se correlacionaron bien o mal con los resultados que querías para el proyecto? ¿Tus métricas cambiaron desde la propuesta?

Análisis

¿Qué salió bien? ¿Qué fue inesperado? ¿Qué obstáculos o contratiempos te enfrentaste? ¿Consideras que tu proyecto fue exitoso? ¿Por qué sí? ¿Por qué no? (Si es demasiado pronto para saberlo, explica cuándo esperas poder juzgar el éxito de tu proyecto).

Resumen

En 2 o 4 párrafos, resume tu experiencia con el proyecto. Destaca lo que aprendiste y lo que elegirías hacer de manera diferente en el futuro. ¿Qué consejo darías a otros proyectos que intentan resolver un problema similar con la documentación?

Apéndice

Si tienes otros materiales que te gustaría vincular (por ejemplo, si creaste un contrato para trabajar con tu redactor técnico que te gustaría compartir, plantillas para tu proyecto de documentación o algún otro recurso de documentación abierta, puedes enumerarlos y vincularlos aquí). El apéndice también es un buen lugar para incluir vínculos a las herramientas o recursos de documentación que usaste, o bien para agregar agradecimientos o agradecimientos que podrían no encajar en las secciones anteriores.