Script: Top ten de buenas prácticas

En este post voy a comentar las buenas prácticas que debemos tener en cuenta a la hora de realizar scripts, sobre todo en un ámbito empresarial.
Siempre que tenemos diversos sistemas operando es necesario realizar tareas repetitivas o simplemente aburridas que podemos delegarle a un script.

Como toda actividad siempre hay ciertos secretos que hay que conocer y que es bueno tener en cuenta.
Paso a enumerara la lista de "tips" que considero debemos tener en cuenta:

1. Universal: Debe estar escrito en ingles para que pueda compartirse con cualquier "compañero" en el mundo. Incluso trabajando en una empresa pequeña, es bueno seguir estos patrones, ya que si el día de mañana pasamos a trabajar en otra empresa podemos utilizarlo y compartir facilmente.
2. Especializado: Cada script debe realizar una función bien especifica de forma correcta. Es preferible tener dos o tres scripts para nuestras tareas que uno gran script que supuestamente hace todo. A la hora de modificarlo o debuguearlo puede convertirse en un problema.
3. Auto describible: El nombre del archivo debe hablar por si solo, debe tener un nombre bien conciso y representativo de lo que realiza
4. Versionado: Tanto en el interior como en el nombre del archivo, debemos incluir una versión, recomiendo utilizar la dominación vm.n (ejemplo: v0.1)
5. Explicativo: Al abrir el script lo primero que debemos mostrar es: description, version, author, y de ser posible changeLog. La descipcion debe ser completa pero bien concisa, obviamente en inglés. Author incluye nombre completo e email. El changeLog en muy pocas palabras las modificaciones realizadas en cada versión.
6. Parametrizado:Las variables que utilicemos en el script deben estar definidas al principio de script y con una valor asignado. También es bueno confirmar al usuario estas variables al ejecutar el mismo.
7. Comentado: Cada bloque del script debe estar indicado para una fácil depuración y entendimiento del script.
8. Enfocado: Arrancar a escribir un script siempre utilizando estas buenas prácticas desde cero.La realidad es que si no lo hacemos desde cero, cuando terminemos y el script este andando no vamos a querer modificarlo todo solo para agregarle cositas lindas. Si usamos estas buenas prácticas nos vamos a convencer de que es bueno usarlas desde el inicio.
9. A prueba de errores: Siempre tener en mente mientras escribimos que las cosas pueden malir sal, por eso tengamos que cuenta esto y controlemos los posibles errores... tanto del usuario como del sistema o entorno.

Do!

1. Compartirlos: muchas veces las mejoras ideas son de otros, hay que estar abiertos y compartir el trabajo, para que hacerle perder tiempo al resto con algo que ya alguien hizo?

Don´t!

1. Inseguro: No poner contraseñas en los scripts, es tan simple como definir un input box para que el usuario la ingrese. En caso de que el script deba correr automáticamente podemos introducirla en forma de hash o utilizar clave publicas/privadas (según el SO donde los escribamos hay diferentes alternativas)