Planes que admiten la adición de variables
| Profesional | Negocio | Empresa |
|---|---|---|
Puede reutilizar variables cuando utilice el mismo contenido basado en texto en varios lugares que pueden cambiar con el tiempo (como nombres de campo, números de contacto, direcciones, exenciones de responsabilidad, etc.). Una variable de Document360 es un elemento reutilizable que ayuda a mantener la coherencia y la eficiencia en varias secciones de la documentación. Al emplear variables, los colaboradores de sus artículos pueden actualizar fácilmente la información en un solo lugar, y se refleja automáticamente en toda la documentación, lo que garantiza la precisión y reduce los esfuerzos redundantes.
Por ejemplo, desea agregar su información de contacto en varias instancias, lo que puede cambiar con el tiempo. En este caso, puede agregar una variable para la información de contacto. Si se requiere un cambio, puede actualizar la variable sola en lugar de actualizarla en todas las instancias.
(Contacto: +1 897564231/support@serverless.com)
Creación de una variable
Para crear una variable,
Vaya a Documentación () > Herramientas de contenido > Reutilización de contenidos > Variables en el portal de la base de conocimientos.
Aparece la página Variables . Si ha agregado alguna variable anteriormente, puede verla enumerada aquí.
Haga clic en Crear variable en la parte superior para seleccionar las variables específicas del idioma (global, inglés, francés, etc.) agregadas a su proyecto.
Introduzca el nombre de la variable.
NOTA
El nombre de la variable puede incluir letras, números, guiones y guiones bajos, con una longitud máxima de 30 caracteres.
El valor del código de combinación será el nombre de la variable que aparece con la etiqueta de variable en el editor.
Por ejemplo, si el nombre de la variable es Disclaimer, el valor del código de combinación sería {{variable. Descargo de responsabilidad}}.
En el menú desplegable Selección de idioma , la selección predeterminada es Global (disponible en todos los idiomas). Sin embargo, si es necesario, puede elegir el idioma disponible deseado para crear una variable específica del idioma.
En el campo Contenido , introduzca el contenido de la variable.
NOTA
El límite de caracteres del contenido de la variable es de 100 caracteres con espacios. Si desea agregar textos, expresiones, medios, tablas o bloques de código más largos, use Fragmentos. Para obtener más información, lea el artículo sobre Snippet.
Opciones de formato
Utilice las siguientes opciones de formato de texto para aplicar estilo al contenido de la variable
un. Formato básico del texto:
• Negrita
• Cursiva
• Tachado
• Subrayado
• Tamaño de fuente (8 a 36)
b. Formato adicional:
Haga clic en el icono Más texto para acceder:
• Familia de fuentes (elija de la lista de fuentes)
• Color del texto (selector de color o código HEX)
• Color de fondo (selector de color o código HEX)
• Subíndice
• Superíndice
• Formato claro
c. Insertar enlace : para agregar un hipervínculo.
Haga clic en el icono Insertar enlace .
Escriba la URL y agregue texto al enlace.
Si es necesario, seleccione Abrir en una nueva pestaña.
Haga clic en Insertar.
Haga clic en el botón Crear variable .
La variable recién creada aparecerá en la página Variables , donde se puede editar o eliminar según sea necesario.
Uso de variables en una página de artículo/categoría
Puedes añadir una variable a tu página de artículo/categoría utilizando dos métodos.
Método 1: Usar la sintaxis (editor de Markdown)
En el editor de Markdown, escriba una variable. MergeCodeValue entre corchetes dobles cerrados.
Ejemplo: {{variable. Descargo de responsabilidad}}
Debe conocer el valor exacto del código de combinación para agregar la variable deseada. La variable no funcionará incluso si cambia una sola letra.
NOTA
Escribir en variable. Merge_Code_Value solo funcionará en el editor de Markdown. Si está utilizando Advanced WYSIWYG editor, puede insertar una variable utilizando la barra de herramientas.
Método 2: Desde la barra de herramientas (Markdown, WYSIWYG y WYSIWYG avanzado)
Haga clic en el icono Reutilización de contenido () para el editor Markdown y WYSIWYG.
(O bien)
En el editor WYSIWYG avanzado, utilice el comando/variablesde barra diagonal para acceder a las variables.Seleccione la variable o utilice la barra Buscar variables para restringir el nombre de la variable.
En el editor WYSIWYG avanzado, aparece el panel Variables para la selección de variables. Coloque el cursor sobre el nombre de la variable deseada para obtener una vista previa de su contenido.
Seleccione la variable deseada que desea insertar.
NOTA
En el editor Markdown y WYSIWYG, puede seleccionar varias variables de una sola vez.
Página Variables
Puede ver, editar o eliminar una variable en la página Variables .
Vaya a Documentación () > Herramientas de contenido > Reutilización de contenido > Variables en el portal de la base de conocimientos.
Aparece la página Variables , donde puede encontrar la lista de variables que ya ha agregado.
Idiomas: Para filtrar las variables en Global o en un idioma específico.
Buscar variable: Busque en la lista de variables según el nombre.
Se utiliza en: Si no se agrega una variable a ninguna página de artículo/categoría, el estado sería
-. Si se agrega una variable a cualquier página de artículo/categoría, puede hacer clic en el botón Ver para ver la lista de páginas de artículos/categorías que contienen la variable.Idioma: El idioma deseado de cada variable.
Última modificación: la última vez que se actualizó el contenido de la variable.
Vista previa: Haga clic en el nombre de la variable y podrá ver el contenido de la variable.
Progreso: haga clic en el icono del globo terráqueo para ver el progreso de la variable en varios idiomas.
Icono Editar (): Para editar el contenido de la variable. Una vez que haya realizado los cambios, haga clic en Actualizar.
Icono Delete (): Para eliminar la variable.
Ver dependencia de la página de artículo/categoría
En la página Variables , puede encontrar la columna Usado en .
En la columna Usado en , haga clic en el botón Ver .
Aparecerá el panel Ver referencias , donde puede ver la lista de páginas de artículos/categorías a las que se ha agregado la variable.
Haga clic en el artículo para ampliar la sección.
Puede encontrar la siguiente información:
La versión del artículo.
El espacio de trabajo y el idioma del proyecto.
El nombre de la cuenta del equipo y la foto de perfil que ha agregado la variable.
El artículo dice (Publicado, Borrador, Nuevo artículo).
La información de fecha y hora en la que se insertó la variable en la página del artículo/categoría.
Edición de una variable existente
Vaya a Documentación () > Herramientas de contenido > Reutilización de contenido > Variables en el portal de la base de conocimientos.
Aparece la página Variables . Puede encontrar la lista de variables que ya ha agregado.
Coloque el cursor sobre la variable deseada y haga clic en el icono Editar ().
Puede editar el contenido de la variable. El nombre y el valor del código de combinación no se pueden editar.
NOTA
Editar un enlace agregado en una variable
Haga clic en el enlace y encontrará las siguientes opciones:
Abrir enlace (): El enlace se abrirá en la pestaña. Esto ayuda a verificar el enlace.
Estilo (): El estilo tiene dos opciones.
Verde: Para cambiar el color del texto del enlace a verde.
Grueso: Para aumentar el grosor del texto del enlace.
Editar (): Para editar la URL, el texto del enlace y cambiar la opción de abrir en la nueva pestaña.
Desvincular (): Para desvincular la URL y cambiarla a texto estándar. La URL se desvinculará y solo aparecerá el texto de la URL.
Después de completar la edición de contenido, haga clic en el botón Actualizar .
NOTA
Al editar el contenido de una variable existente en la biblioteca, el cambio de contenido se reflejará en todas las páginas de artículos/categorías que contengan la variable respectiva.
Eliminación de una variable
Vaya a Documentación () > Herramientas de contenido > Reutilización de contenido > Variables en el portal de la base de conocimientos.
Aparece la página Variables . Puede encontrar la lista de variables que ya ha agregado.
Coloque el cursor sobre la variable deseada y haga clic en el icono Eliminar ().
Haga clic en Sí en el mensaje de confirmación.
Para eliminar varias variables de forma masiva
Seleccione varias variables deseadas en la página Variables y haga clic en la opción Eliminar en la parte superior de la lista.
Traducción de variables
Puede crear y administrar variables en varios idiomas. Esto garantiza que, cuando se traduzcan sus artículos, las variables coincidan con el idioma del artículo, lo que proporciona una experiencia de usuario coherente y localizada.
Traducción de nuevas variables
Vaya a las herramientas Documentación () > Contenido > Reutilización de contenido > Variables en el portal de la base de conocimientos.
Haga clic en Crear variable.
En el menú desplegable Idioma , seleccione el idioma deseado (excepto global).
Introduzca el nombre de la variable y el contenido de la variable en inglés (o en su idioma predeterminado).
Para traducir el contenido a otros idiomas, haga clic en el menú desplegable Traducir a otros idiomas .
Seleccione los idiomas deseados en el menú desplegable y haga clic en Traducir.
NOTA
El idioma predeterminado se marcará como Principal.
Los idiomas traducidos se indicarán con una marca verde para indicar que la traducción está completa. Si es necesario, puede navegar a los idiomas no traducidos y completar su traducción.
Una vez completadas las traducciones, haga clic en Crear variable para guardar la variable junto con sus traducciones.
Por ejemplo, si crea una variable para un mensaje de bienvenida en inglés, puede usar la función de traducción para agregar el mismo mensaje en francés, español, alemán, etc.
Traducción de variables existentes
NOTA
Las variables globales no se pueden traducir.
Haga clic en la variable existente que desee traducir.
Vaya a Traducir a otros idiomas y seleccione el idioma deseado en el que la variable necesita traducirse.
Haga clic en Traducir.
Si es necesario, puede navegar a otros idiomas y traducirlos.
Para volver a traducir el contenido, haga clic en Traducir de nuevo, lo que sobrescribirá la traducción existente con la nueva.
Si necesita eliminar la variable traducida para un idioma específico, haga clic en Eliminar idioma.
Puede volver a traducir el contenido en cualquier momento si es necesario.
Preguntas frecuentes
¿Cómo funcionan las variables?
Las variables le permiten definir elementos de contenido específicos, como nombres de productos o números de versión, en un solo lugar. La actualización de la variable refleja automáticamente el cambio en todas las secciones relevantes cuando este contenido cambia, lo que garantiza la uniformidad.
¿Cuál es el beneficio de usar variables en mi documentación?
Mediante el uso de variables, se garantiza la coherencia de la documentación al tiempo que se minimiza la necesidad de actualizaciones manuales. Esto ahorra tiempo, reduce los errores y mantiene la precisión, especialmente cuando se trata de información que cambia con frecuencia.
¿Puedo crear mis variables en Document360?
Document360 le permite crear variables personalizadas adaptadas a sus necesidades de documentación. Esto le permite adaptar la función a la terminología específica y a los elementos relevantes para su contenido.
¿Cómo utilizo las variables en mis artículos?
Inserte la variable en el contenido del artículo utilizando la barra de herramientas del editor o el valor del código de combinación, y extraerá dinámicamente la información que ha definido, asegurando la uniformidad en toda su documentación.
¿Se pueden actualizar las variables en varios artículos a la vez?
Al actualizar una variable, el cambio se refleja automáticamente en todas las instancias en las que se utiliza esa variable, lo que facilita el mantenimiento de información coherente en toda la base de conocimientos.
¿Las variables se limitan a tipos específicos de contenido?
Sí, las variables se pueden usar para texto limitado, número o contenido basado en vínculos, desde nombres de productos y números de versión hasta URL e información de contacto.
¿Cómo mejoran las variables la colaboración entre los miembros del equipo?
Las variables agilizan el proceso de colaboración al garantizar que todos utilicen la misma información precisa. Los cambios en una variable se actualizan instantáneamente en todos los artículos, lo que evita discrepancias.
¿Es el uso de variables una práctica recomendada en la documentación técnica?
El uso de variables es una práctica recomendada que mejora la eficiencia, la coherencia y la precisión de la documentación técnica. Es particularmente valioso cuando se trabaja con información dinámica que requiere actualizaciones frecuentes.
¿Puedo traducir variables a cualquier idioma?
Puedes traducir variables a cualquiera de los idiomas de tu proyecto.
¿La definición de un término variable creada en el sitio de la base de conocimientos se indexa en la búsqueda y por Google?
Sí, la definición de un término variable creada en el sitio de la Base de conocimientos (KB) se indexa tanto en la búsqueda del sitio como en Google. Una vez que se agrega el término, se puede buscar en el sitio web y también será rastreado e indexado por Google.