Templates de documentación
Todos los documentos generados siguen un Template de documento. En la aplicación se denominan Templates de documentos. El Template determina qué partes incluye el documento y en qué orden: portada, índice, capítulos y secciones, bloques de texto, campos de documentación, modelo, matriz RACI, documentación de elementos, gráficos y asignación de RACI por actividad.
Cada nivel de arquitectura tiene sus propios Templates. Así, una descripción general breve del proceso, un procedimiento operativo estándar detallado y un paquete de auditoría pueden presentar el mismo proceso de distintas maneras.
Dónde se encuentran los Templates
- Configuración → Arquitectura de procesos muestra cada nivel en una tarjeta. Abra la opción Templates de documentos del nivel o haga clic en el icono de edición para abrir el editor.
- En la pestaña Documentación, el selector Template de documento de la barra lateral permite cambiar el documento que está consultando. Se usa el Template predeterminado del nivel hasta que alguien seleccione otro.
- Los editores pueden abrir directamente el Template desde el documento: abra el menú de exportación y seleccione Editar Template….
Los Templates se configuran en Arquitectura de procesos. Cualquier persona que pueda consultar la documentación de un proceso verá el documento que genera su Template. Todas las exportaciones usan el Template seleccionado en la página de documentación.
Elegir y gestionar Templates
El editor se abre en un único cuadro de diálogo: arriba están el selector de Templates y el botón para añadir uno; a la izquierda, el árbol del documento; y a la derecha, la configuración del nodo seleccionado. En la parte inferior están Cancelar y Guardar.
El editor abre el último Template que modificó para ese nivel. La opción Editar Template… de la página de documentación abre el Template que usa el documento actual.
- El selector Template de documento de la parte superior permite cambiar entre los Templates del nivel. Los que aparecen como Borrador no están disponibles para los usuarios de solo lectura; Predeterminado identifica el Template que se abre inicialmente en la página de documentación.
- + añade un Template llamado Nuevo Template de documento y lo selecciona.
- Nombre cambia el nombre del Template seleccionado.
- Publicado controla si los usuarios de solo lectura pueden seleccionar el Template en la página de documentación. Los editores siempre pueden ver los borradores.
- Establecer como predeterminado define el Template seleccionado como el que se usa cuando no se elige otro en la página de documentación. Cada nivel tiene un único Template predeterminado.
- Eliminar Template de documento elimina el Template seleccionado. No se puede eliminar el único Template predeterminado de un nivel. Primero establezca otro como predeterminado.
- Incluir elementos sin documentación añade a la sección de elementos del documento los elementos del modelo que aún no tienen descripción. Desactive esta opción si el documento solo debe incluir elementos con la documentación completa.
Añadir o eliminar un Template, y establecer el predeterminado, se aplica de inmediato. El nombre, la visibilidad, la opción para incluir contenido, la portada y el árbol del documento se guardan al hacer clic en Guardar.
Crear el documento
El árbol del documento aparece a la izquierda del editor. Arrastre un nodo para cambiar su posición o suéltelo sobre un capítulo o una sección para anidarlo. Use el menú de la fila o haga clic con el botón derecho en ella para añadir o quitar contenido.
Capítulos y secciones
- Añadir capítulo debajo añade un capítulo en el nivel principal del documento.
- Añadir sección o Añadir sección debajo añade una sección anidada o al mismo nivel.
- Seleccione un capítulo o una sección para editar su Título y activar o desactivar Numeración automática. La numeración sigue la estructura del árbol: los capítulos se numeran X, sus secciones X.Y y las secciones de niveles inferiores X.Y.Z. El panel muestra el nivel de encabezado que tendrá el nodo.
- Eliminar quita el nodo seleccionado y sus elementos secundarios.
Nodos de contenido
El menú de nodos ofrece estas opciones:
- Añadir texto / Añadir texto debajo añade un bloque Markdown. Escriba encabezados, listas, enlaces o notas en el campo Texto Markdown. También puede usar marcadores de posición.
- Añadir campo de documentación… / Añadir campo de documentación debajo… añade uno de los campos de documentación publicados para el nivel. Si más adelante se deja de publicar un campo, se elimina del documento para que no muestre contenido que el nivel ya no publica.
- Añadir modelo / Añadir modelo debajo muestra el diagrama del proceso. Mostrar datos añade debajo del diagrama el resumen «Filtros y datos utilizados».
- Añadir RACI / Añadir RACI debajo muestra la matriz RACI.
- Añadir elementos / Añadir elementos debajo muestra la documentación de cada elemento del modelo.
- Añadir sección de gráficos coloca la documentación de los gráficos en esa parte del documento. Puede añadirla en el nivel principal o dentro de cualquier capítulo o sección.
- Añadir RACI por actividad añade la asignación de RACI a cada actividad de la sección de elementos. Si se añade en el nivel principal, se aplica a todo el documento.
Añadir portada y Añadir índice solo están disponibles en el nivel principal, una vez cada una. Ambas opciones crean nodos: seleccione uno para editarlo o elimínelo si el documento no debe incluir portada o índice.
La portada
Seleccione el nodo de portada para configurar:
- Cargar imagen, Reemplazar o el icono de eliminación para cambiar la imagen de fondo.
- Título, que de forma predeterminada es el nombre del proceso. Use marcadores de posición si el título debe adaptarse al proceso.
- Subtítulo para indicar una versión, clasificación o audiencia.
Marcadores de posición
El texto editable admite marcadores de posición que ProcessMind completa al generar el documento:
{{processName}}, {{processCode}}, {{processClassification}}, {{processOwner}}, {{processShortDescription}}, {{processStatus}}, {{version}}, {{author}}, {{publishedDate}}, {{currentDate}}
Haga clic en una etiqueta de marcador de posición para copiarla o haga doble clic para insertarla en el texto que está editando. Si un proceso no tiene un valor para un marcador de posición, este aparece vacío en el documento.
Templates y exportaciones
El Template define el documento. Las exportaciones a PDF, Word y Markdown, así como la impresión, siguen el Template seleccionado. El contenido que no está en el Template no aparece en la exportación. Para ocultar una parte en un Template, elimine el nodo correspondiente. Para usar varios estilos de documento en un mismo nivel de proceso, cree un Template para cada estilo y establezca como predeterminado el que quiera abrir en la página de documentación.
Temas relacionados
Diseñe mejores procesos. Conecte su arquitectura. Mantenga el control.
Acceda de inmediato, sin tarjeta de crédito ni esperas. Transforme la forma de trabajar de su organización en diseños de procesos claros y conectados.
Defina la arquitectura de procesos, los responsables y los controles, y alinee las funciones y responsabilidades en todos los niveles.
Comience su prueba gratuita y establezca una base fiable para gobernar, gestionar y mejorar continuamente sus procesos.