Clean Code Capítulo 4 Comentarios

No se debería tener la necesidad de escribir algún comentario a excepción de unos pocos casos, si se sigue y aplica lo visto en los artículos anteriores de Clean Code; me refiero a ponerle nombres con sentido a las entidades del software y a sus variables, a escribir funciones cortas que hagan una sola cosa y que la secuencia de llamados en la funciones vayan contando la historia, contando qué hace el software.

Como mencioné al comienzo del artículo, hay unas cuantas excepciones en las que el autor de Clean Code nos dice que nos podemos tomar el tiempo para escribir un comentario. ¿A que se refiere con tomarnos el tiempo?, se refiere a que cuando se escribe un comentario se debe hacer consciente de lo que queremos plasmar y hacerlo de  una forma que aporta información (comentario de calidad), ya que, muchas veces no nos tomamos el tiempo necesario y nuestros comentarios terminan convirtiéndose en desinformación que hace menos legible el código; un claro ejemplo es dejar código comentado, este código es obsoleto y los programadores que lo vean muy rara vez lo borran creyendo que hay algo importante en ellos, de esta forma perduran en el tiempo. Veamos cuáles son los casos en que debemos tomarnos el tiempo para escribir un comentario:

• Comentarios Legales, cabe aclarar que en lo posible se debe hacer referencia a una licencia estándar o a un documento externo y no poner todos los términos y condiciones en el comentario.
• Comentarios Informativos, solo cuando sea necesario, en los otros casos tratar de utilizar nombres con sentido.
• Explicar la Intención, pueden ayudar a entender porque un programador tomó una determinada decisión al escribir una línea o bloque de código.
• Clarificación, estos comentarios suelen utilizarse cuando se implementa alguna API estándar que no puede ser modificada.
• Advertir las consecuencias, en ocasiones determinado código debe escribirse estrictamente de una manera o hacer uso de algún componente, en estos casos es útil advertir la consecuencia si se modifica o cambia el código.
• Comentario TODO, estos comentarios hacen referencia a una tarea que el programador piensa que se debe hacer pero que no realizó, como por ejemplo, una implementación por hacer, un recordatorio para agregar o eliminar alguna función.
• Amplificación, estos comentarios buscan ampliar la importancia de un determinado fragmento de código con el fin de que no pase como irrelevante.
• Javadoc en API públicas, sólo cuando el API es pública se debe describir, pero se debe hacer con calidad, por esto quiero citar un consejo dado por el autor de Clean Code “los javadoc pueden ser tan ambiguos, amplios y descorteses como cualquier otro tipo de documento”.

Recuerden que antes de colocar un comentario nos debemos asegurar si no hay una mejor forma de escribir el código para evitar el comentario, por tanto quiero terminar con la frase con que comienza el capítulo de comentarios en el libro Clean Code.

 “No comente el código incorrecto, reescríbalo”

Brian W. Kernighan y P.J. Plaugher

Nota: Para más artículos relacionados ver Clean Code.

Principio de Abierto Cerrado

El principio Abierto/Cerrado hace parte del los principios SOLID y se considera a Bertrand Meyer como la persona que lo acuñó.

"Las entidades de software (clases, módulos, funciones, etc.) deben estar abiertas para su extensión, pero cerradas para su modificación"

Este principio busca no cambiar el código existente que funciona bien (Cerrado). ¿Pero si llegan nuevos requisitos? o ¿Si cambian los requisitos ya existentes?, ¿Qué hacer?, es ahí donde se debe poder extender el comportamiento de las entidades de software a través de la adición de nuevo código (Abierto).

Es claro entonces que para cumplir con este principio se debe:

• Estar Abierto para Extender

Con el pasar del tiempo, todo cambia, es inevitable que los requisitos de una aplicación no lo hagan, por eso cuando llega el momento, es conveniente poder cambiar el comportamiento y esto se logra a través de poder extender las entidades de software.

• Estar Cerrado para su Modificación

El código fuente de las entidades de software no debe modificarse, es decir, su código debe ser inmutable.

¿Cómo así que se debe cambiar el comportamiento, pero su código fuente no se debe cambiar?, ¿Esto cómo es posible?. Aunque todo esto parece confuso, contradictorio y hace que surjan muchas preguntas, en la programación orientada a objetos (POO) existe la herencia y como algunos lenguajes no permiten herencia múltiples, también existe la posibilidad de implementar interfaces o clases abstractas, con esto se puede extender las entidades de software, sin modificar el código fuente del padre (objeto de quien se hereda).

Con base en lo anterior ¿Qué estrategia utilizar?, en este punto surge la abstracción como la piedra angular de este principio, pues las entidades de software pueden utilizar una clase abstracta cuyo comportamiento está cerrado (que no se puede modificar), pero si en un futuro se quiere cambiar su comportamiento puede extenderse creando entidades de software que desciendan de dicha clase abstracta. La abstracción se centra en el que hace más no en el cómo lo hace, aislando los comportamientos específicos de una entidad, dejando que un desarrollador pueda sobreescribir o implementar dicho comportamiento como él lo desee.

Este artículo es un abrebocas y un pequeño resumen para este principio. Te invito al plato fuerte, a que profundices aún más, para esto te propongo que leas el siguiente artículo y en tus comentarios me cuentes tus impresiones. ¡No te vas a arrepentir de leerlo!:
http://web.archive.org/web/20060822033314/http://www.objectmentor.com/resources/articles/ocp.pdf

Principios SOLID

SOLID, es un acrónimo introducido por Robert C. Martin (autor de libro Clean Code y coautor del manifiesto Ágil), este acrónimo representa 5 principios claves en la programación Orientada a Objetos (POO). Veamos el acrónimo y a qué principios se refiere:

Single responsibility (Principio de Responsabilidad Única)
Open-Closed (Principio de Abierto/Cerrado)
Liskov substitution (Principio de Sustitución de Liskov)
Interface segregation (Principio de Segregación de la Interfaz)
Dependency inversion (Principio de Inversión de Dependencia)

Lo ideal es que conozcas y  utilices cada uno de estos principios a la hora de desarrollar software, debido a que nos ayudan a que nuestro diseño sea bueno, limpio y claro, obteniendo así aplicaciones fáciles de mantener y escalar, pues nos ayuda a lograr uno de los objetivos relevantes de la POO, el cual consiste en tener una alta cohesión (la clase debe enfocarse en hacer una sola cosa del sistema) y un bajo acoplamiento (la clase debe tener la menor cantidad de dependencias posibles).

Los principios SOLID en combinación con Clean Code te permitirán obtener aplicaciones fáciles de leer y comprender lo que ayuda a un más al momento de mantener, escalar y conseguir alta cohesión y un bajo acoplamiento; en pocas palabras, se complementan y se potencian mutuamente.

Clean Code Capítulo 3 Funciones

Al crear software debemos proporcionar mecanismos para llevar a cabo diferentes acciones, por esto aparecen las Funciones. En Clean Code, se hace énfasis en lo importante que es crear cada función para hacer una cosa, que vayan contando una historia y que cada una lleve a la siguiente. Si observamos secciones en funciones (por ejemplo declaraciones, inicializaciones y filtros), es una clara señal que la función hace más de una cosa, otro caso es cuando una función hace lo que dice que hace en su nombre, pero hace algo extra (se está incumpliendo la regla de hacer una cosa) generando un efecto secundario inesperado, siempre recordemos que las funciones son sin efecto secundarios, por lo tanto, si es necesario, se debe pensar en refactorizar. Una función debe responder a algo o hacer algo, pero no las dos cosas, de ahí que surge la separación de consultas de comando, el autor lo expresa de la siguiente manera "Su función debe cambiar el estado de un objeto o devolver información sobre el mismo, pero ambas operaciones causan confusión".

Al darles nombre no olvidemos el capítulo nombres con consentido, por esto se debe usar nombre descriptivos, que revelen la verdadera intención o acción de la función, una recomendación es utilizar verbos y palabras claves como por ejemplo writeField(name). write (Verbo), Field (Palabra Clave).

Cada función debe ser de tamaño reducido, ¿Cuántas líneas? no sabría decirte con exactitud, pero si nos basamos en el libro, este nos recomienda que tengan una longitud aproximada de 20 líneas, en estas líneas hay que prestar mucha atención a los bloques y sangrados. Cuando hablo de bloques hago referencia a fragmentos de códigos dentro de if, else, for y similares, en este caso la recomendación es que su longitud sea de una sola línea (lo más probable es que se invoque a otra función); en cuanto al nivel de sangrado no debe ser mayor a dos, ayudando a que haya un nivel de abstracción por función haciendo más fácil de comprenderla, con lo anterior se puede leer el código de arriba a abajo (la regla descendente). Esta regla consiste en posicionar las funciones por nivel de abstracción, como lo explican en Clean Code "Queremos que tras todas las funciones aparezcan las del siguiente nivel de abstracción para poder leer el programa, descendiendo un nivel de abstracción por vez mientras leemos la lista de funciones".

Otra parte clave en las funciones son sus argumentos, cuyo número ideal es cero, posteriormente uno (mónadico) y dos (diádico); se debe evitar las funciones de tres argumentos (triádico), las de más de tres argumentos (poliádico) deben tener una motivo especial. Las formas monádicas habituales son tanto para preguntar sobre el argumento o para transformar el argumento en otra cosa, un caso poco habitual es para eventos, en este caso las funciones por lo general no devuelven nada. En este punto el autor desaconseja utilizar argumentos de indicador (Pasar un booleano a una función) ya que de una forma u otra está indicando que la función hace más de una cosa. Para las funciones diádicas se debe propender que los argumentos sigan y tengan un orden natural, cuando estos carecen de dicho orden debe el programador utilizar los mecanismos necesarios para evitarlas. Cuando una función requiere dos o más argumentos se suele utilizar Objetos Como argumentos, pero esto no es una trampa, pues suele suceder que las variables antes pasadas como argumentos pertenezcan a un concepto más grande. Los nombres de los argumentos deben ser claros y acordes al contexto.

Algunas funciones tienen argumentos de salida, es decir, ver argumentos que en vez de ser entrada son salidas, estos argumentos deben evitarse.

El manejo de errores en una función en muchos casos se hace por medio de códigos de error, que suelen estar en una clase o varias lo que va creando alto acoplamiento y cuando surge un nuevo tipo de error, es donde viene los dolores de cabeza, por esto es mejor emplear excepciones que devolver código de error. Al utilizar excepciones es inevitable utilizar Try/Catch esto empieza a generar estructuras anidadas por eso es una buena práctica extraer bloques Try/Catch, esto quiere decir que se debe crear una función donde se procesa el error (dónde está la estructura Try/Catch, el procesamiento de errores es una cosa), desde esta se invocará la función que realizará la acción.

Antes de terminar quiero mencionar las instrucciones Switch, donde el autor hace una mención específica diciendo "Mi regla general para las instrucciones Switch es que se pueden tolerar si solo aparecen una vez, se usan para crear objetos polimórficos y se ocultan tras una relación de herencia para que el resto del sistema no las pueda ver. Evidentemente, cada caso es diferente y en ocasiones se puede incumplir una o varias partes de esta regla".

Las funciones nos ayudan a realizar acciones concretas, es nuestro deber evitar el no repetir código, por eso se deben crear con la mayor responsabilidad y dedicación y sin miedo a reescribir cuantas veces se crea necesario hasta que el resultado satisfaga las necesidades.

Nota: Para más artículos relacionados ver Clean Code.

Clean Code Capítulo 2 Nombres con Sentido (2/2)

Continuando con la segunda parte del capítulo 2, vamos a seguir viendo aquellas reglas para crear nombres correctos. Si aún no has visto la primera parte te invito para que la veas.

Nombres de clases: Los nombre de clases no deben ser verbos. Los nombres deben proporcionar de manera clara el propósito de la clase, por lo general debe ser un sustantivo, evitando nombres genéricos. Algunos ejemplos de nombres correctos serían: Persona, Direccion, Cliente. Algunos nombres incorrectos de clases podrían ser: Info, Procesador, CalcularNomina.

Nombre de métodos: Debe ser un verbo como por ejemplo, eliminar, agregar, guardar. Los métodos de acceso, modificación deben tener como nombre su valor y usar como prefijo get, set e is. Como recomendación el autor dice, que “Al sobrecargar constructores use métodos de factoría estáticos con nombres que describan los argumentos”

No se exceda con el atractivo: Esta regla hace referencia a no utilizar nombres provenientes de formas coloquiales de decir las cosas o de jergas, dejando a un lado la claridad, ya que, si llega un nuevo programador que no conozca estas formas de decir las cosas, se llenará de desinformación. 

Un nombre por concepto: Es simple, cuando nos decidimos por una palabra para representar un concepto, esta debe ser constante por todo el código y no utilizarse en unos lados y en otros no. Por ejemplo, no es conveniente utilizar en algunos nombres de métodos la palabra get y en otros retrieve. 

No haga juego de palabras: Se refiere a no utilizar una palabra con dos fines distintos, por ejemplo, digamos que en nuestro código hemos venido utilizando la palabra remove para nombrar métodos que inactivan, y en algún momento somos tentados a utilizar remove para hacer referencia a un método que elimina, en este caso sería mejor utilizar el nombre delete para el método en cuestión.

Usar nombres de dominio de soluciones: No es necesario que todos los nombres utilizados sean extraídos del dominio del problema, ya que, los lectores del código son programadores y ellos conocen o están familiarizados con términos informáticos, de patrones, y demás. Por ejemplo para un programador va a tener mucho sentido si una clase tiene el nombre de ListAdapter.

Usar nombre de dominios de problema: Cuando no se pueda cumplir la regla anterior porque no existe un término en el ámbito de programación, se debe recurrir a un nombre del dominio del problema. El autor nos dice “Separar los conceptos de dominio de soluciones y de problemas es parte del trabajo de un buen programador y diseñador”.

Añadir contexto con sentido: Cuando los nombres no tiene sentido por sí mismo, es necesario crearle un contexto que enriquezca dicho nombre, esto puede hacerse convirtiendo variables en parte de un concepto mayor, es decir, extraer una clase de la cual hagan parte o en una función o método que aporte un contexto. Como última instancia usar prefijos.

No añadir contextos innecesarios: Se refiere a no agregar en los nombres más información de la necesaria. Imagine una clase llamada DireccionResidencia y otra DireccionTrabajo, estos nombres no son realmente adecuados para una clase, lo mejor sería una clase Direccion y estos nombres serían ideales para nombre de instancias. Otro caso es agregar prefijo al nombre de las clases.

Como hemos visto en estos dos post acerca de nombres con sentido, el elegir un nombre adecuado para cada parte del código es fundamental, tanto para la legibilidad como para entender qué se hizo o qué se va a hacer. Para dar un nombre adecuado es necesario emplear habilidad descriptiva, gran vocabulario, conocimiento técnico y dejar los miedos, es momento de empezar a buscar mejores nombres, agregar o quitar el exceso de contexto, refactorizar el código, cambiando los nombres que no sean adecuados en el código existente.

Nota: Para más artículos relacionados ver Clean Code

Clean Code Capítulo 2 Nombres con Sentido 1/2

A medida que escribimos código es inevitable enfrentarnos a la tarea que aunque parece trivial no lo es, de asignar nombre a una variable, clase, paquete, archivo etc. Cuando digo que no es trivial, quiero hacer énfasis a su importancia y a que al poner un nombre se debe hacer con responsabilidad y profesionalismo (lógica, coherencia y mucho sentido), puesto que estos nombres empezarán a dotar de sentido al código mismo, y de eso nos daremos cuenta al momento que otros programados lo lean o hasta nosotros mismos cuando con el tiempo debamos realizar mantenimiento sobre este. El autor de Clean Code sabe esto, por tal motivo nos proporciona una serie de reglas básicas para crear nombres correctos.

Usar nombre que revelen las intenciones: Cuántas veces hemos encontrado una variable con nombre así: int a; ¿Esto te dice algo?, ¿Sabes para qué sirve la variable a o que significado tiene?, precisamente de eso se trata esta regla, dotar de significado y sentido a través de su nombre, por ello el autor nos dice “El nombre de una variable, función o clase debe responder una serie de cuestiones básicas. Debe indicar por qué existe, qué hace, y cómo se usa”. Veamos un ejemplo tomado de Clean Code.

Incorrecto

public List<int[]> getThem(){
List<int[]> list1 = new ArrayList<int[]>();
for(int[] x : theList)
if(x[0] == 4)
  list1.add(x);
return list1;
}
Correcto
public List<int[]> getFlaggedCells(){
List<int[]> flaggedCells = new ArrayList<int[]>();
for(int[] cell : gameBoard)
if(cell[STATUS_VALUE] == FLAGGED)
  flaggedCells.add(cell);
return flaggedCells;
}

Evitar la desinformación: En ocasiones damos nombre ambiguos o que pueden más que informar, desinformar, ya que, da pistas erróneas de lo que en realidad hace una función, variable o clase. En otras oportunidades tenemos variables casi con el mismo nombre donde solo las diferencia una pocas letras o una pequeña palabra, es decir, nombre con variaciones mínimas. Estos casos nos dificultan la lectura del código, razón por la que debemos mejorar en dicho aspecto. Veamos unos ejemplos.

Incorrecto	Correcto	Explicación
tmp	temperatura	Algunos pensaran que tmp, hace referencia a temporal o tiempo
lugarXCoordenadas lugarYCoordenadas	coordenadasOrigen corrdenadasDestino	los nombres tienen forma similar
o	-	Nombrar una variable como o puede hacer que se confunda con el cero, al igual que no brinda ninguna información

Realizar distinciones con sentido: Esta regla va de la mano con la anterior cuando se habla de no tener nombre con variaciones mínimas, debido a que esta regla propone que a dichos nombres se le agregue aparte de una notable variación, sentido, como lo dice el autor “Si los nombres tienen que ser distintos, también deben tener un significado diferente”. Imaginemos que tenemos en una función que recibe dos variables num1, num2, lo primero que notamos es que en sus nombres no tienen una gran diferencia y segundo no da mucha información, ahora, si esta función lo que hace es dividir el primer parámetro (num1) con respecto al segundo (num2), tendría mas sentido llamarlos dividendo y divisor respectivamente.

Usar nombres que se puedan pronunciar: Cuántas veces haciendo mantenimiento al código tienes que dirigirte a un colega para alguna explicación o aclaración, cómo le dirías, o mejor, cómo pronunciarías la variable llamada genymdhms (fecha de generación, año, mes, día, hora, minuto y segundo), ¿no crees que es mejor generationTimestamp? - Ejemplo tomado del libro Clean Code -. Quizás tu colega no te entienda o tenga que ver con sus propios ojos de que le estás hablando, de ahí la importancia de colocar nombres que puedas pronunciar; la programación es una actividad social.

Usar Nombres que se puedan buscar: Aunque es una regla muy lógica, solemos pasar por alto y cuando debemos buscar una variable llamada t, en todo un proyecto o solo en una clase de muchas líneas obtendremos muchos falsos positivos, no sería más fácil buscar una variable llamada TEMPERATURA_MAXIMA_PERMIDA, siendo esta una constante.

Evitar codificaciones: Crear codificaciones para nombre supone una carga extra que debemos aprender y por lo general son difíciles de pronunciar lo que estaría rompiendo la regla de Usar nombres que se puedan pronunciar.

Notación húngara: El autor nos quiere decir que este tipo de notación o codificación en la actualidad no es necesaria y lo que genera son obstáculos que dificultan la lectura del código. Pero, ¿qué es la notación húngara?, es un sistema utilizado para crear los nombres de las variables, este sistema utiliza prefijos para indicar el tipo de dichas variables, por ejemplo, se utiliza el prefijo b para las variables booleanas (bIsCanceled).

Prefijo de miembros: Ya no es necesario utilizar esa práctica que aconsejaba agregar el prefijo m_ a los nombre de variables, los entornos actuales nos permite identificar los miembros ya sea que los resalta o les cambia el color.

Interfaces e implementaciones: Agregar adornos a los nombre de las interfaces (por ejemplo una I inicio del nombre), es agregar más información de lo necesario, y en caso de necesitar implementar dicha interfaz se puede agregar el sufijo Impl, por ejemplo, si tenemos la Interfaz Presenter (note que no la llame IPresenter) su implementación podría llamarse PresenterImpl.

Evitar asignaciones mentales: La asignación mental ocurre cuando el nombre de una variable debe ser traducido mentalmente por quien lee el código para relacionar con algún término del dominio, este problema es habitual con nombres de variables de una sola letra.

Nota: Como el post se está haciendo muy extenso y no quiero cansarte, he decidido tomar aquel consejo de "divide y vencerás". Por tal razón terminaré de contarles acerca del capítulo 2 de Clean Code en el siguiente post (Clean Code Capítulo 2 Nombres con Sentido (2/2)). Para más artículos relacionados ver Clean Code

Clean Code Capítulo 1 Código Limpio

El capítulo 1 trata brevemente distintos puntos partiendo del código incorrecto, que no es más que código sin sentido, y que lastimosamente es el que más abunda en nuestras aplicaciones. Estamos hablando de código que a simple vista no deja ninguna pista de que hace o para qué sirve y por esa razón perdemos tiempo buscando su significado o buscandole sentido. Lamentablemente, estoy de acuerdo con el autor cuando dice que “Todos hemos sentido alivio de ver cómo un programa incorrecto funcionaba y hemos decidido que un mal programa que funciona es mejor que nada” y hemos postergado su solución (Ley de LeBlanc: Después es igual a nunca). Con el pasar del tiempo vemos como los problemas se van agravando y se reflejan en el costo, principalmente de tiempo (El equipo es menos productivo), pero todos sabemos que el tiempo es oro, por ende, este tiempo que nos cuesta mantener el código incorrecto (ningún cambio es trivial) se convierte en dinero y puede significar hasta la muerte de un proyecto. Por lo anterior, quiero citar al autor cuando dice “ya sabrá que dedicar tiempo a que el código sea correcto no solo es rentable, es una cuestión de supervivencia profesional”. En pocas palabras, nos llenamos de código incorrecto, pero ¿Porque ocurre esto? la respuesta está en el libro cuando declara que la culpa es nuestra, ya que, “No somos Profesionales” y no debemos descargar nuestra responsabilidad en los demás pues “Tampoco sería profesional que los programadores cedieron a la voluntad de los jefes que no entienden los riesgos de un posible desastre”. 

Seguidamente, profundiza en lo que es código limpio o de su concepto, mostrando una serie de definiciones dadas por grandes programadores como Bjarne Stroustrup, inventor de C++. Interiorizando todas estas definiciones, he llegado a la siguiente definición de código limpio:

“Código con sentido, concreto, dotado de características como la simplicidad, eficiencia, legibilidad, sencillez, debe estar testeado, tener dependencias mínimas y hacer una cosa bien (este último tomado de la definición de Bjarne Stroustrup) ”

Por último, habla brevemente de la regla del Boy Scout, que en pocas palabras es entregar el código más limpio de lo que lo hemos recibido.

Este capítulo nos invita a que abramos nuestros ojos para ver la posible falta de profesionalismo que nos invade al momento de crear código y empecemos el cambio para escribir código limpio, buscando así ser profesionales en esta área. ¡Ya diste el primer paso!, que suele ser el más difícil. Sigue caminando.

Nota: Para más artículos relacionados ver Clean Code

Clean Code - Código Limpio

El desarrollo de software es algo que me apasiona, particularmente la programación, lo que me ha llevado últimamente a querer dar un paso más hacia la profesionalización en este ámbito. Por tal motivo he empezado a estudiar sobre patrones de arquitectura y de diseño en lo que respecta al software, e indagar sobre el concepto de Código Limpio (Clean Code); por lo anterior inicié leyendo el libro Clean Code de Robert C. Martín, y me he animado a escribir sobre lo que voy conociendo con la lectura del mismo, una serie de artículos acerca de mis impresiones sobre el libro.

Por ahora quiero citar una frase que he visto que relacionan con este libro y es que “Todo programador debe leerlo”, cuando leí por primera vez esta frase fui un poco escéptico, pero al ir devorando cada una de las páginas e ir interiorizando poco a poco sus conceptos me ha convencido, por eso inició invitandote a leer este libro, lleno de pequeños y simples detalles que hacen grandes cambios, apoyado en lo escrito por James O. Coplien en el prólogo “Que dichas acciones sean simples no significan que sean simplistas, y mucho menos que sean sencillas”.  

Manos a la obra, tienes mucho que leer, interiorizar, cambiar y ajustar. El camino es largo pero interesante y muy gratificante en cuanto empiezas a ver los resultados. Muy pronto, a medida que vaya leyendo más sobre este grandioso libro, estaré publicando al respecto y actualizando este post con los enlaces a los respectivos artículos.

Artículos Relacionados

• Clean Code Capítulo 1 (Código Limpio)
• Clean Code Capítulo 2 (Nombres con Sentido 1/2) 
• Clean Code Capítulo 2 (Nombres con Sentido 2/2)
• Clean Code Capítulo 3 (Funciones)
• Clean Code Capítulo 4 (Comentarios)
• Clean Code Capítulo 5 (Formato)

Te dejo acá una referencia en donde puedes comprar la versión en español o lo puedes mirar acá en Amazon.

Agilismo: Una Historia de Otro Planeta

Qué mejor que explicarlo con una breve historia.

Había una vez, en una galaxia no muy lejana, un planeta llamado Software en donde sus habitantes practicaban una extraña magia de conjuros, códigos misteriosos y algoritmos, los cuales daban vida desde los más simples hasta los más locos, atrevidos e innovadores sueños. A la gente de este planeta se les llamaba programadores. Con el pasar de los años las prácticas y métodos utilizados por estos hechiceros y magos para construir aplicaciones (así se le llamaba al producto de la magia que ahí se practicaba) fueron generando descontento e infelicidad en algunas latitudes del planeta Software parcializando a su población, por un lado los que apoyaban las antiguas prácticas y por otro los que querían buscar nuevas formas de hacer las cosas. De este grupo de los que querían buscar nuevas formas de hacer las cosas a través de la experimentación de nuevos e innovadores métodos surge un grupo de grandes hechiceros que se reunieron para consolidar su legado en un manifiesto que proclamaron como el Manifiesto Ágil, escrito lleno de principios sabios que hablan de colaboración, flexibilidad, calidad y motivación, y resumido en cuatro valores que dieron vida  a una nueva magia, poderosa, envolvente y sobre toda llena de felicidad. Lo que desconocían estos grandes hechiceros es que eso que hicieron ese día, daría origen a una importante hermandad (Agilismo) conformada por nuevos y viejos hechiceros, programadores (Agilistas) motivados, con deseos de experimentar, de colaborar creando y utilizando métodos de nombres místicos como Scrum, Kanban, Lean y lean Startup, para construir aplicaciones. De esta manera en el planeta Software todos fueron felices, puesto que nació el agilismo como un nuevo estilo de vida, una filosofía, una actitud, un movimiento, una hermandad de hechiceros que adoptaron los principios y valores del Manifiesto Ágil que los ayuda a construir un software que aporte valor y competitividad, y sobre todo que los hace feliz. Para terminar esta historia espacial debo decir que fue tan poderosa esta filosofía que traspasó los límites del planeta Software llegando hasta otros planetas como el Financiero, donde nadie nunca pensó que llegaría, pero así fue y cada uno de estos planetas fueron dejándose envolver por su poder generador de un cambio orgánico desde su estructura hasta su visión y por su magia de cambiar a las personas haciéndolas más productivas, colaboradoras, flexibles, amables y felices.

Si después de esta historia te preguntas qué dicen esos cuatro valores y en general el Manifiesto Ágil te lo dejo a continuación: “aunque valoramos los elementos de la derecha, valoramos más los de la izquierda.” Los valores son:

• Individuos e interacciones sobre procesos y herramientas.
• Software funcionando sobre documentación extensiva
• Colaboración con el cliente sobre negociación contractual
• Respuesta ante el cambio sobre seguir un plan

Los doce principios del Manifiesto Ágil son los siguientes:

1. Nuestra mayor prioridad es satisfacer al cliente mediante la entrega temprana y continua de software con valor.
2. Aceptamos que los requisitos cambien, incluso en etapas tardías del desarrollo. Los procesos Ágiles aprovechan el cambio para proporcionar ventaja competitiva al cliente.
3. Entregamos software funcional frecuentemente, entre dos semanas y dos meses, con preferencia al periodo de tiempo más corto posible.
4. Los responsables de negocio y los desarrolladores trabajamos juntos de forma cotidiana durante todo el proyecto.
5. Los proyectos se desarrollan en torno a individuos motivados. Hay que darles el entorno y el apoyo que necesitan, y confiarles la ejecución del trabajo. 
6. El método más eficiente y efectivo de comunicar información al equipo de desarrollo y entre sus miembros es la conversación cara a cara.
7. El software funcionando es la medida principal de progreso.
8. Los procesos Ágiles promueven el desarrollo sostenible. Los promotores, desarrolladores y usuarios debemos ser capaces de mantener un ritmo constante de forma indefinida.
9. La atención continua a la excelencia técnica y al buen diseño mejora la Agilidad.
10. La simplicidad, o el arte de maximizar la cantidad de trabajo no realizado, es esencial.
11. Las mejores arquitecturas, requisitos y diseños emergen de equipos auto-organizados.
12. A intervalos regulares el equipo reflexiona sobre cómo ser más efectivo para a continuación ajustar y perfeccionar su comportamiento en consecuencia.

El Agilismo es un camino que te invito a iniciar, es muy fácil de empezar, pues ya diste el primer paso al leer este post y conocer los valores y principios del Manifiesto Ágil, ahora da el siguiente investigando aún más sobre él, te darás cuenta que ya está en casi todas partes y cuando menos te des cuenta estarás caminando por sí solo hacia la adopción de sus valores y principios, que básicamente de eso se trata. Déjate atrapar por su magia que puede transformar a una persona en alguien mejor y lo mismo le ocurre a las organizaciones cuando se toma con seriedad, responsabilidad y compromiso el agilismos, haciéndolas más productivas, flexibles y competitivas. Lo mejor es que no importa de qué sector o industria sea, si en ella trabajan personas el agilismo es para ellas, la base del agilismo son las personas.

Para ir terminando debo decir que ya ha pasado cierto tiempo desde que el Manifiesto Ágil vio la luz del día por primera vez, las personas, las empresas y un par de cosas más han cambiado en especial el sector al que fue dirigido inicialmente el Manifiesto Ágil. No estoy intentando decir que ya es obsoleto o que no es aplicable en otros sectores, pues me contradiría, ya que, acabo de decir que el agilismo ha traspasado las fronteras del Software y que el conocimiento del mismo es el comienzo al agilismo. Lo que pretendo es hacer un preámbulo acerca de un nuevo enfoque que ha surgido a raíz de que el Manifiesto Ágil no fue elaborado pensando en las dimensiones que ha tomado hoy en día el agilismo.

Este nuevo enfoque que se ha denominado Agilidad Moderna. Este nuevo enfoque del agilismo cuyo padres es Joshua Kerievsky (@JoshuaKerievsky) y del cual escuche por primera vez en la primera Jornadas Nacionales de Metodologías Ágiles - Ágiles Colombia 2016 y que volví a escuchar en una excelente charla de Johnny Ordoñez (@JohnnyOrdonez) en Agiles 2016 en Quito Ecuador, no busca reemplazar el Manifiesto Ágil sino que busca potenciarlo y hacer las cosas más simples, según Joshua Kerievsky "Agilidad Moderna es una comunidad de personas interesadas en descubrir mejores maneras de conseguir resultados impresionantes. Se aprovecha la sabiduría de muchas industrias, es impulsado por principios y un marco de trabajo libre". Sus cuatro principios son:

Como ya me he extendido un poco en este post los invito a que profundicen más acerca de este tema en la página oficial de:

Manifiesto Ágil

Agilidad Moderna

Introducción a la Agilidad Moderna

NOTA: Si no sabes que es Ágiles 2016 te cuento que “son conferencias sin fines de lucro organizadas por representantes de todas las comunidades ágiles latinoamericanas”, el próximo año Agiles 2017 se realizará en Chile, desde ya te invito.

¡Me acabo de enterar del Agilismo! ¿A quien sigo?

Cuando uno empieza un camino, ya sea para aprender algún marco de trabajo, una metodología, un lenguaje de programación, nuevas recetas de cocina o sea lo que sea que se quiera aprender siempre es bueno empezar teniendo un punto de referencia, alguien a quien seguir para no perdernos en el camino, es por esto que en este documento que hace un poco empecé a elaborar y espero que ahora entre todos de forma colaborativa elaboremos, enriquezcamos y hagamos una fuente para aquellos que apenas empiezan, he agregado a usuarios de Twitter de algunos agilistas de Colombia, de latinoamérica y unas cuantas personas más del resto del mundo.

Es un buen comienzo para aquellos que empiezan a concocer el mundo del agilismo y que no saben a quién seguir, ya que, a partir de ahí pueden empezar a seguir a estos agilistas y a conocer a quienes siguen ellos con el fin de contactar a otros agilistas. También encontrarán links a documentos o páginas donde pueden empezar a leer sobre agilismo y sobre algunos framework como Scrum y por supuesto está el link de la página de Agiles Colombia así como la dirección de meetup de Ágiles Colombia y Ágiles Ocaña donde podrán encontrar personas dispuestas a colaborar. No olviden que una parte de la esencia del Manifiesto Ágil y por ende del agilismo es la Colaboración. Cabe recalcar que me pueden escribir y consultar o pedir cualquier ayuda que si yo directamente no les puedo ayudar me uniré a su causa en busca de aquella persona que pueda ayudarnos (recuerda me uní a tu causa).

Mira el Documento Acá
Ágiles Colombia
Meetup Ágiles Colombia
Meetup Ágiles Ocaña

No olviden que si quieren pueden hacer su aporte a este documento agregando la información que creas relevante para aquellos que empiezan el camino del agilismo. 

Guía para la Retrospectiva

Antes de iniciar con la guía par ala retrospectiva acá les dejo la referencia a otro Post donde mención una guía previa a la retrospectiva.  

https://cedaniel200.blogspot.com.co/2016/06/que-hacer-antes-de-una-retrospectiva.html

Ahora sí, manos a la obra.

La retrospectiva debe hacerse al final de cada sprint, en donde el Equipo scrum se reúne con el propósito de revisar el proceso, relaciones entre las personas y herramientas utilizadas. Identificando lo que ha salido bien y lo que no, con el fin de buscar soluciones. Al final se diseña un plan para mejorar las cosas a futuro. La duración recomendada de la Retrospectiva del Sprint es una hora por cada semana de duración del Sprint.

Material Necesario

• Marcadores, Lápices o bolígrafos.

• Post – its

• Product Backlog

• Sprint Backlog

• Graficas del proyecto

Actividades

Cada una de las actividades debe acotarse en el tiempo sin que la suma de las mismas supere el tiempo total de la duración de la retrospectiva.

1. Aspectos Generales: Se explica el fin de la retrospectiva, actividades y sus tiempos.

2. Identificando Problemas: Esta actividad consta de diferentes momentos los cuales son:

a. El facilitador hace un resumen de lo sucedido en el sprint apoyándose de los datos (Product Backlog, Sprint Backlog, graficas etc.). 

b. Los miembros del equipo mencionan los problemas que ellos crean y se anotan en los post-its ubicándolos en un lugar visible para todos.

c. Los post-its se deben agrupar según una afinidad o relación, cada uno de estos grupos de problemas deben tener un nombre representativo.

d. Cada miembro del equipo vota, para esto cuenta con cierto número de puntos (Se recomiendan 10 por miembro) que debe repartir entre los grupos que el considere que afectan más a los objetivos.

3. Descubriendo Causas: La entrada de esta actividad son los grupos generados de la actividad anterior, cabe mencionar que no se buscan culpables sino revisar cada uno de los engranajes (partes del proceso de trabajo, de interrelaciones y de colaboración) del proceso para identificar que está fallando. Se toman los grupos más votados y para cada uno de estos grupos se analiza su causa para ello se utiliza un diagrama de espina de pez o Ishikawa. 

Como se ve en la imagen el problema es el centro en este caso la espina dorsal y cada causa se va desplegando como espinas a partir de la dorsal o de otras causas, hasta encontrar las causas básicas.

4. Plan de Acción: En esta actividad surgen las propuestas de mejora para solucionar las causas que producen los problemas que ha afectado el sprint evaluado. Para esto cada miembro del equipo escribe sus soluciones en post-its, luego entre todos seleccionan las que se implementaran en los Sprint venideros. Lo anterior puede generar actividades o tareas necesarias para llevar a cabo las propuestas seleccionadas, esta lista de tareas son anotadas en post-its y puede ocurrir una o varias de las siguientes opciones:

a. Los miembros de quipo se autosignan la responsabilidad de ejecutar las tareas

b. Las tareas se agregan en el Product Backlog

c. Las tareas se agregan en el Sprint Backlog

5. Que ha salido bien: Cada miembro escribe en post-its lo que cree que ha salido bien, luego en grupo se analiza cada post-its, llegando a conclusión si en realidad ha salido bien y si es así cuál ha sido el motivo por el cual ha salido bien, para seguir haciéndolo así  o reforzarlos en caso de ser necesario.

6. Conclusiones: Se exponen las conclusiones a las que se ha llegado a medida que ha transcurrido la retrospectiva y si se ha cumplido o no con el objetivo de la misma.

7. Retrospectiva de la Retrospectiva: Brevemente se analiza si la reunión de retrospectiva ha salido bien. Que aspectos faltan por mejorar, que aspectos han estado bien y que aspectos se deben reforzar.

EJEMPLOS

A continuación se mencionan los tiempos para cada una de las actividades tomando como referencia un sprint de 15 días es decir dos semanas, lo cual nos da una retrospectiva de máximo dos horas de duración o 120 minutos.

1. Aspectos Generales: Duración de 8 minutos.

2. Identificando Problemas: Duración de 30 minutos.

3. Descubriendo Causas: Duración de 20 minutos.

4. Plan de Acción: Duración de 20 minutos.

5. Que ha salido bien: Duración de 25 minutos.

6. Conclusiones: Duración de 10 minutos.

7. Retrospectiva de la Retrospectiva: Duración de 7 minutos.

REFERENCIAS

http://www.scrumguides.org/docs/scrumguide/v1/Scrum-Guide-ES.pdf

https://proyectosagiles.org/2008/10/21/retrospectiva-agil-scrum/

http://eventos.kleer.la/public_events/813/watch/17047

¿Que hacer antes de una retrospectiva?

Se acerca la hora de la retrospectiva y estas a cargo de ella y no sabes como prepararte ni prepararla.

Acá  te dejo una Guía que te servirá tanto para organizarla como para llevarla acabo. También les dejo un Vídeo que habla sobre la retrospectiva en general pero en la cual en los primeros 11 minutos explican la guía.

Espero les sirva y buena suerte con la retrospectiva.

Guía       http://guiasagiles.org/#SesionesDeMejora
Vídeo     http://eventos.kleer.la/public_events/813/watch/17047

Adicionalmente acá les dejo un Post sobre como llevar la retrospectiva.

https://cedaniel200.blogspot.com.co/2016/06/guia-para-la-retrospectiva.html