Uso de Altium Documentation

Altium proporciona un amplio conjunto de documentación técnica en toda la gama de soluciones de diseño disponibles. Este documento ofrece una práctica colección de “consejos y trucos” para usar la documentación y encontrar lo que necesita, y también proporciona detalles ampliados sobre los muchos y variados aspectos de la documentación cuya existencia quizás no conocía.

Acceso a la documentación técnica

La principal puerta de acceso a la documentación técnica —la “puerta principal”, por así decirlo— es: https://www.altium.com/documentation/. 

En el corazón mismo de la página se encuentran los dos siguientes conjuntos de documentación:

• Altium Designer – el software de diseño de escritorio, identificado de la siguiente manera:

  • Altium Designer Develop – cuando forma parte de la solución Altium Develop.

  • Altium Designer Agile – cuando forma parte de las soluciones Altium Agile Teams o Altium Agile Enterprise.

  • Altium Designer – cuando todavía se utiliza (con suscripción activa) y no forma parte de una solución de plataforma.

• Altium 365 – la plataforma en la nube, cuyo Workspace principal se identifica de la siguiente manera:

  • Altium Develop Workspace - cuando se crea como parte de la solución Altium Develop.

  • Altium Agile Teams Workspace - cuando se crea como parte de la solución Altium Agile Teams.

  • Altium Agile Enterprise Workspace - cuando se crea como parte de la solución Altium Agile Enterprise.

  • Altium 365 Workspace – cuando todavía se utiliza con Altium Designer (con suscripción activa) y no forma parte de una solución de plataforma.

Tenga en cuenta que, en ambos casos, se utiliza un único conjunto de documentación para dar soporte a todas las soluciones. En la documentación de Altium Designer, normalmente se utiliza la forma abreviada “Altium Designer” al referirse al software. En la documentación de Altium 365, se utiliza “Altium Platform” (o “Altium 365”) al referirse a la plataforma y “Altium Workspace” (o “Altium 365 Workspace” o simplemente “Workspace”) al referirse a un Workspace alojado en la plataforma.

Uso de la página:

• Haga clic en el encabezado principal de un mosaico para acceder a la página de inicio de la documentación de esa solución de diseño en particular.

• Haga clic en un enlace dentro de los mosaicos de Altium Designer o Altium 365 para acceder a la información de esa área específica.

• Utilice los QuickLinks menús disponibles para acceder a páginas clave adicionales, como se muestra a continuación para los mosaicos de documentación de Altium Designer y Altium 365.

• Utilice el campo Search en la parte superior de la página para buscar rápidamente en toda la documentación de todas las soluciones de diseño (y sus versiones, cuando corresponda), así como en la Base de conocimientos. Para obtener más detalles sobre la función de búsqueda, consulte Función de búsqueda de la documentación.

• Haga clic en la entrada Other Products para expandir la página y acceder a la documentación de otras soluciones/áreas: Renesas 365, Altium Developer Center, Altium On-Prem Enterprise Server, Company Dashboard, Altium CircuitMaker, Altium CircuitStudio, y Altium Infrastructure Server.

  

• Haga clic en la entrada See Also para expandir la página y acceder a otros recursos útiles que Altium ofrece, como la Base de conocimientos, el Learning Hub (lleno de artículos interesantes y especializados, muchos escritos por expertos del sector), Altium Professional Training y los Foros de Altium (un recurso de aprendizaje inestimable con información directamente de sus colegas).

  

Acceso directo con “F1”

Para software de diseño como Altium Designer, definitivamente vale la pena familiarizarse con el atajo de teclado F1. Pase el ratón sobre muchos de los recursos del entorno del software —un comando de menú, un cuadro de diálogo, un panel, un objeto de diseño o una palabra clave del lenguaje de consultas— y luego pulse F1 para acceder a su documentación. La conexión entre el recurso del software y la documentación técnica se realiza mediante un archivo de asignación (*.HelpID), que reside en la carpeta \Program Files\Altium\AD<Solution>\Help de la instalación principal.

La siguiente imagen ilustra la función en acción. Aquí, se está utilizando el atajo de teclado F1 para acceder a la documentación del comando Material Library, disponible al editar el apilado de capas de una PCB mediante el Layer Stack Manager.

Actualizaciones de F1

En el software de diseño compatible, el archivo de asignación HelpID de la carpeta principal de la instalación \Help se actualiza con cada nueva versión de ese software. Sin embargo, hay ocasiones en las que el equipo de documentación técnica realiza actualizaciones del archivo de asignación entre versiones. Para hacer llegar a nuestros usuarios los cambios más recientes de F1 sin tener que esperar a la siguiente versión del software, empleamos un método de actualización sobre la marcha que utiliza la opción Check frequency, en la página System - Installation del cuadro de diálogo Preferences.

Siempre que haya transcurrido el intervalo de comprobación, la próxima vez que se utilice la función F1, se descargará una versión más reciente del archivo de asignación en la carpeta \ProgramData\Altium\Altium Designer <Solution> <GUID>\Help. Esta versión más reciente del archivo HelpID tiene prioridad sobre el archivo predeterminado de la carpeta \Help de la instalación principal.

Métodos alternativos de acceso

También se puede acceder a la documentación técnica de varias formas adicionales, entre ellas:

• Mediante una búsqueda externa utilizando el motor de búsqueda de su navegador web, por ejemplo Google. Para centrar esa búsqueda en la documentación de Altium, introduzca el sitio como prefijo, usando el formato site:altium.com/documentation <Search String> (por ejemplo, site:altium.com/documentation PCB Layout Replication).

• Siguiendo un enlace proporcionado en una publicación oficial del foro de Altium.

• Siguiendo enlaces disponibles en otras áreas del sitio web principal altium.com (por ejemplo, desde el área Learning Hub o desde páginas dedicadas a “Novedades” y a funciones específicas).

• Siguiendo enlaces dedicados dentro del software. Por ejemplo, desde un Help menú, o usando enlaces “Learn More” (o con una redacción similar).

La interfaz de la documentación

La interfaz de la documentación normalmente comprende hasta 14 regiones distintas, mostradas en la siguiente imagen y detalladas a continuación.

1. Product Documentation Selector – utilice este control para cambiar entre los conjuntos dedicados de documentación disponibles.

2. Theme Selector – utilice este control para cambiar entre los modos de presentación claro () y oscuro (), como se ilustra en el siguiente ejemplo.

   

    

   

    

    

3. Search – utilice este campo para introducir una cadena de búsqueda y encontrar información dentro de la documentación del producto que se está visualizando actualmente. Los filtros de búsqueda relacionados le permiten ajustar posteriormente el alcance de la búsqueda. Para obtener más detalles, consulte Función de búsqueda de la documentación.

4. Nav Tree Pane – presenta toda la paginación que compone la documentación del producto que se está visualizando. Agrupada lógicamente, haga clic en una entrada para ver esa página. Los controles en la parte superior derecha del panel le permiten cambiar su tamaño y/o controlar su visibilidad.

5. QuickLinks – un componente dedicado y estático del panel Nav Tree que siempre se presenta, independientemente de la documentación del producto que se esté visualizando. Proporciona acceso rápido a esta página, a la información de copyright y a la puerta de acceso principal a la documentación, así como acceso rápido a la Base de conocimientos.

6. Breadcrumbs – proporciona un medio secundario de navegación, basado en la página activa que se está leyendo, hacia las páginas principales superiores en la jerarquía. Cuando la ruta de navegación contiene muchas páginas, se utiliza un control de puntos suspensivos para mantener la visualización manejable. Haga clic en él para acceder a una ventana emergente que contiene todas las páginas intermedias adicionales de la ruta, cada una con un enlace activo a la página correspondiente.

   

7. Main Page Content– esta es el área principal de la interfaz, donde se presenta la página seleccionada en el Nav Tree panel. Para obtener más información sobre diversos aspectos del contenido de una página, junto con consejos sobre sus características y funcionalidad, consulte Viewing a Technical Document.

8. Feature Availability Note – esto se presenta en todas y cada una de las páginas dentro de ciertos conjuntos de la documentación. La documentación técnica incluye todas las características y funcionalidades de un producto o de un elemento de una solución general. En el caso de Altium Designer y Altium 365, que tenga acceso a una característica presentada en una página depende de qué solución de Altium tenga: Altium Develop, Altium Agile Teams, Altium Agile Enterprise o Altium Designer (con suscripción activa). Si no ve una característica documentada en su software real, contacte con Ventas de Altium para obtener más información.

9. Legacy Documentation Note – esto se presenta en todas y cada una de las páginas de la documentación de Altium Designer. Proporciona acceso rápido a la sección Legacy Documentation de la página Other Installers, para documentación relacionada con versiones anteriores del software.

10. Table of Contents – la Content región del panel derecho presenta, cuando corresponde, la estructura de la página activa en términos de sus encabezados (niveles 2 a 4, ya que el nivel 1 es el título de la página). Haga clic en una entrada para ir a esa ubicación de la página. A la inversa, a medida que se desplaza por la página, la Content región se actualizará para indicar dónde se encuentra dentro del documento.

11. Like/Dislike – la funcionalidad omnipresente de “pulgar arriba/abajo”, que le permite valorar rápidamente si una página fue útil o no y, cuando no lo fue, brindarle la posibilidad de indicarnos por qué (disponible cuando ha iniciado sesión en su cuenta de Altium). Para más detalles, consulte Like/Dislike Functionality.

12. Language Selector – proporciona una forma rápida de cambiar para ver la documentación en uno de varios idiomas oficialmente compatibles.

13. Documentation Feedback (se muestra al iniciar sesión en su cuenta de Altium) – esta función le proporciona una vía rápida para enviar sus comentarios sobre una página al equipo de Documentación Técnica, más orientada a señalar errores tipográficos, información incorrecta/desactualizada o información faltante. Simplemente seleccione texto y/o una imagen en la página y use el atajo de teclado Ctrl+Enter para acceder a la función. Para más detalles, consulte Documentation Feedback Mechanism.

14. Printer-friendly version – proporciona el medio para generar, al instante, una versión de la página cuyo contenido está preparado especialmente para facilitar la impresión (por ejemplo, para guardarla como PDF).

Paginación de estructura

Dentro del Nav Tree panel de la interfaz, a veces encontrará entradas que, al hacer clic en ellas, no presentan una página de documentación. Esto es intencional y se utiliza como un medio para proporcionar estructura adicional al árbol, cuando es necesario agrupar páginas bajo un “padre” general, pero no se necesita información en la propia página principal. Este tipo de página, una página Structure, simplemente cumple exactamente esa función. A medida que mueve el cursor sobre una entrada de este tipo, no aparece subrayada (como sí sucede con la entrada de una página de documentación “real”). Cuando hace clic en una entrada de este tipo, simplemente se expande esa sección del árbol. Haga clic de nuevo para contraerla.

Visualización de un documento técnico

Las siguientes secciones proporcionan información sobre diversos aspectos del contenido de la propia página.

Convenciones del documento

Bold	Se usa para resaltar un comando de menú, control de cuadro de diálogo, botón o barra de herramientas mencionado en el texto. Ejemplos:   Use el comando Annotate Schematics Quietly. Si la opción Copy routed nets está habilitada en el cuadro de diálogo, se colocará el enrutamiento desde el bloque fuente. Haga clic en el botón Refresh en la parte superior del Constraint Manager. Ubicación y uso del comando Place Pad () en la barra de herramientas Active Bar  o Wiring .
Italic	Se usa para resaltar un panel o cuadro de diálogo mencionado en el texto. Ejemplos:   Las funciones de PCB CoDesign se acceden y operan a través del panel PCB CoDesign. La anotación esquemática se configura usando el cuadro de diálogo Annotate. La cursiva también se usa, cuando es necesario, para dar énfasis a un punto importante.
Monospace	Se usa para resaltar una ubicación en el disco duro, nombre de archivo, extensión de archivo, entrada de lista de opciones (en el menú desplegable de un campo), expresión del lenguaje de consulta o palabra clave de lenguaje mencionada en el texto. Ejemplos:   Se instala una selección de diseños de ejemplo como parte de la instalación inicial. En una instalación estándar predeterminada del software, estos pueden encontrarse en la carpeta \Users\Public\Documents\Altium\AD<Solution>\Examples . Se accede a este instalador basado en asistente ejecutando un pequeño archivo ejecutable – AltiumDesignerDevelopSetup.exe (o AltiumDesignerAgileSetup.exe). Se puede añadir un documento de dibujo de fabricación basado en Draftsman a un proyecto de diseño de PCB (*.PCBDwf), un proyecto de diseño de arnés (*.HarDwf) o un proyecto de diseño multitarjeta (*.MbDwf). TouchesRoom('Monitor','Auxilary','Effects')
Bold + Monospace	Se usa para resaltar un atajo de teclado mencionado en el texto. Ejemplos:   Haga clic con el botón derecho o pulse Esc para salir del modo de colocación. Pulse Spacebar para rotar el objeto de texto en sentido antihorario o Shift+Spacebar para una rotación en sentido horario.
Menu » Menu Item	Las referencias al menú principal en la documentación de Altium Designer usan el carácter » como separador. La primera entrada hace referencia al propio menú, seguida del comando en ese menú. Si se accede a un comando desde un submenú, entonces se usa un carácter » adicional para indicarlo. Ejemplos:   La configuración para la comprobación de reglas de diseño se realiza en el cuadro de diálogo Design Rule Checker, al que se accede mediante el comando Tools » Design Rule Check desde un documento PCB. Las entradas de arnés están disponibles para su colocación en el editor Schematic. Elija Place » Harness » Harness Entry en los menús principales.
Tab | Group | Button	Las referencias al menú principal en la documentación de Altium CircuitStudio y Altium CircuitMaker usan el carácter | como separador. La primera entrada hace referencia a la pestaña específica del menú de cinta, seguida por el grupo (o región) de la pestaña y, finalmente, por el botón dentro de ese grupo. Si se accede a un comando desde un menú asociado a un botón, entonces se usa el carácter » para indicarlo. Ejemplos:   Se puede acceder al panel View Configuration, que se utiliza para configurar qué se muestra actualmente en el espacio de diseño y cómo se muestra, desde el editor PCB eligiendo View | PCB | View Configuration. Para mover los objetos seleccionados actualmente, use el comando Tools | Arrange | Move » Move Selection.
Key1+Key2	Al referirse a atajos, el uso del símbolo más (+) denota mantener presionadas varias teclas del teclado en la secuencia indicada. Ejemplos:   Shift+H (para activar o desactivar la visualización Heads Up Display en el editor PCB). Shift+Ctrl+X (para activar o desactivar el modo Cross Select Mode en los editores Schematic/PCB).
Key1, Key2	Al referirse a secuencias de teclas de acceso rápido, el uso del símbolo coma (,) denota presionar cada tecla de la secuencia sucesivamente. Ejemplos:   X, A (en el editor Schematic, para deseleccionar todos los objetos de la hoja actual). P, V, K (en el editor Schematic, para colocar una directiva de máscara de compilación). T, D, R (en el editor PCB, para ejecutar una comprobación por lotes de reglas de diseño).
Enlace	Un hipervínculo normal a un destino que podría ser:   A otra área de la misma página. A una página diferente dentro del mismo conjunto de documentación del producto. A una página diferente dentro de un conjunto de documentación de otro producto. A una página fuera de la documentación técnica.
Cuadro informativo	Se usa para resaltar información adicional clave sobre un tema concreto que se está tratando en la página. Ejemplo:   La fuente de los datos de la BOM de un proyecto de diseño de arnés es el dibujo de disposición del proyecto. Por lo tanto, si se cambió el diagrama de cableado de su diseño de arnés y este cambio debe reflejarse en la BOM, primero debe actualizarse el dibujo de disposición.
Cuadro de característica/consejo	Se usa para resaltar una característica o funcionalidad concreta que conviene conocer, o un consejo para usarla. Ejemplo:   El conjunto de proyectos de ejemplo de Altium Designer incluye un proyecto de diseño de arnés de ejemplo –Harness_Demo_Prj.PrjHar – en la carpeta \Users\Public\Documents\Altium\AD<Solution>\Examples\Harness Demo MB\Harness_Demo_Prj de forma predeterminada, que está asociado con un proyecto de demostración multitarjeta (\Examples\Harness Demo MB\Harness_Demo_MB\Harness_Demo_MB.PrjMbd), para que pueda probar los arneses directamente desde el primer momento.
Cuadro de advertencia	Se usa para resaltar algo que es importante tener en cuenta o que debe realizarse. Ejemplo:   Se recomienda especialmente realizar siempre una comprobación de reglas de diseño en modo por lotes antes de generar el arte final. El DRC en línea solo detecta nuevas violaciones, es decir, violaciones que se crean después de habilitar la función, mientras que el DRC por lotes permite ejecutar una comprobación manualmente en cualquier momento del proceso de diseño de la placa. Por ello, aunque los buenos diseñadores conocen el valor del DRC en línea, también saben que el diseño de la placa debe comenzar y terminar con un DRC por lotes.

Elementos visuales atractivos

A lo largo de la documentación, encontrará una variedad de elementos visuales utilizados para transmitir la información de una manera más atractiva. Las siguientes secciones muestran cómo aparecen en una página y cómo se utilizan.

Imagen estática

La humilde imagen estática es una pieza fundamental de la documentación, y se usa junto con el texto que la rodea para proporcionar fielmente detalles sobre un aspecto clave del software.

Para mantener la presentación (y la legibilidad) de un documento manejable, se utiliza un ancho fijo para la página. Por ello, normalmente las imágenes no pueden mostrarse en tamaño completo de forma predeterminada. Al pasar el cursor sobre una imagen, este cambiará de un icono de puntero () a un icono de lupa (). Esto indica que, al hacer clic en la imagen, se mostrará su versión a tamaño completo en una ventana flotante (cuando corresponda y de acuerdo con el tamaño actual de la ventana del navegador). La siguiente imagen ilustra esto para una imagen estática en la documentación (irónicamente, tendrá que hacer clic en la imagen para verla a tamaño completo).

Presentación de diapositivas

Un elemento de presentación de diapositivas puede incluir varias imágenes (y videos) para mostrar de forma clara más información visual, junto con sus títulos o descripciones. Este elemento es especialmente útil al ilustrar una progresión o una secuencia de pasos a seguir al usar una determinada función del software.

La siguiente imagen muestra un ejemplo de presentación de diapositivas en la documentación y destaca algunas áreas clave, que se describen a continuación.

1. Use estos controles para avanzar y retroceder por la presentación, respectivamente. Al pasar el cursor sobre un área, esta se oscurecerá. Puede hacer clic en cualquier parte del "marco de flecha", no solo en el propio icono de flecha.

2. Estas "burbujas" reflejan cuántas diapositivas hay en la presentación y en cuál de ellas se encuentra (burbuja más oscura). Puede hacer clic en una burbuja para ir rápidamente a esa diapositiva.

3. Una presentación puede incluir títulos o descripciones: una por diapositiva. Estos se actualizarán a medida que haga clic en las distintas diapositivas.

Gif animado

Se utiliza un Gif animado cuando es necesario capturar un proceso o aspecto del software de una forma similar a un video, pero cuando la ilustración visual es breve y usar un video sería excesivo. Un gif animado en la documentación se distingue por tener un claro botón de "reproducir" en el centro, como se muestra en la siguiente imagen. Después de hacer clic en el botón, el gif se reproducirá hasta el final y se detendrá, mostrando nuevamente el botón de reproducción.

Video (MP4)

Un video, al igual que un gif, se utiliza cuando es necesario capturar visualmente un proceso o aspecto del software en ejecución, y cuando ese contenido visual es más largo de lo adecuado para un gif. Un video en la documentación se distingue por tener un panel de control en la parte inferior, como se muestra en la siguiente imagen. Haga clic en cualquier parte del video para comenzar la reproducción (no es necesario hacer clic en la flecha de reproducción de la esquina inferior izquierda). Haga clic de nuevo (en cualquier parte del video) para pausarlo. Utilice los controles disponibles del video para, por ejemplo, cambiar a tamaño completo y volver, avanzar y retroceder en la línea de tiempo, y cambiar la velocidad de reproducción.

Imagen al pasar el cursor

Una imagen al pasar el cursor se utiliza para presentar un escenario de "antes y después" o algún tipo de comparación con respecto a una característica o función del software. Consta solo de dos imágenes. Aparece en la página igual que una imagen estática normal, mostrando la primera imagen de forma predeterminada. Al pasar el cursor sobre ella, aparece la segunda imagen.

Lo siguiente es un ejemplo real de un elemento visual de imagen al pasar el cursor usado en la documentación. En este caso, se utiliza para ilustrar vías de blindaje (imagen predeterminada/primera) y vías de cosido (segunda imagen, accesible al pasar el cursor).

Imagen emergente

Una imagen emergente se utiliza para mostrar algo en el contexto del texto circundante, sin agregar específicamente esa imagen al flujo del contenido. En este sentido, podría considerarse más bien un "aparte" o ejemplo, que refuerza un comentario o afirmación hecha en el texto. Un elemento de este tipo aparece con uno de dos iconos:  (una imagen emergente) o  (un Gif animado o video emergente). La siguiente imagen muestra un elemento emergente al hacer clic en él, en este caso una ventana emergente de tipo "imagen", que muestra la imagen a tamaño completo.

Texto al pasar el cursor (información sobre herramientas)

El texto al pasar el cursor (o información sobre herramientas) se usa para proporcionar orientación adicional y útil en el contexto de una entrada específica de una página. Esto podría ser, por ejemplo, una nota explicativa para una entrada, o quizá una explicación de terminología al estilo de un glosario. Una información sobre herramientas puede aparecer de una de estas dos formas:

• El icono . Pase el cursor sobre el icono para acceder a la ayuda.

  

• Texto con subrayado punteado. Pase el cursor sobre el texto para acceder a la ayuda.

  

Secciones desplegables

Para mantener el contenido de la página ordenado y no abrumador, se utilizan secciones desplegables. Suelen emplearse para información con mayor profundidad, pero que no es necesariamente necesaria para comprender el flujo típico de la página (y que, por lo tanto, no necesita mostrarse abiertamente). Ese contenido podría ser, por ejemplo, opciones disponibles en un cuadro de diálogo o panel, o consideraciones específicas relacionadas con un aspecto concreto de una función tratada en el contenido principal. Expanda o contraiga una sección de este tipo haciendo clic en cualquier parte del encabezado de la sección.

Obtener un enlace a la página o a una sección específica

Cuando quiera compartir una página con otras personas, necesita poder obtener rápidamente su URL. Esto puede hacerse (copiándola al Portapapeles de Windows) de un par de formas:

1. Desde la barra de direcciones del navegador cuando accede por primera vez a la página.

2. Haciendo clic con el botón derecho en la entrada de la página en el árbol de navegación de la izquierda y luego usando el comando Copy link address en el menú contextual.

Llevando esto un paso más allá, también puede obtener una URL de una sección específica de la página que está leyendo en ese momento, de la siguiente manera:

1. Use el panel derecho para acceder a la sección deseada dentro de la estructura de contenido de la página y luego copie la URL desde la barra de direcciones del navegador.

2. Desplácese hacia abajo por la página hasta la sección deseada. A medida que se desplaza, la barra de direcciones del navegador se actualiza para reflejar la sección actual a la que ha llegado.

3. Haga clic con el botón derecho en la entrada de la sección deseada dentro de la estructura de contenido de la página (en el panel derecho) y luego use el comando Copy link address del menú contextual.

También puede "tomar un enlace" rápidamente desde los siguientes lugares:

• Main Section Header - haga clic en el control "Copy Link" a la izquierda del encabezado de una sección principal.

  

• Collapsible Section - haga clic en el control "Copy Link" a la derecha del título de una sección desplegable.

  

Documentación versionada

En el caso de Altium On-Prem Enterprise Server, su documentación asociada está versionada. Esto le permite seleccionar la versión correcta de la documentación para la versión del software que está utilizando. La versión puede seleccionarse tanto desde la puerta de enlace principal de la documentación (desde el menú QuickLinks del mosaico del producto) como en cualquier momento dentro de la documentación, usando el selector de versión disponible en el área del banner superior, como se muestra a continuación.

El sistema de control de versiones le avisa si está leyendo una página que no es la versión más reciente de esa página. Lo hace de dos maneras:

• El número de versión en el selector desplegable de versiones se muestra en un color diferente y se indica con un símbolo de advertencia.
• Se muestra una advertencia en la parte superior de la página, con un enlace a la versión más reciente. Al seguir el enlace, la entrada del selector de versiones cambiará automáticamente a la última versión disponible.

Versiones aplicables

Aunque el software evoluciona de una versión a otra, añadiendo nuevas funciones y mejoras a su funcionalidad, la documentación versionada asociada de Altium On-Prem Enterprise Server puede verse afectada solo en determinadas áreas. Muchas páginas no se verán afectadas por la siguiente versión del software, por lo que el mismo contenido que era aplicable anteriormente también se aplica ahora a esa versión posterior. Por ello, en cada página se proporciona una indicación para mostrar para qué versiones del software puede utilizarse el contenido de esa página.

La siguiente imagen ilustra dicha indicación. Aquí está abierta la versión 8.0 de la página que detalla la función Historial del proyecto. Este contenido también se aplica a las versiones 7.0, 7.1 y 7.2 del software. En otras palabras, no hay diferencia en el contenido de la página si establece el selector de versiones de la documentación en 7.0, 7.1, 7.2 u 8.0.

Función de búsqueda de la documentación

Para ayudarle a encontrar información dentro de la documentación técnica de las soluciones de diseño de Altium, existe una potente Search función. Impulsada por Google, en realidad hay una sola función de búsqueda para todo el sitio altium.com. La forma y el lugar desde donde acceda a la búsqueda determinan lo 'filtrados' que estarán sus resultados iniciales:

• Desde el banner superior del sitio: se accede y se utiliza como se ilustra en la siguiente presentación. La búsqueda se realiza en todo el sitio y los resultados se presentan en una pestaña separada del navegador.

• Desde la 'puerta de entrada' de la documentación técnica (altium.com/documentation): se accede y se utiliza como se ilustra en la siguiente presentación. La búsqueda se realiza en todos los conjuntos de documentación disponibles para las distintas soluciones de diseño de Altium, así como en la Base de conocimientos. Los resultados se presentan en la misma pestaña del navegador.

• Desde una página dentro de la documentación técnica: se accede y se utiliza como se ilustra en la siguiente presentación. La búsqueda se realiza solo dentro del conjunto de documentación activo que se esté visualizando actualmente. Los resultados se presentan en la misma pestaña del navegador.

Navegación QuickNav (Documentación de Altium Designer)

En lo que respecta a los objetos y paneles de diseño en Altium Designer, la información sobre estos elementos está dispersa en una gran cantidad de páginas dentro del conjunto de documentación de Altium Designer. Para proporcionar un medio con el que navegar fácilmente a dicha información, se ha empleado el concepto de navegación QuickNav. De manera análoga a un mapa de 'directorio de tiendas' en un centro comercial, una página QuickNav proporciona información de referencia rápida sobre los elementos de diseño disponibles para un área concreta de diseño, dándole un medio para navegar rápidamente a información más detallada sobre cada uno.

En la mayoría de los casos, una página QuickNav presentará la información en tres secciones diferenciadas:

• Graphical Overview - una recopilación visual de objetos de uso común, por ejemplo.
• Slideshow - presenta información más general sobre algunos de los elementos que utilizará con más frecuencia.
• A-Z Listing - una cómoda lista alfabética. Sin adornos ni complicaciones. Solo enlaces directos al detalle de un elemento concreto.

La navegación QuickNav está disponible para lo siguiente:

• Objetos de diseño esquemático

• Objetos de diseño de PCB

• Objetos de diseño de Draftsman

• Objetos de diseño esquemático multicard

• Objetos de diseño de arnés

• Paneles

Navegación QuickStart (Documentación de Altium Designer)

Dentro del conjunto de documentación de Altium Designer (que sustenta y da servicio a las soluciones de plataforma disponibles de Altium) hay páginas clave de nivel superior que, consideradas en conjunto, proporcionan un valioso conjunto de información de 'QuickStart'. Esta navegación le guía por un área de diseño concreta, dándole el nivel justo de detalle para que pueda empezar y avanzar con su comprensión de esa área, sin profundizar demasiado. Estas páginas son:

• Familiarizarse con el entorno de diseño de Altium

• Capturar su idea de diseño como un esquema

• Analizar su diseño mediante simulación de circuitos

• Gestión de BOM con ActiveBOM

• Gestionar cambios de diseño entre el esquemático y la PCB

• Diseñar la disposición de su PCB

• Optimizar la documentación de diseño de placas con Draftsman

• Preparar su diseño para la fabricación

• Diseñar con múltiples PCB

• Diseño de arneses

Funcionalidad Me gusta/No me gusta

Para permitirnos obtener analíticas generales sobre la navegación en la documentación técnica, se emplea la ubicua función 'Pulgar arriba/abajo'. Esto nos permite ver cuán útil es una página y, si no lo es, programarla para recibir la atención correctiva necesaria. Encontrará los controles de esta función debajo de la región Content (ToC) de la página, en el panel derecho. Haga clic una vez en un icono de pulgar para registrar su 'voto'; haga clic de nuevo para eliminarlo. Si hace clic en el icono Thumbs Down y AND ha iniciado sesión en su cuenta de Altium, tendrá la oportunidad de proporcionar comentarios sobre por qué la página no le resultó útil. Esto envía un informe directamente al equipo de Documentación Técnica.

Mecanismo de comentarios sobre la documentación

De vez en cuando puede encontrar o descubrir un problema en un documento, como una errata, un problema de acceso, información incorrecta o poco clara, o información desactualizada. Errar es humano y contamos con usted, nuestro lector, para ayudarnos a corregir esos problemas. Con este fin, la documentación técnica incorpora un mecanismo de comentarios al que se puede acceder desde cualquier página y que envía un informe directamente al equipo de Documentación Técnica.

Se accede a este mecanismo de comentarios usando el atajo de teclado Ctrl+Enter. Si hay una sección concreta de texto y/o imágenes a la que quiera hacer referencia, selecciónela (máximo 200 caracteres) antes de pulsar Ctrl+Enter.

Después de acceder a la función, se muestra la ventana Report Document Issue, con el texto/imagen de referencia añadido (si corresponde). Utilice el campo Issue (máx. 500 caracteres) para proporcionar tantos detalles como sea posible; realmente nos ayuda a investigar y resolver un problema válido con mayor rapidez. Una vez listo, haga clic en el botón Send Feedback para enviar. Un mensaje de confirmación de agradecimiento reflejará el envío correcto y la recepción de su informe. ¡Nunca se insistirá lo suficiente en lo importante que es para nosotros su comentario y, por tanto, lo sinceramente agradecido que es!

Soporte para visualización en cualquier dispositivo

Quedaron atrás los días en que todos los diseñadores se sentaban frente a un ordenador de escritorio con un único monitor de 1280x1024. Hoy, nuestros PC de escritorio tienen varios monitores de distintos tamaños y resoluciones. También necesitamos poder trabajar desde un portátil cuando estamos sobre el terreno o en la oficina del cliente. Además, como somos apasionados del conocimiento, también nos gusta poder usar la tableta o el teléfono para absorber más información mientras esperamos ese vuelo o tomamos el autobús hacia la oficina.

Para presentar el contenido de modo que funcione en todos estos diferentes dispositivos, la documentación técnica (como parte del sitio web principal altium.com) emplea responsive web design. Un sitio web adaptable se comunica con el dispositivo de destino y ajusta la disposición y el tamaño del contenido para adaptarse a ese dispositivo, la resolución de pantalla y el tamaño del navegador. Puede hacerse una idea de esto cambiando el tamaño de su navegador; a medida que reduce el ancho, los elementos de la página se reorganizan y las fuentes y las imágenes se hacen más pequeñas. Incluso en una pantalla de 5 pulgadas el sitio sigue siendo funcional y, por ejemplo, el árbol de navegación continúa disponible en su tableta o teléfono como un menú desplegable.

Documentación preparada para impresión

¿Desea imprimir parte de la documentación técnica? Como adoptamos la funcionalidad 'en línea' y también usamos muchos efectos visuales atractivos para transmitir la información, primero deberá asegurarse de que la página esté preparada para enviarla a su fiel dispositivo de impresión (o guardarla como PDF). En el lado derecho del área del banner inferior encontrará un control para hacer precisamente eso, que le permitirá obtener una versión de la página preparada para impresión.

Documentación localizada

Parte de nuestro contenido está disponible en idiomas distintos del inglés. Utilice el selector de idioma, situado en el lado izquierdo del área del banner inferior, para seleccionar el idioma deseado entre los actualmente compatibles.

El contenido en idioma alternativo para una versión concreta de una página se mostrará automáticamente si está disponible; de lo contrario, se mostrará el contenido en inglés. La siguiente presentación ilustra la localización en acción para una página, mostrando el contenido original en inglés junto con solo algunos de los otros idiomas disponibles (japonés, chino, coreano y polaco).

Traducción del navegador (no oficial)

Según el navegador web que prefiera, puede tener acceso a una traducción temporal e instantánea de la página activa que está leyendo. La siguiente presentación ilustra el uso de la función Traducir de Google Chrome para ver rápidamente la página en uno de una gran variedad de idiomas compatibles, en este caso alemán. Tenga en cuenta que la traducción es temporal: al hacer clic para ir a otra página y volver, o al actualizar la página, se volverá al idioma original que se estaba viendo.

La base de conocimiento

Las personas a menudo llegan a la Knowledge Base de Altium y asumen que representa la totalidad de nuestra documentación técnica. En realidad, es un recurso independiente por derecho propio. De hecho, ambos forman una relación simbiótica en la que la Knowledge Base y la Documentación técnica se interrelacionan y se complementan entre sí para proporcionarle la información que busca.

La Knowledge Base es un punto de referencia de autoservicio cuyo contenido es seleccionado por miembros de la organización de Soporte de Altium, personas que tienen un conocimiento experto de las soluciones de Altium. Ese contenido se construye directamente a partir de los problemas que otros usuarios han encontrado. El resultado es un repositorio orgánico de artículos que proporciona respuestas/soluciones específicas para temas y casos límite. Artículos precisos y de lectura rápida para que pueda volver a estar operativo.

La interfaz de la Knowledge Base es la simplicidad misma. Puede optar por buscar en todos los artículos o centrarse en artículos de una de las categorías de soluciones de diseño compatibles. Luego, simplemente empiece a escribir una cadena de búsqueda: el filtrado se aplicará a medida que lo haga. Cuando encuentre un artículo de interés, haga clic en su entrada para abrirlo.

Copyright de la documentación

La información de copyright que cubre la Documentación técnica se muestra cómodamente en la imagen de abajo y es accesible desde la sección QuickLinks del panel Nav Tree (Información de copyright de la documentación), que está disponible al visualizar cualquier página dentro de la documentación técnica. La página incluye un enlace a la página Copyrights & Trademarks del sitio web principal altium.com.

Una cita de despedida...

Es, en gran medida, un mantra que el equipo de Documentación técnica sigue y se esfuerza por cumplir. De cara al futuro, la documentación técnica seguirá evolucionando, especialmente desde la perspectiva de la usabilidad. Después de todo, tener abundancia de información solo es útil si nuestros usuarios pueden encontrarla. A medida que se pongan a disposición nuevos desarrollos, mejoras y funcionalidades, esta página se actualizará para reflejar y destacar esos elementos adicionales, y cómo utilizarlos mejor para obtener la información que necesita.