Optimización de guías para el desarrollo de software
¡Hola! Espero que se encuentren bien. En esta oportunidad me gustaría compartir un poco sobre la optimización de guías para el desarrollo de software.
Las guías son necesarias tanto para el “seasoned programmer” como para el programador principiante. Se les podría denominar una de las mayores fuentes de educación e inspiración para los programadores.
Sin embargo, entre aquella educación e inspiración encontraremos varias guías rebuscadas y en mi opinión innecesariamente extensas. En esta publicación exploraremos un poco sobre las guías para el desarrollo de software y cómo optimizarlas.
Como sabemos, preparar el ambiente es el cimiento para dar comienzo al desarrollo, y dicho cimiento viene con muchas tareas mundanas.
Como se encuentran las herramientas actuales, es muy poco probable librarnos de estas tareas… por lo menos en un buen tiempo. Lo mejor que podemos hacer es aceptar lo cotidiano y buscar cómo optimizar estos procesos para hacernos la vida más sencilla y disfrutar más de lo que nos gusta: programar.
Ese es el propósito de esta publicación: una guía sobre cómo transformar guías para el desarrollo de software de gran magnitud en unas eficientes y al grano, específicamente en la preparación del ambiente de desarrollo.
Optimización de guías para el desarrollo de software
El primer paso para la optimización de guías es identificar qué tareas deben ser agilizadas.
Este primer paso es sencillo: simplemente debes saber cuáles son las tareas más repetitivas en tu ambiente de desarrollo.
La mayoría de estas tareas naturalmente las encontrarás en la preparación de tu ambiente de desarrollo. Por ejemplo, pasos para crear el ambiente de tu web service, pasos para publicar tu web service o web site, pasos para crear tu base de datos.
Los anteriormente mencionados son unos de los varios procesos de la preparación del ambiente que encontramos en el desarrollo de software. Sin mencionar que cada uno de aquellos ejemplos deben ser preparados independientemente para cada lenguaje, herramienta y sistema operativo.
Es decir, en el caso que utilices una variedad de tecnologías para preparar el ambiente de tus web services. Podrias facilmente sacar entre dos a tres guías.
Pero no te digo esto para asustarte. La optimización te ayudará de gran manera a agilizar tu proceso y tiempo de desarrollo. Además, no es una tarea muy complicada.
Una vez identificadas las tareas más repetitivas de tu ambiente de desarrollo procedemos a crear el documento.
Crear documento
Crear el documento es una tarea relativamente sencilla. Como se dice coloquialmente “Keep it super simple”. Y eso haremos con nuestra guía, empleando la menor cantidad de palabras posibles para hacerla sencilla y fácil de seguir. Y además, utilizar “ordered lists” o “bullet points” para su preparación. También es una buena práctica añadir la referencia de la fuente oficial del proceso que estás optimizando.
Aparte del documento es importante mantener un buen orden jerárquico en el archivo donde este se alojará.
Así podrás encontrarlo fácilmente cuando lo necesites. Un archivo en el “Desktop” de tu ordenador llamado “Optimización” es suficiente. Sin embargo, si te tomas en serio la organización y empleas herramientas como Notion en tu diario, no vendría nada mal utilizarla para este propósito.
Ya tenemos nuestra guía optimizada. Ahora lo que resta es probarla para medir su efectividad y corroborar que efectivamente nos ayude a optimizar el tiempo de desarrollo.
Probar efectividad de la guía
Probar la efectividad de la guía es una simple tarea de comparación entre la fuente original y tu guía optimizada.
Si empleaste las directrices sobre cómo preparar el documento es sentido común que tendrás un mejor tiempo de implementación.
“But let's not get over ourselves”
Para ofrecer un ejemplo utilizaré una de mis propias guías para hacer esta comparación. La guía que voy a compartir a continuación la utilizo para crear los certificados de los “push notifications” de las aplicaciones móviles de mis clientes.
Para dar un poco de contexto las aplicaciones de Apple requieren una serie de certificados que deben ser renovados cada 6 meses. Uno de ellos es el del servicio de “push notifications” el cual implementamos en nuestro desarrollo utilizando OneSignal.
OneSignal es una excelente compañia y un gran proveedor de servicio para el manejo de “push notifications”.
Sin embargo, su guía para la renovación de estos certificados parece un laberinto.
Pero no tomes mi palabra por hecho. Visita aquí la guia de OneSignal para la renovación de certificados de “push notifications”: https://documentation.onesignal.com/docs/generate-an-ios-push-certificate
Ahora te comparto mi guía optimizada para llevar a cabo este mismo proceso:
- Abrir la aplicación keychain Access.
- Pulsar Keychain Access en el menú al lado de la manzana 🍎.
- Certificate Assistant > Request certificate from authority > Checkbox save on disk > Continue.
- Descargar certificateRequest
- Visitar seccion de certificates en Apple Developer: https://developer.apple.com/account/resources/certificates/list
- Pulsar el signo de + en certificates.
- Seleccionar checkbox: Apple Push Notification service SSL (Sandbox & Production).
- Seleccionar App ID del menú desplegable.
- Cargar certificateRequest descargado en el paso 4.
- Pulsar Descargar y abre el archivo aps.cer descargado (este abrirá en KeyChain).
- Identificar el archivo, hacemos clic derecho y seleccionamos exportar.
- Abres las configuraciones en OneSignal: https://dashboard.onesignal.com/apps/5ceb25ff-cfca-46c1-8aeb-5fdfee621f70/settings
- Seleccionar checkbox: Actualizar autenticación
- Seleccionar .p12
- Cargar archivo .p12 (exportado en el paso 11) e insertas la contraseńa.
Se puede ver claramente la diferencia entre claridad y facilidad de visualizar cada paso que debe llevarse a cabo.
Mi guía optimizada tiene un tiempo de implementación de 3 - 4 minutos. El mismo tiene que potencialmente toma entender y leer la guía de la fuente original.
Espero que esta comparación te haya permitido ver el valor de optimizar guías para el desarrollo de software. Como programadores no nos podemos librar de tareas mundanas. Pero sí podemos implementar técnicas para acortar el tiempo que invertimos en ellas.
Resumen
En esta publicación nos adentramos un poco en la parte no tan divertida del desarrollo de software. La preparación de documentación sin duda puede ser una de las tareas más tediosas del desarrollo de software. Sin embargo, cuando cambiamos nuestra perspectiva y las vemos como una inversión a futuro de la cual obtendremos más tiempo de vuelta. Se convierte sin duda en una inversión atractiva.
Recomiendo que lleves a cabo la práctica de documentar preparando guías optimizadas. Con el tiempo y consistencia desarrollarás un gran hábito y activo para cualquier programador.
Listopro Community da la bienvenida a todas las razas, etnias, nacionalidades, credos, géneros, orientaciones, puntos de vista e ideologías, siempre y cuando promuevan la diversidad, la equidad, la inclusión y el crecimiento profesional de los profesionales en tecnología.