Anexo A: Metodología

Por una nueva metodología en la creación de una tesis doctoral.

Características del modelo

• Repositorio de versiones y trazabilidad de las modificaciones.
• Publicación online desde su inicio.

Generación de documentación

La documentación del proyecto (esta documentación que está leyendo) se genera mediante la utilización de las siguientes herramientas y en los siguientes formatos:

1. Crear directorio raíz de la documentación con Sphinx:

   $ sphinx-quickstart

2. Dentro del directorio raíz creado, el texto se escribe en formato restructured text en diferentes archivos, cada uno correspondiente a un capítulo. Se utilizan diversos directorios en los que se agrupan los archivos de temática relacionada, por ejemplo, los anexos y dentro de éstos, las normas:

   /anexos
   /anexos/bibliografia.txt
   /anexos/index.txt
   /anexos/metodologia.txt
   /anexos/normas
   /anexos/normas/2003-11-17_D-2003-98-CE_reutilizacion-informacion.txt
   /anexos/normas/2007-11-16_l-37_reutilizacion-informacion.txt
   /anexos/normas/2008-03-31_o-956-fomento_informacion-geografica.txt
   /anexos/normas/index.txt

   El editor que se utiliza es emacs 22 sobre un sistema operativo GNU/Linux, si bien puede utilizarse cualquier editor que permita archivar en texto plano.

3. Para crear la documentación del proyecto en formato html:

   $ make html

   Nota

   La documentación en formato html podrá encontrarla en un directorio que se habrá definido al configurar Sphinx, normalmente el directorio .build/html

4. Para crear la documentación en formato ps o pdf, primero hay que generar las fuentes en latex y después transformar latex en ps o pdf:

   $ make latex
   $ cd .build/latex
   $ make-all ps # para generar archivo ps
   $ make-all pdf # para generar archivo pdf

Publicación de la documentación

Una vez creada la documentación, para publicarla en la web se seguirán los siguientes pasos:

1. Actualizar el repositorio subversion remoto:

   $ svn ci -m "Actualización de ..."

2. Actualizar la copia remota del repositorio:

   $ fab svn_update

3. Generar la documentación en el repositorio remoto:

   $ fab make_docs

Externalización parcial del proyecto

La Ontología jurídica libre es uno de los proyectos del Laboratorio del Procomún coordinado por Antonio Lafuente en el seno de Medialab-Prado, dependiente del Ayuntamiento de Madrid.

Seguimiento del proyecto

La postura que ha de tomarse con respecto al seguimiento de un proyecto debe ser proactiva: se debe dotar al sistema con unas herramientas que hagan fácil conocer en tiempo real las modificaciones según se efectúan. De esta manera, se hallan implantados los siguientes recursos:

1. El envío automático de un correo electrónico a la lista de desarrollo del proyecto cuando se realiza un envío al repositorio (un commit). La lista de correo es pública, por lo que cabe apuntarse para recibir las actualizaciones del código o bien consultar la interfaz web del gestor de listas de correo.

2. Feeds rss. El gestor de proyectos Trac dispone de feeds en formato rss. Se puede realizar el seguimiento sindicando el feed de revisiones:

   Feed de revisiones.

También es interesante publicar un registro de cambios en formato ChangeLog, que en este caso es gestionado automáticamente por Trac mediante la emisión de un archivo en dicho formato, accesible en:

http://derecho-internet.org/proyectos/kelsen/log/?limit=100&mode=stop_on_copy&format=changelog

Licencia adecuada para los fines

La licencia utilizada para la documentación es Creative Commons By-SA. Para el código fuente de la aplicación se ha elegido la licencia AGPL.

Estado del arte de las herramientas utilizadas

• Sistemas de publicación online.
• Utilización de software de documentación de proyectos: Sphinx
• Instalación de extensión autodoc.
• Implantación del software utilizado.