Diseñando Ansel

Ansel está diseñado, no improvisado. Los hackers pueden disfrutar ’trabajando’ en acelerar el descenso de Darktable aumentando su deuda técnica .

¿Qué es el diseño?

El diseño es un proceso por el cual se desarrolla una metodología para brindar una solución técnica a un problema humano. El proceso de diseño está destinado a converger en la solución más adecuada, mientras se lucha contra la tendencia natural a apresurarse hacia la primera o la idea más cómoda.

Sin requerimientos ni diseño, programar es el arte de añadir errores a un archivo de texto vacío. — Louis Srygley

1. El diseño comienza con un caso de uso: una tarea definida a lograr (en una imagen), por un usuario definido, en un tiempo definido. Si no hay caso de uso, entonces no hay problema que resolver, entonces mantente alejado de tu editor de código.
2. El diseño requiere conocer al usuario objetivo: educación/capacitación, nivel de artesanía/maestría, etc.
3. El diseño requiere entender las necesidades: en el contexto de Ansel, a menudo se necesitará algún conocimiento de historia del arte y fotografía en cuarto oscuro.
4. Una vez que el problema y el usuario sean comprendidos, el diseño requiere especificar:
   • las funcionalidades esperadas de la solución.
   • el alcance de la solución (¿dónde se encuentra la solución en el ciclo de vida de una imagen?).
   • las restricciones y requisitos de la solución (apoyar algún estándar, permitir procesar n imágenes por unidad de tiempo, etc.).
   • una serie de pruebas a completar que validarían la calidad de la solución, para limitar opiniones no productivas, sesgos y subjetividad en el proceso de validación.
5. Solo entonces pueden comenzar los prototipos y sesiones de ideas.

¿Qué no es diseño?

El diseño no se ocupa de:

• requisitos vagos de un usuario indefinido, futuro o imaginado,
• “sería genial si…” (así es como se crean colecciones de complementos inconsistentes),
• lo que le gusta a la gente (por cada cosa que a alguien le gusta, encontrarás a alguien que la odia),
• lo que la gente cree que quiere (a menudo no es lo que necesita),
• palabras de moda tecnológicas que “son el futuro” y, como tales, necesitan ser incorporadas en todas partes, sin importar su relevancia o viabilidad (sí, estoy hablando de IA, NFT, blockchain, etc.)

¿Qué es buen diseño?

Un buen diseño es:

• minimalista.
• robusto.
• preparado para el futuro.
• genérico y generalizado.
• mantenible con recursos limitados.
• informado por la ciencia.
• compatible/interoperable con estándares industriales.

Dado que Ansel es una aplicación basada en flujos de trabajo, un buen diseño también tiene en cuenta el flujo de trabajo como un todo y dónde encajan el problema/solución en él.

¿Cómo se hace un buen diseño?

Para ayudar en el proceso de diseño, la comunicación debe ser concisa, centrada y las personas que participan en ese proceso deben asegurarse de tener una comprensión adecuada de la teoría y el trasfondo técnico involucrado en el alcance del problema/solución.

Se debe enfatizar que, aunque el proyecto está impulsado por software, no todas las soluciones involucran programación. A veces (¿a menudo?), una mejor educación o mejor documentación es todo lo que se necesita.

El propósito de un proceso de diseño sano es evitar sesgar las soluciones demasiado pronto con un diseño/tecnología favorita y evitar perderse en las complejidades técnicas, pero siempre volver a los principios básicos de lo que estamos haciendo: post-procesar potencialmente grandes lotes de imágenes en bruto para todo tipo de medios de salida.

Esto es respaldado por el hecho de que los usuarios rara vez conocen sus propias necesidades, o más bien, las necesidades que expresan rara vez son la raíz de lo que realmente quieren. La tarea difícil del diseño es cortar a través de las ramas para llegar a la raíz, porque resolver el problema raíz generalmente resulta en soluciones más elegantes, genéricas y minimalistas.

Los problemas vienen primero

El primer paso del proceso de diseño de Ansel es presentar una solicitud de función en la Comunidad. Las solicitudes de funciones se han movido de Github porque esta plataforma no es acogedora para personas no programadoras y no angloparlantes (aunque la Comunidad solo admite francés e inglés).

Esta solicitud de función se centrará en el problema a resolver y se abstendrá de proponer cualquier solución. El problema se definirá en términos de tareas a lograr en el flujo de trabajo de un fotógrafo o resultado visual esperado de la imagen procesada, es decir, en términos del objetivo final a lograr, no en términos de herramientas o tecnicismos que se creen necesarios. Esto puede llevar a una discusión para profundizar en las raíces del problema, que generalmente están bien ocultas debajo de lo que el usuario cree que es su problema .

No se acepta ninguna propuesta de solución en esta etapa.

Las soluciones vienen segunda

Cuando la definición y el alcance del problema sean acordados entre las personas involucradas en la discusión, se podrán proponer soluciones. Puede ser necesario un debate posterior para evaluar los inconvenientes y beneficios de cada solución, llevando a la adopción de la mejor solución en principio. Las soluciones se definen por sus funcionalidades (es decir, lo que deberían hacer), no por su tecnología o medios (cómo deberían hacerlo).

No se aceptan propuestas de prototipo en esta etapa.

Las soluciones adoptadas llevarán a una nueva incidencia que será triageada en el tablero Kanban de gestión de proyectos .

Pueden estar condicionadas a la investigación de aspectos teóricos y técnicos para evaluar su viabilidad, en cuyo caso estarán triageadas en la columna Por investigar del tablero Kanban. Los hallazgos de la investigación se añadirán a la incidencia original hasta que la viabilidad de la solución esté comprobada. Cuando lo esté, la incidencia se moverá a la columna ‘Por hacer’ del tablero Kanban.

Las soluciones adoptadas pueden ser directamente triageadas para la columna Por hacer si solo requieren herramientas y técnicas bien conocidas.

Idealmente, los puntos a probar y el procedimiento de prueba para validar el prototipo deberían estar escritos incluso antes de tener un prototipo funcional. Al menos, las pruebas deben asegurar que no ocurrió regresión en las características y herramientas relacionadas.

Los prototipos son el tercer paso

Solo las incidencias triageadas en la columna ‘Por hacer’ del tablero Kanban de gestión de proyectos  serán trabajadas, por mí mismo o por cualquiera dispuesto a abordarlas.

El prototipo de la solución se propondrá en una solicitud de extracción de una rama de tema que enlace la incidencia original. Las ramas de tema necesitan ser alineadas con la rama master por ejemplo, git rebase ustream master o, si actualizas tu rama localmente con nuevos commits de master, haz git pull upstream master --rebase o configura git globalmente  para extraer a través de rebase en lugar de merge. Esto asegura que el historial de tu rama se mantenga limpio con el mínimo esfuerzo, y también mantiene limpio el historial de master cuando se fusiona tu PR.

Cuando la solicitud de extracción de prototipo se revise y si cumple con los estándares de calidad del código (ver más abajo) mientras se ajusta a las especificaciones de la solución adoptada, será aprobada y automáticamente triageada a la columna ‘Por probar/validar’ del tablero Kanban de gestión de proyectos .

La validación es el cuarto paso

Las solicitudes de extracción aprobadas se fusionarán tempranamente en la rama candidate o dev para pruebas, dependiendo de si pueden romper los historiales de edición de imágenes (al agregar nuevos parámetros de módulo o cambiar el esquema de la base de datos). Esta rama siempre será la rama principal con todas las solicitudes de extracción pendientes de validación en la parte superior. Esto está destinado a ayudar en las pruebas de personas que no necesariamente están al día con la fusión manual de ramas de git. A diferencia de la rama dev, candidate no debería romper tus ediciones.

Si no se reporta ningún error o interrupción después de algún tiempo y el prototipo cumple su propósito inicial correctamente, se fusionará en master y la incidencia relacionada se cerrará y se moverá a la columna ‘Hecho’ del tablero Kanban de gestión de proyectos .

Si el prototipo demuestra ser insatisfactorio, puede ser rechazado y otro necesitará ser trabajado.