La ventaja de una página: una plantilla para proyectos de ingeniería de software

Descargo de responsabilidad : Los puntos de vista y opiniones expresados en este artículo son exclusivamente míos y no reflejan necesariamente los puntos de vista de ninguna institución u organización.

Introducción

La complejidad de los sistemas de software a menudo requiere que los ingenieros o gerentes de software escriban propuestas para alinear equipos, organizaciones o partes interesadas (equipos de socios, servicios dependientes, etc.) en los cambios. Estas propuestas ayudan a comunicar motivaciones, recomendaciones o hitos de manera concisa, al mismo tiempo que obtienen comentarios y alinean a todas las partes interesadas.

Dichos documentos también sirven como puntos de referencia pasados para los nuevos empleados que se apropian de los sistemas de software y comprenden el proceso de pensamiento de cómo se tomaron las decisiones en el pasado. Este artículo proporciona una plantilla genérica para escribir un buscapersonas; Aunque no se limita a los sistemas de software, se ha demostrado que es útil para liderar organizaciones de ingeniería de software.

Plantilla

Descripción general

Este será el resumen ejecutivo del documento, bueno para captar la motivación y lo que estás proponiendo para que los lectores se interesen en tu documento.

Introducción

Proporcione detalles sobre los antecedentes/motivación del cambio. Se pueden incluir métricas/datos para explicar el problema y proporcionar información adicional.

Objetivos

Requisitos dentro del alcance para este proyecto.

No metas

Mencione cualquier tarea que no sea un objetivo o que esté fuera del alcance de este proyecto. Estas pueden ser distracciones para resolver el problema en el que desea concentrarse.

Opciones

Resuma una lista de opciones/alternativas que consideró para resolver el problema, preferiblemente con los pros y los contras de cada una.

Recomendación

Con base en las alternativas discutidas en la sección anterior, brinde recomendaciones para soluciones estratégicas con explicaciones o argumentos de respaldo.

Enfoque táctico como opción: según los desafíos/el cronograma asociados con el logro del enfoque recomendado, considere brindar una solución táctica; Potencialmente, esto puede ser un paso incremental hacia una solución estratégica o un cambio mínimo para abordar el problema en el corto plazo.

Pruebas

Describa cómo validará que la función esté funcionando según lo previsto; ¿Para qué probarás? ¿Cómo lo probarás? ¿Habrá un período de validación gamma o de preproducción? ¿Qué implicará eso? Asegúrese de incluir casos de prueba que verifiquen que la función solo se aplica a los eventos en los que debería aplicarse.

Hitos

Enumere las tareas/hitos de alto nivel para las soluciones recomendadas con estimaciones en días de desarrollo. Para proporcionar esta lista además de los cambios funcionales, piense en:

• Estrategia de pruebas antes del lanzamiento (pruebas unitarias, de integración, etc.)
• Necesidad/estrategia de reposición
• Cualquier cambio en las métricas/scripts de informes/herramientas
• Nuevas métricas/pasos de validación después del lanzamiento (canarios, flujos de trabajo de aprobación de canalizaciones)
• Revisión de seguridad
• Mini revisión de la preparación operativa

Referencias

Referencias que cree que podrían ayudar a los lectores a profundizar en el espacio del problema o en las alternativas presentadas.

Preguntas frecuentes

Responder de manera proactiva cualquier pregunta o pregunta anticipada que pueda haber surgido en discusiones consecutivas relacionadas con esta propuesta.

Apéndice

Agregue cualquier información complementaria a la propuesta, a la que los lectores puedan consultar según sea necesario.

Notas de la reunión

Mantenga el siguiente resumen para las reuniones en las que tenga la revisión de la propuesta.

Asistentes

Listado de personas que asistieron a la reunión.

MoM (Acta de Reunión)

Resuma el acta de la reunión para referencia futura.