Documentacion en Staruml

3
UNIVERSIDAD NACIONAL DE HUANCAVELICA 2013-II EAPS STARUML En todo proceso de ingeniería software, es necesario definir los requisitos y, a partir de ellos, definir la solución tecnológica. Este proceso, se realiza mediante una serie de metodologías de desarrollo que definen un conjunto de actividades y un conjunto de artefactos, con los cuales, son utilizados como inputs u outputs para cada actividad dentro del proceso de desarrollo. No es objetivo de la presente entrada entrar en el detalle de metodologías, como pueden ser por ejemplo, las metodologías ágiles XP o SCRUM o cualquier otra. De las herramientas de modelado libres que conozco: Argo, Poseidom y StarUML; me decanto por ésta último por los siguientes razones: Es una herramienta OpenSource Es una herramienta de modelo UML que permite modelar con la versión 1.0 y 2.0 Es una herramienta muy sencilla de utilizar e intuitiva. El proceso de instalación de plugins es muy sencillo. Es una herramienta que permite generar documentación de una forma muy sencilla a partir de una plantilla Word que definamos. A pesar de estas razones, ninguna herramienta es perfecta, presentando, desde mi punto de vista, las siguientes desventajas: Es una herramienta que solo se encuentra en entornos Windows. La generación de código es muy pobre. A pesar de ello, desde mi punto de vista y por la experiencia con cada una de ellas, es la que más me gusta. No obstante, soy consciente de la existencia de otras herramientas, en cuyo caso, invito al lector que las identifique mediante un comentario en el blog. Instalación y configuración de StarUML Al ser una aplicación Windows, el proceso de instalación consiste en la ejecución del ejecutable de instalación; el cual, tras las correspondientes pantallas de instalación, instala la herramienta en la ruta que se desee. Una vez instalada la herramienta, está lista para utilizarse. Existen varios módulos que pueden configurarse, localizados en el siguiente enlace http://staruml.sourceforge.net/en/modules.php, de los cuales destaco: módulo

description

aplicación de UML

Transcript of Documentacion en Staruml

  • UNIVERSIDAD NACIONAL DE HUANCAVELICA 2013-II

    EAPS

    STARUML

    En todo proceso de ingeniera software, es necesario definir los requisitos y, a partir de

    ellos, definir la solucin tecnolgica. Este proceso, se realiza mediante una serie de

    metodologas de desarrollo que definen un conjunto de actividades y un conjunto de

    artefactos, con los cuales, son utilizados como inputs u outputs para cada actividad dentro

    del proceso de desarrollo. No es objetivo de la presente entrada entrar en el detalle de

    metodologas, como pueden ser por ejemplo, las metodologas giles XP o SCRUM o

    cualquier otra.

    De las herramientas de modelado libres que conozco: Argo, Poseidom y StarUML; me

    decanto por sta ltimo por los siguientes razones:

    Es una herramienta OpenSource

    Es una herramienta de modelo UML que permite modelar con la versin 1.0 y 2.0

    Es una herramienta muy sencilla de utilizar e intuitiva.

    El proceso de instalacin de plugins es muy sencillo.

    Es una herramienta que permite generar documentacin de una forma muy sencilla a

    partir de una plantilla Word que definamos.

    A pesar de estas razones, ninguna herramienta es perfecta, presentando, desde mi punto

    de vista, las siguientes desventajas:

    Es una herramienta que solo se encuentra en entornos Windows.

    La generacin de cdigo es muy pobre.

    A pesar de ello, desde mi punto de vista y por la experiencia con cada una de ellas, es la

    que ms me gusta. No obstante, soy consciente de la existencia de otras herramientas,

    en cuyo caso, invito al lector que las identifique mediante un comentario en el blog.

    Instalacin y configuracin de StarUML

    Al ser una aplicacin Windows, el proceso de instalacin consiste en la ejecucin del

    ejecutable de instalacin; el cual, tras las correspondientes pantallas de instalacin,

    instala la herramienta en la ruta que se desee. Una vez instalada la herramienta, est lista

    para utilizarse.

    Existen varios mdulos que pueden configurarse, localizados en el siguiente

    enlace http://staruml.sourceforge.net/en/modules.php, de los cuales destaco: mdulo

  • UNIVERSIDAD NACIONAL DE HUANCAVELICA 2013-II

    EAPS

    Word Template Designer v1.0, para la generacin de documentacin; y, mdulo

    Notation Extension Examplo ER Diagram, para la creacin de diagramas de entidad

    relacin. La configuracin de estos mdulos consiste en lo siguiente: descargar el fichero

    comprimido del mdulo y, para la instalacin, descomprimir dicho fichero en la carpeta de

    mdulos de la carpeta de instalacin de la herramienta.

    Presentacin de la herramienta

    El aspecto visual de la herramienta es sencillo. En su parte central, se presenta un panel

    en donde se muestra el diagrama activo; en la parte izquierda, se presenta la paleta con

    los potenciales elementos a insertar en el diagrama; en la parte derecha, la vista del

    modelo y la ventana de propiedades; y, en la parte inferior, se presentan diferentes

    pestaas como puede ser la pestaa de log. Un aspecto visual de la herramienta es el

    siguiente:

    Creacin de diagramas

    Para la creacin de los diagramas, nos situaremos en la vista del modelo, parte superior

    derecha del interfaz de StarUML; seleccionaremos el modelo en donde queramos crear el

    diagrama; y, tras pulsar el botn derecho del ratn, se aparecer un men contextual en

    el que seleccionaremos la opcin Add Diagram; una vez hecho, seleccionaremos el

    diagrama que se desee crear. Entre otros, podemos crear: diagramas de casos de uso, de

    clases, de secuencia, etc..; y, si hemos instalado el mdulo de diagramas de Entidad-

    Relacin, podremos seleccionar el diagrama para la creacin de ER.

    Generacin de cdigo

    Una vez realizado el modelado del sistema a desarrollar, debemos de crear el perfil del

    modelo, es decir, tenemos que informar si el modelo es C++, C#, EJB o Java. La forma de

    definirlo es en la opcin Model/Profiles. Una vez hecho esto, estamos en condiciones para

  • UNIVERSIDAD NACIONAL DE HUANCAVELICA 2013-II

    EAPS

    la generacin del cdigo. La generacin se realiza en las opciones:

    Tools/[Java|C++|C#]/Generate Code; tras seleccionar la ubicacin de la carpeta destino,

    se crear en dicha carpeta las clases del modelo. Adems, en estas mismas opciones del

    men, existe la opcin de realizar ingeniera inversa, proceso, que desde mi experiencia,

    no ha sido muy satisfactorio.

    Para la generacin de cdigo, es muy importante que las clases del modelo estn

    ubicadas dentro de paquetes, as, clasificamos las clases por paquetes. Si no hacemos

    esto, la generacin de cdigo no funciona correctamente.

    Generacin de documentacin

    Una vez creado el modelo y generado el cdigo, nos falta la generacin de la

    documentacin. Dicha tarea, se realiza con unos pasos muy parecidos a los de

    generacin de cdigo: seleccionaremos la generacin de documentacin en la opcin del

    men Tools/StartUML Generator; una vez hecho, se muestra una pantalla en donde

    seleccionaremos, dentro de las plantillas existentes, aqul documento que se quiera

    generar; tras lo cual, informamos de la carpeta destino en donde se desea dejar el

    documento.

    La informacin de los elementos, se va insertando en la vista de propiedades, vista de

    documentos y en las opciones del men contextual que aparece tras pulsar el botn

    derecho del ratn.

    Conclusiones

    Con la herramienta de modelado StarUML podemos definir los requisitos y las diferentes

    vistas del aplicativo de un forma rpida y sencilla; y, lo que es ms importante, podemos

    tener una plantilla de la documentacin del proyecto con la que podemos generar, en el

    instante que queramos y tantas veces como queramos, la documentacin del proyecto de

    una forma automtica. As, evitamos la prdida de tiempo en la creacin de

    documentacin y, por consiguiente, la reduccin de costes. Adems, al ser una

    herramienta con una curva de aprendizaje pequea, es fcilmente utilizable en un equipo

    de trabajo. El punto negativo es la creacin de una plantilla acorde a las necesidades del

    proyecto, proceso que puede llevar tiempo pero una vez realizado es aplicable a cualquier

    proyecto.