En este articulo les voy a comentar como armaba las notas de lanzamiento o
release notes de un proyecto en una página del wiki de
Trac (
Trac un software de administración de proyectos
web que
recomendé anteriormente).Antes, un poco de
teoría de las notas de lanzamiento, conocidas como
Release notes o
changelog en ingles. Cada vez que uno saca una nueva
versión de un producto de software, ya sea esta una
aplicación de escritorio o una
aplicación web hay que sacar notas de lanzamiento, para informarle al cliente o al receptor del producto en que se diferencia la
versión entregada con las anteriores (
también se hace cuando se entrega la primera
versión del producto, el que no haya una
versión anterior no quita de que haya que escribir las notas de lanzamiento).
En un proyecto en el cual
teníamos que desarrollar una
aplicación web que soportaba la
creación de una
librería de software, el desarrollo de esta
aplicación era incremental. Cada
versión que
sacábamos editábamos una pagina wiki en
Trac, incluyendo lo siguiente:
Nombre del producto - Versión x.x - Fecha de lanzamiento: x/x/x
- Nuevas funcionalidades: Estas son las mejoras o nuevas funcionalidades acordadas para esta versión.
- Defectos corregidos: Estos son defectos que fueron encontrados en versiones anteriores y fueron arreglados para esta versión.
- Problemas existentes ('known issues'): Estos en especial conviene consensuarlos anteriormente con el cliente, para que no se lleve sorpresas. Es posible que se decida retrasar el lanzamiento de la versión para que se resuelva algún problema existente. Estos también podrían denominarse defectos no corregidos, pero esa nomenclatura es mas dañina.
Alguna (o mas de una) de las secciones anteriores puede estar
vacía.
Además de tener esta pagina wiki
dábamos la
opción de descargar un archivo
DOC con la misma
información, el cual era guardado en el repositorio.
Lo mas importante de esto es que cada una de las funcionalidades nuevas, los defectos y los problemas existentes esta cargado en la lista de tareas (o
tickets) del
trac, y
automáticamente son
referenciados de esta pagina. Para
referenciar un
ticket, basta solo con escribir #
xx, siendo
xx el numero del
ticket, y el enlace se creara
automáticamente. Esto es muy importante para que cualquier persona pueda ir
rápidamente a ver de que se trata cada
ítem de las notas.