Crear Páginas del Centro de Aprendizaje [Guía de Usuario de Enterprise Architect]

Top Previous Next

Crear Páginas del Centro de Aprendizaje

button_main button_prev button_next

Como un Desarrollador de Tecnología, es posible que cree un conjunto de páginas del Centro de Aprendizaje para soportar cualquier Tecnología MDG que haya desarrollado y cargado a Enterprise Architect. Usted crea cada página del Centro de Aprendizaje como el Documento Vinculado de un elemento de Artefacto de Documento. Estos elementos se organizan en una jerarquía de Paquetes , donde el nombre del Paquete se convierte en el nombre de una Carpeta de temas en el Centro de Aprendizaje. Luego ejecuta dos scripts; el primero para generar las carpetas y temas del Centro de Aprendizaje, y el segundo (como parte de su activación de Add-in o Tecnología) para importar su estructura del Centro de Aprendizaje a la ubicación del archivo desde la cual puede cargarlo Enterprise Architect.

El proceso original de desarrollar un Perfil de Centro de Aprendizaje como parte de una Tecnología MDG ya no es recomendado.

Configurar una Plantilla de Documento Vinculado para temas del Centro de Aprendizaje

Aunque no es obligatorio, se recomienda que cree una o más plantillas de Documento Vinculado para sus documentos del Centro de Aprendizaje, para proporcionar normas consistentes para el diseño, la estructura y el contenido de sus páginas del Centro de Aprendizaje.

Paso

Acción

Ver También

1

Planee el contenido de sus temas del Centro de Aprendizaje, y considere:

Como debería presentar textos explicativos o descriptivos

Como debería diseñar los pasos en tareas de acciones directas

Como debería referirse y/o vincularse a información en otra documentación, sitios web y directorios de archivo

Que estilos corporativos, estándares y logos puede llegar a necesitar incorporar

 

 

2

Abra la ventana Recursos (Proyecto | Recursos) y cree las plantillas de Documento Vinculado apropiadas para sus temas.

Crear Plantillas de Documento Vinculado

 

Configurar la jerarquía del Paquete para organizar los temas del Centro de Aprendizaje

Paso

Acción

Ver También

1

Crear el Paquete raíz para su documentación del Centro de Aprendizaje. El nombre del Paquete será el punto de partida para la estructura de carpeta de documentación, como es Enterprise Architect para los temas del Centro de Aprendizaje de su producto.

 

 

2

Mostrar la ventana de Propiedades para este elemento Paquete (Elemento | Ventana de Propiedades) y, en el campo Nombre de Archivo, escriba la ubicación del archivo en la cual generar la documentación del Centro de Aprendizaje.

 

Ventana de Propiedades

3

En el Explorador de proyectos, cree un Paquete hijo para cada categoría de la documentación del Centro de Aprendizaje que pretenda crear, y dentro de cada uno de ellos cree Paquetes hijos para cualquier otra subcategoría de la documentación. Puede crear Paquetes hijos en tantos niveles como sea necesario, pero se recomienda que trate de limitar la estructura a menos de cinco niveles.

Tenga en cuenta también que puede tener temas (elementos de Artefacto de Documento) y carpetas (Paquetes) al mismo nivel en su estructura de documento del Centro de Aprendizaje.

 

Agregar un Paquete

Crear Temas del Centro de Aprendizaje

Usted tiene varias opciones para crear elementos de Artefacto de Documento en un Paquete, pero crear un diagrama de Documento y agregarle los elementos es un método sencillo que le da una impresión visual inmediata del contenido de un área del tema.

Paso

Acción

Ver También

1

Trabajando desde el Explorador de Proyectos, dentro de cada Paquete que debe contener temas del Centro de Aprendizaje, cree un diagrama de Documento; es decir:

1.

Haga clic derecho en el nombre del Paquete y seleccione la opción Agregar Diagrama.

2.

En la ventana de Nuevo Diagrama, haga clic en Extendido en el panelSeleccionar Desde, y Documentación en el panel Tipos de Diagramas.

3.

Haga clic en el botón Aceptar .

 

 

2

Desde la Caja de Herramientas de Diagrama, arrastre el ícono de Artefacto de Documento hacia el diagrama y dele el nombre del tema que va a contener.

Este nombre se va a mostrar en la parte superior del documento y en la ruta de acceso del tema del Centro de Aprendizaje, donde actuará como un vínculo para abrir el tema.

 

 

3

Haga doble clic en el elemento y seleccione su plantilla de documento del Centro de Aprendizaje (o cualquier otra plantilla adecuada) desde la ventana Nuevo Documento Vinculado desde Plantilla.

 

 

4

Agregar el texto de descripción y/o procedimiento al documento. Cuando haya terminado, guarde el documento y repita el procedimiento para el siguiente elemento de Artefacto de Documento/tema del Centro de Aprendizaje.

 

Editar Documentos Vinculados

5

En el Explorador de Proyectos, revise el orden en el cual están listados los elementos del Artefacto de Documento. Este orden determina la secuencia de los temas del Centro de Aprendizaje.

Si quiere presentar los temas del Centro de Aprendizaje en un orden diferente, ajuste la secuencia de los elementos del Artefacto de Documento correspondientes en el Explorador de Proyectos adecuadamente.

 

 

Mover Objetos dentro de un Paquete

Compilar la documentación del Centro de Aprendizaje

Paso

Acción

Ver También

1

En el Explorador de Proyectos, haga clic en el Paquete de nivel-raíz para su documentación del Centro de Aprendizaje.

 

 

2

Seleccione la opción del menúHerramientas | Scripting .

Se muestra la ventana de Scripting.

 

Scripting

3

Expanda la carpeta de Scripts Locales y haga clic en el nombre del script VBScript - Crear Libros del Centro de Aprendizaje.

 

 

4

Haga clic en el ícono Ejecutar script (runscript) en la barra de herramientas de la ventana Scripting.

El script genera la documentación del Centro de Aprendizaje para la ruta del archivo especificado en el campo Nombre de Archivo en las propiedades del Paquete raíz.

El script también genera:

Un archivo orden.txt de cada Paquete en la jerarquía del documento, para definir el orden de visualización de carpetas hijas o nombres del tema en la carpeta generada desde ese Paquete; puede editar directamente este archivo para cambiar el orden de los temas en el Centro de Aprendizaje, si es necesario

Un archivo index.txt en la carpeta raíz que proporciona un índice para cada tema, derivado del GUID del elemento de Artefacto de Documento desde el cual se generó el tema; este índice es utilizado para identificar el tema en referencias e hipervínculos al tema, independientemente de si el tema podría ser movido a

 

 

Cargar la documentación del Centro de Aprendizaje

La documentación del Centro de Aprendizaje que ha creado para un Add-In o Tecnología está cargado en el Centro de Aprendizaje utilizando el método del Repositorio AddDocumentationPath. Usted normalmente escribiría esto en el script de activación que ha creado para cargar la Tecnología en sí, pero también podría probar la documentación utilizando un script más sencillo que acaba de cargar la documentación. La llamada se asemeja a esto:

{

Repository.AddDocumentationPath('ToolGuide','C:\\Temp\\ToolLC',0)

}

 

Notas

Si la misma documentación del Centro de Aprendizaje se carga más de una vez durante una sesión de trabajo, cada carga se presenta como un conjunto separado de páginas; la documentación original no se sobrescribe

 

Aprender más

Centro de Aprendizaje

Clase Repositorio