Como usar a documentação da Altium

Num relance

Este artigo mostra como aproveitar ao máximo a documentação técnica da Altium, desde encontrar o ponto de partida ideal no portal principal de documentação até usar os recursos integrados de navegação, pesquisa, QuickLinks e o atalho F1 nos softwares de projeto compatíveis. Também destaca os diferentes conjuntos de documentação do Altium Designer e do Altium 365, explica como os nomes dos produtos e a disponibilidade dos recursos são apresentados e mostra formas alternativas de acessar mais rapidamente as informações de que você precisa. Se você busca uma maneira mais clara e eficiente de navegar pela documentação da Altium e descobrir recursos úteis que talvez tenham passado despercebidos, este guia vai ajudar. Continue lendo e facilite sua próxima busca.

- Saiba onde acessar a documentação da Altium, como o portal principal está organizado e como navegar com mais eficiência entre os recursos específicos de cada produto.
- Descubra maneiras práticas de encontrar respostas mais rapidamente, incluindo pesquisa na página, QuickLinks, navegação por trilha de navegação, métodos alternativos de acesso e o atalho de ajuda F1.
- Entenda como a interface da documentação está estruturada, incluindo observações sobre a disponibilidade de recursos e a documentação de versões anteriores, para interpretar melhor as informações apresentadas.
Aprofunde-se com a IA:

Um amplo conjunto de documentação técnica é disponibilizado para toda a gama de soluções de projeto da Altium. Este documento apresenta um conjunto prático de “dicas e truques” para usar a documentação e encontrar o que você precisa, além de fornecer detalhes sobre os muitos e variados aspectos da documentação que talvez você nem soubesse que existiam.

Acessando a documentação técnica

O principal ponto de acesso à documentação técnica — a “porta de entrada”, por assim dizer — é: https://www.altium.com/documentation/. 

No centro da página estão os dois conjuntos de documentação a seguir:

  • Altium Designer – o software de projeto para desktop, identificado pelas seguintes marcas:

    • Altium Designer Develop – quando faz parte da solução Altium Develop.

    • Altium Designer Agile – quando faz parte das soluções Altium Agile Teams ou Altium Agile Enterprise.

    • Altium Designer – quando ainda está em uso (com licença por prazo determinado vigente) e não faz parte de uma solução de plataforma.

  • Altium 365 – a plataforma em nuvem, cujo Workspace principal é identificado pelas seguintes marcas:

    • Altium Develop Workspace - quando criado como parte da solução Altium Develop.

    • Altium Agile Teams Workspace - quando criado como parte da solução Altium Agile Teams.

    • Altium Agile Enterprise Workspace - quando criado como parte da solução Altium Agile Enterprise.

    • Altium 365 Workspace – quando ainda está em uso com o Altium Designer (com licença por prazo determinado vigente) e não faz parte de uma solução de plataforma.

Observe que, em ambos os casos, um único conjunto de documentação é usado para oferecer suporte a todas as soluções. Na documentação do Altium Designer, a forma abreviada “Altium Designer” normalmente é usada para se referir ao software. Na documentação do Altium 365, “Altium Platform” (ou “Altium 365”) é usado para se referir à plataforma, e “Altium Workspace” (ou “Altium 365 Workspace” ou apenas “Workspace”) para se referir a um Workspace hospedado na plataforma.

O Altium Designer agora está disponível como parte das novas soluções de plataforma da Altium. Quando acessado pelo Altium Develop, ele é fornecido como Altium Designer Develop, e quando acessado pelo Altium Agile Teams ou Altium Agile Enterprise, ele é fornecido como Altium Designer Agile. Essas versões são instaladas diretamente pela página Home de cada solução, por meio de sua interface baseada em navegador. Ao longo desta documentação, o termo Altium Designer é usado para se referir ao software de forma geral.

Se você atualmente possui o Altium Designer com uma licença por prazo determinado vigente, seu software continuará funcionando exatamente como funciona hoje, inclusive recebendo todas as atualizações durante todo o período de vigência da licença. Após o término desse período, o acesso a futuras atualizações e novas funcionalidades exigirá a migração para uma de nossas soluções de plataforma, nas quais todo o desenvolvimento contínuo é disponibilizado.

Observe que uma instalação existente do Altium Designer não pode ser atualizada diretamente para o Altium Designer Develop ou o Altium Designer Agile. É necessária uma atualização de transição. Sua instalação atual do Altium Designer pode continuar se conectando ao seu Altium 365 Workspace existente, bem como ao Workspace de uma solução de plataforma (Altium Develop Workspace, Altium Agile Teams Workspace ou Altium Agile Enterprise Workspace), desde que você esteja usando o Altium Designer 20.1.14 ou posterior.

A documentação abrange todos os recursos e funcionalidades de um produto ou elemento de uma solução completa. No caso do Altium Designer e do Altium 365, o acesso a um recurso apresentado em uma página depende da solução Altium que você possui — Altium Develop, Altium Agile Teams, Altium Agile Enterprise ou Altium Designer (com licença por prazo determinado vigente). Se você não encontrar um recurso documentado no seu software, entre em contato com a equipe de vendas da Altium para saber mais.

Trabalhando com a página:

  • Clique no título principal de um bloco para acessar a página inicial da documentação daquela solução de projeto.

  • Clique em um link nos blocos do Altium Designer ou do Altium 365 para acessar informações sobre aquela área específica.

  • Use os menus QuickLinks disponíveis para acessar outras páginas importantes, conforme mostrado abaixo para os blocos de documentação do Altium Designer e do Altium 365.

Se um produto tiver sido descontinuado ao longo da sua jornada com a Altium, é provável que a documentação associada a ele ainda esteja disponível de alguma forma. Nesses casos, você encontrará uma opção correspondente ao lado do link para download do software na página Outros instaladores.

Acesso direto com “F1”

Para softwares de projeto, incluindo o Altium Designer, vale muito a pena se familiarizar com o atalho de teclado F1 . Posicione o ponteiro do mouse sobre um dos diversos recursos do ambiente do software — um comando de menu, uma caixa de diálogo, um painel, um objeto de projeto ou uma palavra-chave da linguagem de consulta — e pressione F1 para acessar a documentação correspondente. Essa conexão entre o recurso do software e a documentação técnica é viabilizada por um arquivo de mapeamento (*.HelpID), que fica na pasta \Program Files\Altium\AD<Solution>\Help da instalação principal.

A imagem a seguir ilustra o recurso em ação. Aqui, o atalho de teclado F1 está sendo usado para acessar a documentação do comando Material Library, disponível ao editar o empilhamento de camadas de uma PCB usando o Gerenciador de empilhamento de camadas.

Atualizações do F1

Nos softwares de projeto compatíveis, o arquivo de mapeamento HelpID na pasta \Help principal da instalação é atualizado a cada nova versão do software. No entanto, às vezes a equipe de Documentação Técnica atualiza o arquivo de mapeamento entre versões. Para disponibilizar as alterações mais recentes do F1 aos nossos usuários, sem precisar esperar pela próxima versão do software, empregamos uma abordagem de atualização dinâmica que utiliza a configuração Check frequency, na página System - Installation da caixa de diálogo Preferences.

Desde que o intervalo de verificação tenha decorrido, na próxima vez que o recurso F1 for usado, uma versão mais recente do arquivo de mapeamento será baixada para \ProgramData\Altium\Altium Designer <Solution> <GUID>\Help pasta. Esta versão mais recente do arquivo HelpID tem precedência sobre o arquivo padrão na pasta \Help da instalação principal.

Métodos alternativos de acesso

A documentação técnica também pode ser acessada de várias outras maneiras, incluindo:

  • Por meio de uma pesquisa externa usando o mecanismo de pesquisa do seu navegador, por exemplo, o Google. Para direcionar essa pesquisa à documentação da Altium, insira o site como prefixo, usando o formato site:altium.com/documentation <Search String> (por exemplo, site:altium.com/documentation PCB Layout Replication).

  • Seguindo um link fornecido em uma publicação oficial da Altium no fórum.

  • Seguindo links disponíveis em outras áreas do site principal altium.com (por exemplo, na área da Central de Aprendizagem ou em páginas dedicadas a novidades e recursos específicos).

  • Seguindo links específicos no software. Por exemplo, em um menu Help ou usando links como 'Learn More' (ou com texto semelhante).

A interface da documentação

A interface da documentação normalmente compreende até 14 regiões distintas, mostradas na imagem a seguir e detalhadas na sequência.

  1. Product Documentation Selector – use este controle para alternar entre os conjuntos específicos de documentação disponíveis.

  2. Theme Selector – use este controle para alternar entre os modos de exibição claro () e escuro (), conforme ilustrado no exemplo a seguir.

     

     

     
  1. Search – use este campo para inserir um termo de pesquisa e encontrar informações na documentação do produto que está sendo visualizada. Os filtros de pesquisa relacionados permitem ajustar o escopo da pesquisa posteriormente. Para obter mais detalhes, consulte Ferramenta de pesquisa na documentação.

  2. Nav Tree Pane – apresenta todas as páginas que compõem a documentação do produto que está sendo visualizada. As entradas são agrupadas de forma lógica; clique em uma delas para visualizar a página correspondente. Os controles no canto superior direito do painel permitem redimensioná-lo e/ou controlar sua visibilidade.

  3. QuickLinks – um componente específico e estático do painel Nav Tree que é sempre exibido, independentemente da documentação do produto que está sendo visualizada. Ele oferece acesso direto a esta página, às informações de direitos autorais e ao portal principal da documentação, além de acesso rápido à Base de Conhecimento.

  4. Breadcrumbs – oferece uma forma secundária de navegação, com base na página ativa que está sendo lida, para as páginas superiores na hierarquia. Quando o caminho de navegação envolve muitas páginas, um controle de reticências é usado para manter a exibição organizada. Clique nele para acessar uma janela pop-up contendo todas as páginas intermediárias adicionais do caminho, cada uma com um link ativo para a página correspondente.

  5. Main Page Content – esta é a área principal da interface, que apresenta a página selecionada no painel Nav Tree . Para obter mais detalhes sobre os vários aspectos do conteúdo de uma página, além de dicas sobre seus recursos e funcionalidades, consulte Visualização de um documento técnico.

  6. Feature Availability Note – este elemento é exibido em todas as páginas de determinados conjuntos de documentação. A documentação técnica abrange todos os recursos e funcionalidades de um produto ou elemento de uma solução completa. No caso do Altium Designer e do Altium 365, o acesso a um recurso apresentado em uma página depende da solução Altium que você possui – Altium Develop, Altium Agile Teams, Altium Agile Enterprise ou Altium Designer (com assinatura vigente). Se você não encontrar no seu software um recurso documentado, entre em contato com a equipe de vendas da Altium para saber mais.

  7. Legacy Documentation Note – este elemento é exibido em todas as páginas da documentação do Altium Designer. Ele oferece acesso rápido à seção Documentação de versões anteriores da página Outros instaladores, que contém a documentação referente a versões anteriores do software.

  8. Table of Contents – a região Content  do painel à direita apresenta, quando aplicável, a estrutura da página ativa em termos de seus títulos (níveis 2 a 4, já que o nível 1 é o título da página). Clique em uma entrada para ir até esse local na página. Por outro lado, conforme você rola a página, a região Content é atualizada para acompanhar sua posição no documento.

  9. Like/Dislike – REMOVIDO. A página será atualizada oportunamente para removê-lo da imagem acima.

  10. Language Selector – oferece uma maneira rápida de alternar a visualização da documentação para um dos vários idiomas oficialmente compatíveis.

  11. Documentation Feedback (exibido quando você está conectado à sua conta Altium) – este recurso oferece uma maneira rápida de enviar comentários sobre uma página à equipe de Documentação Técnica, principalmente para apontar erros de digitação, informações incorretas/desatualizadas ou informações ausentes. Basta selecionar um texto e/ou uma imagem na página e usar o atalho de teclado Ctrl+Enter para acessar o recurso. Para obter mais detalhes, consulte Mecanismo de feedback da documentação.

  12. Printer-friendly version – permite gerar, instantaneamente, uma versão da página cujo conteúdo é preparado especialmente para facilitar a impressão (por exemplo, para salvar como PDF).

No conjunto de documentação do Altium On-Prem Enterprise Server, também haverá um Version Selector. Use este controle, quando disponível e localizado à direita do Seletor de Documentação do Produto, para garantir que você esteja visualizando a documentação correta para a versão do produto que está usando. Para obter mais detalhes, consulte Documentação por versão.

Páginas de estruturação

No painel Nav Tree da interface, às vezes você encontrará entradas que, ao serem clicadas, não apresentam uma página de documentação. Isso é intencional: elas são usadas para dar uma estrutura adicional à árvore quando é necessário agrupar páginas sob um elemento 'pai', mas não há necessidade de informações na própria página pai. Esse tipo de página — uma página Structure — cumpre exatamente essa função. Ao passar o cursor sobre uma dessas entradas, ela não fica sublinhada (como acontece com a entrada de uma página 'real' de documentação). Ao clicar em uma dessas entradas, ela apenas expande essa seção da árvore. Clique novamente para recolhê-la.

Visualização de um documento técnico

As seções a seguir fornecem informações sobre vários aspectos do conteúdo da própria página.

Convenções do documento

Bold

Usado para destacar um comando de menu, controle de caixa de diálogo, botão ou barra de ferramentas mencionado no texto.

Exemplos:
 

  • Use o comando Annotate Schematics Quietly.

  • Se a opção Copy routed nets estiver habilitada na caixa de diálogo, o roteamento a partir do bloco de origem será inserido.

  • Clique no botão Refresh na parte superior do Constraint Manager.

  • Localização e uso do comando Place Pad () na barra de ferramentas Active Bar ou Wiring .

Italic

Usado para destacar um painel ou uma caixa de diálogo mencionado no texto.

Exemplos:
 

  • Os recursos do PCB CoDesign são acessados e operados por meio do painel PCB CoDesign.
  • A anotação do esquemático é configurada usando a caixa de diálogo Annotate.

O itálico também é usado, quando necessário, para dar ênfase a um ponto importante.

Monospace

Usado para destacar um local no disco rígido, nome de arquivo, extensão de arquivo, item de uma lista de opções (em um menu suspenso de um campo), expressão de linguagem de consulta ou palavra-chave de linguagem mencionada no texto.

Exemplos:
 

  • Uma seleção de projetos de exemplo é instalada como parte da instalação inicial. Em uma instalação padrão do software, esses projetos podem ser encontrados na pasta \Users\Public\Documents\Altium\AD<Solution>\Examples.

  • Este instalador baseado em assistente é acessado executando um pequeno arquivo executável – AltiumDesignerDevelopSetup.exe (ou AltiumDesignerAgileSetup.exe).

  • Um documento de desenho de fabricação baseado no Draftsman pode ser adicionado a um projeto de PCB (*.PCBDwf), a um projeto de chicote elétrico (*.HarDwf) ou a um projeto multiplacas (*.MbDwf).

  • TouchesRoom('Monitor','Auxilary','Effects')

Bold + Monospace

Usado para destacar um atalho de teclado mencionado no texto.

Exemplos:
 

  • Clique com o botão direito do mouse ou pressione Esc para sair do modo de posicionamento.

  • Pressione Spacebar para girar o objeto de texto no sentido anti-horário ou Shift+Spacebar para girá-lo no sentido horário.

Menu » Menu Item

As referências ao menu principal na documentação do Altium Designer usam o caractere » como separador. O primeiro item faz referência ao próprio menu, seguido pelo comando nesse menu. Se um comando for acessado por meio de um submenu, um caractere » adicional será usado para indicar isso.

Exemplos:
 

  • A configuração da verificação de regras de projeto é realizada na caixa de diálogo Design Rule Checker, acessada pelo comando Tools » Design Rule Check a partir de um documento de PCB.

  • As entradas de chicote estão disponíveis para posicionamento no editor de esquemáticos. Escolha Place » Harness » Harness Entry nos menus principais.

Tab | Group | Button

As referências ao menu principal na documentação do Altium CircuitStudio e do Altium CircuitMaker usam o caractere | como separador. O primeiro item faz referência à guia específica do menu da faixa de opções, seguido pelo grupo (ou região) da guia e, por fim, pelo botão dentro desse grupo. Se um comando for acessado por meio de um menu associado a um botão, o caractere » será usado para indicar isso.

Exemplos:
 

  • O painel View Configuration, usado para configurar o que é exibido no espaço de projeto e como é exibido, pode ser acessado no editor de PCB escolhendo View | PCB | View Configuration.
  • Para mover os objetos atualmente selecionados, use o comando Tools | Arrange | Move » Move Selection.
Key1+Key2

Ao se referir a atalhos, o uso do símbolo de mais (+) indica que várias teclas devem ser mantidas pressionadas no teclado na sequência indicada.

Exemplos:
 

  • Shift+H (para ativar ou desativar o visor Heads Up no editor de PCB).

  • Shift+Ctrl+X (para ativar ou desativar o modo de seleção cruzada nos editores de esquemáticos/PCB).

Key1, Key2

Ao se referir a sequências de teclas de acesso rápido, o uso do símbolo de vírgula (,) indica que cada tecla da sequência deve ser pressionada sucessivamente.

Exemplos:
 

  • X, A (no editor de esquemáticos, para desmarcar todos os objetos na folha atual).

  • P, V, K (no editor de esquemáticos, para posicionar uma diretiva de máscara de compilação).

  • T, D, R (no editor de PCB, para executar uma verificação de regras de projeto em lote).

Link

Um hiperlink normal para um destino que pode ser:
 

  • Outra área da mesma página.
  • Uma página diferente no mesmo conjunto de documentação do produto.
  • Uma página diferente em outro conjunto de documentação de produto.
  • Uma página fora da documentação técnica.
Caixa de informações

Usada para destacar informações adicionais importantes sobre um determinado tópico abordado na página.

Exemplo:
 

A fonte dos dados da BOM de um projeto de chicote elétrico é o desenho de layout do projeto. Portanto, se o diagrama de fiação do seu projeto de chicote elétrico foi alterado e essa alteração deve ser refletida na BOM, o desenho de layout deve ser atualizado primeiro.

Caixa de recurso/dica

Usada para destacar um recurso ou uma funcionalidade específica que você deve conhecer, ou uma dica de uso.

Exemplo:
 

O conjunto de projetos de exemplo do Altium Designer inclui um projeto de exemplo de chicote elétrico –Harness_Demo_Prj.PrjHar – na pasta \Users\Public\Documents\Altium\AD<Solution>\Examples\Harness Demo MB\Harness_Demo_Prj por padrão, associado a um projeto de demonstração multiplacas (\Examples\Harness Demo MB\Harness_Demo_MB\Harness_Demo_MB.PrjMbd), para que você possa experimentar os recursos de chicotes elétricos logo após a instalação.

Caixa de aviso

Usada para destacar algo importante que você deve saber ou fazer.

Exemplo:
 

É altamente recomendável que uma verificação de regras de projeto em lote seja sempre realizada antes de gerar a arte final. A DRC online detecta apenas novas violações – violações criadas após a ativação do recurso –, enquanto a DRC em lote permite que uma verificação seja executada manualmente a qualquer momento durante o processo de projeto da placa. Assim, embora bons projetistas conheçam o valor da DRC online, eles também sabem que o projeto da placa deve começar e terminar com uma DRC em lote.

Elementos visuais envolventes

Ao longo da documentação, você encontrará uma variedade de elementos visuais usados para transmitir informações de maneira mais envolvente. As seções a seguir ilustram como eles aparecem em uma página e como são usados.

Imagem estática

A simples imagem estática é um dos pilares da documentação, usada em conjunto com o texto ao redor para fornecer detalhes precisos sobre um aspecto importante do software.

Para manter a apresentação (e a legibilidade) de um documento adequada, as páginas usam uma largura fixa. Por isso, geralmente não é possível apresentar imagens em tamanho real por padrão. Ao passar o cursor sobre uma imagem, ele mudará de um ícone de ponteiro () para um ícone de lupa (). Isso indica que, ao clicar na imagem, sua versão em tamanho real será exibida em uma janela flutuante (quando aplicável e de acordo com o tamanho atual da janela do navegador). A imagem a seguir ilustra isso para uma imagem estática na documentação (ironicamente, você precisará clicar na imagem para vê-la em tamanho real).

Apresentação de slides

Um elemento de apresentação de slides pode conter várias imagens (e vídeos) para exibir mais informações visuais de forma organizada, acompanhadas de legendas. Esse elemento é especialmente útil para ilustrar uma progressão ou uma sequência de etapas a seguir ao usar um determinado recurso do software.

A imagem a seguir ilustra um exemplo de apresentação de slides na documentação e destaca algumas áreas importantes, descritas em seguida.

  1. Use estes controles para avançar e voltar na apresentação de slides, respectivamente. Ao passar o cursor sobre uma área, ela ficará mais escura. Você pode clicar em qualquer ponto dentro da 'moldura da seta', não apenas no ícone da seta.

  2. Estas 'bolinhas' indicam quantos slides há na apresentação e em qual deles você está (bolinha mais escura). Você pode clicar em uma bolinha para ir rapidamente para o slide correspondente.

  3. Uma apresentação de slides pode incluir legendas — uma por slide. Elas serão atualizadas conforme você clicar para navegar pelos diferentes slides.

Assim como nas imagens comuns, você pode clicar em um slide para visualizá-lo em tamanho real. Os controles de seta aparecem quando você move o cursor para a esquerda e para a direita, permitindo navegar pelos slides sem sair do modo de 'tamanho real'.

GIF animado

Um GIF animado é usado quando é necessário capturar um processo ou aspecto do software de forma semelhante a um vídeo, mas a demonstração visual é curta e usar um vídeo seria um exagero. Um GIF animado na documentação se distingue por apresentar um botão de 'reprodução' bem visível no centro, conforme ilustrado na imagem a seguir. Após clicar no botão, o GIF será reproduzido até o fim e parará, exibindo novamente o botão de reprodução.

Vídeo (MP4)

Um vídeo, assim como um GIF, é usado quando é necessário capturar visualmente a execução de um processo ou aspecto do software e esse conteúdo visual é mais longo do que o adequado para um GIF. Um vídeo na documentação se distingue por um painel de controles na parte inferior, conforme ilustrado na imagem a seguir. Clique em qualquer ponto do vídeo para iniciar a reprodução (não é necessário clicar na seta de reprodução no canto inferior esquerdo). Clique novamente (em qualquer ponto do vídeo) para pausar. Use os controles de vídeo disponíveis para, por exemplo, alternar para o tamanho real e voltar, avançar e retroceder na linha do tempo e alterar a velocidade de reprodução.

Imagem que muda ao passar o cursor

Uma imagem que muda ao passar o cursor é usada para apresentar um cenário de 'antes e depois' ou algum tipo de comparação relacionada a um recurso ou função do software. Ela consiste em apenas duas imagens. É exibida na página como uma imagem estática comum, com a primeira imagem apresentada por padrão. Ao passar o cursor sobre ela, a segunda imagem aparece.

A seguir, há um exemplo real desse tipo de imagem usado na documentação. Neste caso, ela é usada para ilustrar vias de blindagem (imagem padrão/primeira imagem) e vias de costura (segunda imagem, exibida ao passar o cursor).

Observe que, embora você possa clicar nesse tipo de imagem para visualizá-la em tamanho real, isso só funciona para a imagem base/primeira imagem. Observe também que esse tipo de imagem está sendo gradualmente substituído por apresentações de dois slides.

Imagem pop-up

Uma imagem pop-up é usada para mostrar algo no contexto do texto ao redor, sem adicionar especificamente essa imagem ao fluxo do conteúdo. Nesse sentido, ela pode ser considerada uma 'observação à parte' ou um exemplo que reforça um comentário ou uma afirmação feita no texto. Esse elemento aparece com um de dois ícones –  (uma imagem pop-up) ou  (um GIF animado ou vídeo pop-up). A imagem a seguir mostra um elemento pop-up após ser clicado; neste caso, um pop-up do tipo 'imagem', que exibe a imagem em tamanho real.

Em alguns casos na documentação, um elemento de imagem pop-up aparece como se fosse um hiperlink normal, mas inclui uma indicação no texto de que algo será 'mostrado' ou de que um 'exemplo' será apresentado ao clicar.

Texto ao passar o cursor (dica de ferramenta)

O texto ao passar o cursor (ou dica de ferramenta) é usado para fornecer orientações adicionais e úteis no contexto de um item específico de uma página. Pode ser, por exemplo, uma nota explicativa sobre um item ou uma explicação, semelhante à de um glossário, sobre a terminologia utilizada. Uma dica de ferramenta pode aparecer de duas formas:

  • O ícone . Passe o cursor sobre o ícone para acessar a dica.

  • Texto com sublinhado pontilhado. Passe o cursor sobre o texto para acessar a dica.

Seções recolhíveis

As seções recolhíveis são usadas para manter o conteúdo da página organizado e evitar o excesso de informações visíveis. Elas geralmente contêm informações mais aprofundadas, mas que não são necessariamente exigidas para compreender o fluxo normal da página (e, portanto, não precisam ficar sempre visíveis). Esse conteúdo pode incluir, por exemplo, opções disponíveis em uma caixa de diálogo ou painel, ou considerações específicas sobre determinado aspecto de um recurso discutido no conteúdo principal. Expanda ou recolha uma seção clicando em qualquer ponto do cabeçalho dela.

 

 

 

Todas as seções recolhíveis ficam inicialmente fechadas ao acessar a página. Ao acessar o recurso de busca na página do navegador (Ctrl+F), todas as seções recolhíveis da página ativa serão expandidas.

Como obter um link para a página ou uma seção específica

Quando quiser compartilhar uma página com outras pessoas, você precisará obter rapidamente o URL dela. Ele pode ser obtido (copiado para a Área de Transferência do Windows) de duas formas:

  1. Na barra de endereços do navegador, assim que você acessar a página.

  2. Clicando com o botão direito do mouse no item correspondente à página na árvore de navegação à esquerda e, em seguida, usando o comando Copy link address no menu de contexto.

Além disso, você também pode obter um URL para uma seção específica da página que está lendo, da seguinte forma:

  1. Use o painel à direita para acessar a seção desejada na estrutura de conteúdo da página e copie o URL da barra de endereços do navegador.

  2. Role a página até a seção desejada. Conforme você rola, a barra de endereços do navegador é atualizada para refletir a seção atual.

  3. Clique com o botão direito do mouse no item correspondente à seção desejada na estrutura de conteúdo da página (no painel à direita) e use o comando Copy link address do menu de contexto.

Você também pode obter rapidamente um link nos seguintes locais:

  • Main Section Header - clique no controle 'Copiar link' à esquerda do cabeçalho de uma seção principal.

  • Collapsible Section - clique no controle 'Copiar link' à direita do título de uma seção recolhível.

Documentação por versão

A documentação associada ao Altium On-Prem Enterprise Server é organizada por versão. Isso permite selecionar a versão correta da documentação para a versão do software que você está usando. A versão pode ser selecionada no portal principal da documentação (no menu QuickLinks do bloco do produto) ou a qualquer momento na documentação, usando o seletor de versão disponível na área do banner superior, conforme mostrado abaixo.

Com a chegada das soluções de plataforma (Altium Develop, Altium Agile Teams e Altium Agile Enterprise), a documentação técnica do Altium Designer, que serve de base para essas soluções e era versionada até o Altium Designer 25, inclusive, deixou de ser versionada. Cópias em HTML de cada uma dessas versões anteriores podem ser baixadas na página Outros instaladores . A documentação on-line mais recente do Altium Designer pode ser encontrada aqui.

Uma página da documentação é criada em uma versão específica — sua versão “base”. Observe que apenas as versões do software para as quais a página está disponível são listadas no seletor.

O sistema de versionamento alerta você quando está lendo uma página que não está em sua versão mais recente. Ele faz isso de duas maneiras:

  • O número da versão no seletor suspenso de versões é exibido em uma cor diferente e acompanhado de um símbolo de aviso.
  • Um aviso é exibido na parte superior da página, com um link para a versão mais recente. Ao acessar o link, a opção no seletor de versões será alterada automaticamente para a versão mais recente disponível.

Versões aplicáveis

Embora o software evolua de uma versão para outra, adicionando novos recursos e melhorias às suas funcionalidades, a documentação versionada correspondente do Altium On-Prem Enterprise Server pode ser afetada apenas em determinadas áreas. Muitas páginas não serão afetadas pela próxima versão do software, de modo que o mesmo conteúdo aplicável anteriormente também se aplica à versão posterior. Por isso, cada página apresenta uma indicação das versões do software às quais seu conteúdo se aplica.

A imagem a seguir ilustra essa indicação. Nela, está aberta a versão 8.0 da página que detalha o recurso Histórico do projeto. Esse conteúdo se aplica igualmente às versões 7.0, 7.1 e 7.2 do software. Em outras palavras, não há diferença no conteúdo da página se você definir o seletor de versões da documentação como 7.0, 7.1, 7.2 ou 8.0.

Recurso de pesquisa na documentação

Para ajudar você a encontrar informações na documentação técnica das soluções de projeto da Altium, há um poderoso Search recurso de pesquisa. Com tecnologia do Google, há, na verdade, um único recurso de pesquisa para todo o site altium.com. A forma e o local de acesso à pesquisa determinam o quanto seus resultados iniciais serão “filtrados” :

  • Pelo banner principal do site — acessado e utilizado conforme ilustrado na apresentação de slides a seguir. A pesquisa é realizada em todo o site, e os resultados são apresentados em uma aba separada do navegador.

 

 

 

 
  • Pela página de entrada da documentação técnica (altium.com/documentation) — acessada e utilizada conforme ilustrado na apresentação de slides a seguir. A pesquisa é realizada em todos os conjuntos de documentação disponíveis para as diversas soluções de projeto da Altium, bem como na Base de conhecimento. Os resultados são apresentados na mesma aba do navegador.

 

 

 

 
  • Por uma página da documentação técnica — acessada e utilizada conforme ilustrado na apresentação de slides a seguir. A pesquisa é realizada apenas no conjunto de documentação ativo que está sendo visualizado. Os resultados são apresentados na mesma aba do navegador.

 

 

 

 

A terceira opção da lista acima oferece a pesquisa mais direcionada, reduzindo o nível de “ruído” de outros locais fora do conjunto de documentação específico que você está consultando. No entanto, independentemente do método de acesso utilizado, você pode configurar os filtros conforme necessário à esquerda dos resultados e clicar no botão Apply para executar a pesquisa novamente.

Para pesquisar uma sequência de texto específica, coloque-a entre aspas duplas ("<String>"), por exemplo: "Ambiente de projeto unificado".

Páginas QuickNav (documentação do Altium Designer)

As informações sobre objetos de projeto e painéis do Altium Designer estão distribuídas por muitas páginas da documentação do Altium Designer. Para facilitar o acesso a essas informações, foi adotado o conceito de páginas QuickNav. De forma semelhante a um mapa de lojas em um shopping, uma página QuickNav fornece informações de referência rápida sobre os elementos de projeto disponíveis para uma determinada área de projeto, permitindo acessar rapidamente informações mais detalhadas sobre cada um deles.

Na maioria dos casos, uma página QuickNav apresenta informações em três seções distintas:

  • Graphical Overview - uma visão geral visual de objetos usados com frequência, por exemplo.
  • Slideshow - apresenta mais informações gerais sobre alguns dos elementos que você utilizará com mais frequência.
  • A-Z Listing - uma prática lista em ordem alfabética. Sem enfeites nem complicações. Apenas links diretos para os detalhes de um elemento específico.

As páginas QuickNav estão disponíveis para:

Uma variação das páginas QuickNav também está disponível na documentação do Altium 365 – QuickNav - Principais recursos da plataforma. A página fornece informações de referência rápida sobre alguns dos principais recursos disponíveis na plataforma Altium (Altium 365), permitindo acessar rapidamente informações mais detalhadas sobre cada um deles.

Páginas QuickStart (documentação do Altium Designer)

Na documentação do Altium Designer (que serve de base e dá suporte às soluções de plataforma disponíveis da Altium), há páginas principais que, consideradas em conjunto, fornecem um valioso conjunto de informações de “início rápido” (QuickStart). Essas páginas orientam você por uma área específica de projeto, oferecendo o nível de detalhe adequado para começar a compreendê-la, sem se aprofundar demais. Essas páginas são:

Embora não seja considerada propriamente uma dessas páginas “QuickStart”, a página Criação & manutenção de componentes e bibliotecas é um ótimo ponto de partida para obter uma visão geral dessa área e, de forma semelhante às páginas QuickStart, fornece informações sobre a criação de um novo componente de biblioteca do Workspace.

Mecanismo de feedback da documentação

De vez em quando, você pode encontrar um problema em um documento, como um erro de digitação, um problema de acesso, informações incorretas ou pouco claras, ou informações desatualizadas. Errar é humano, e contamos com vocês, nossos leitores, para nos ajudar a corrigir esses problemas. Para isso, a documentação técnica incorpora um mecanismo de feedback que pode ser acessado de qualquer página e que envia um relatório diretamente à equipe de Documentação Técnica.

Esse mecanismo de feedback é acessado por meio do atalho de teclado Ctrl+Enter. Se houver um trecho específico de texto e/ou uma imagem que você queira mencionar, selecione-o (no máximo 200 caracteres) antes de pressionar Ctrl+Enter.

Um lembrete prático do recurso e de seu atalho é exibido no banner na parte inferior de cada página quando você está conectado à sua conta Altium.

Após acessar o recurso, a janela Report Document Issue é exibida com o texto e/ou a imagem de referência adicionados (se aplicável). Use o campo Issue (no máximo 500 caracteres) para fornecer o máximo possível de detalhes — isso realmente nos ajuda a investigar e resolver um problema válido com mais rapidez. Quando estiver pronto, clique no botão Send Feedback para enviar. Uma mensagem de confirmação e agradecimento indica que seu relatório foi enviado e recebido com sucesso. Não há como enfatizar o suficiente o quanto seu feedback é importante para nós e, por isso, sinceramente apreciado!

 

 

 

 

Restrinja seu feedback a problemas na documentação. Para obter assistência técnica, consulte os Fóruns da Altium ou clique em Support Center na janela Report Document Issue .

Suporte à visualização em qualquer dispositivo

Foi-se o tempo em que todo projetista se sentava diante de um computador de mesa com um único monitor de 1280x1024. Hoje, nossos computadores de mesa têm vários monitores de diferentes tamanhos e resoluções. Também precisamos poder trabalhar em um notebook quando estamos em campo ou no escritório do cliente. Além disso, como somos ávidos por conhecimento, gostamos de poder usar nosso tablet ou celular para absorver mais informações enquanto esperamos um voo ou pegamos o ônibus para o escritório.

Para apresentar o conteúdo de forma adequada a todos esses dispositivos diferentes, a documentação técnica (como parte do site principal altium.com) utiliza responsive web design. Um site responsivo se comunica com o dispositivo de destino e ajusta o layout e o tamanho do conteúdo de acordo com esse dispositivo, a resolução da tela e o tamanho da janela do navegador. Você pode ter uma ideia disso redimensionando seu navegador: à medida que você reduz a largura, os elementos da página se reorganizam e as fontes e imagens ficam menores. Mesmo em uma tela de 5 polegadas, o site continua funcional, com a árvore de navegação, por exemplo, ainda disponível no tablet ou celular como um menu suspenso.

Documentação otimizada para impressão

Quer imprimir parte da documentação técnica? Como priorizamos os recursos on-line e também usamos muitos efeitos visuais elaborados para transmitir as informações, primeiro você precisará garantir que a página esteja preparada para ser enviada à sua fiel impressora (ou salva como PDF). No lado direito da área do banner inferior, você encontrará um controle que faz exatamente isso, permitindo obter uma versão da página otimizada para impressão.

Documentação localizada

Parte do nosso conteúdo está disponível em outros idiomas além do inglês. Use o seletor de idioma, localizado no lado esquerdo da área do banner inferior, para selecionar o idioma desejado entre os atualmente disponíveis.

O conteúdo em outro idioma para uma determinada versão de uma página será apresentado automaticamente, se estiver disponível; caso contrário, o conteúdo em inglês será exibido. A apresentação de slides a seguir ilustra a localização de uma página, mostrando o conteúdo original em inglês e apenas alguns dos outros idiomas disponíveis (japonês, chinês, coreano e polonês).

 

 

 

 

 

 

Para manter o conteúdo traduzido para os outros idiomas disponíveis o mais sincronizado possível com as alterações frequentes no original em inglês, a tradução é automatizada por meio de IA. Ao visualizar conteúdo traduzido, ele é identificado pela presença do ícone  no banner inferior (por exemplo,  ao visualizar uma página em coreano). Essa indicação será removida à medida que a qualidade do conteúdo traduzido for verificada internamente. Se você notar algum problema no material traduzido, fique à vontade para enviar seu feedback usando o mecanismo habitual. Basta selecionar um texto e/ou uma imagem na página e usar o atalho de teclado Ctrl+Enter para acessar o recurso. Para obter mais detalhes, consulte Mecanismo de feedback da documentação.

Tradução pelo navegador (não oficial)

Dependendo do seu navegador preferido, você pode ter acesso à tradução temporária e instantânea da página que está lendo. A apresentação de slides a seguir ilustra o uso do recurso Traduzir do Google Chrome para visualizar rapidamente a página em um dos muitos idiomas disponíveis, neste caso, o alemão. Observe que a tradução é temporária: ao acessar outra página e voltar, ou ao atualizar a página, o conteúdo voltará ao idioma original que estava sendo visualizado.

O uso desse recurso de tradução pelo navegador é oferecido 'no estado em que se encontra' e não constitui conteúdo traduzido oficialmente fornecido pela Altium.

 

 

 

 

 

 

A Base de Conhecimento

Muitas pessoas chegam à Base de Conhecimento da Altium e presumem que ela representa toda a nossa documentação técnica. Na verdade, ela é um recurso independente. As duas mantêm uma relação simbiótica, na qual a Base de Conhecimento e a Documentação Técnica se interligam e se complementam para que você encontre as informações que procura.

A Base de Conhecimento é um ponto de referência para autoatendimento, cujo conteúdo é selecionado e organizado por membros da equipe de Suporte da Altium — pessoas com conhecimento especializado nas soluções Altium. Esse conteúdo é elaborado diretamente a partir de problemas encontrados por outros usuários. O resultado é um repositório orgânico de artigos que oferecem respostas e soluções específicas para diversos tópicos e casos excepcionais. Artigos objetivos e de leitura rápida para que você possa retomar suas atividades.

A interface da Base de Conhecimento é extremamente simples. Você pode optar por pesquisar em todos os artigos ou concentrar a busca em uma das categorias de soluções de projeto disponíveis. Depois, basta começar a digitar um termo de pesquisa — a filtragem será aplicada à medida que você digita. Ao encontrar um artigo de interesse, clique na entrada correspondente para abri-lo.

A maioria dos artigos da Base de Conhecimento inclui links para a Documentação Técnica, onde você encontra informações mais abrangentes e aprofundadas sobre um recurso de uma solução de projeto da Altium. Da mesma forma, há um link para a Base de Conhecimento na seção QuickLinks do painel Nav Tree, disponível ao visualizar qualquer página da documentação técnica.

Direitos autorais da documentação

As informações sobre os direitos autorais da Documentação Técnica são apresentadas na imagem abaixo e podem ser acessadas na seção Links rápidos do painel Árvore de navegação (Informações sobre os direitos autorais da documentação), disponível ao visualizar qualquer página da documentação técnica. A página inclui um link para a página Direitos autorais e marcas comerciais do site principal altium.com.

Uma citação para encerrar...

"A melhor documentação é aquela que continua evoluindo, ficando cada vez melhor com o passar do tempo. Ideias novas para transformar o que é ótimo em algo ainda melhor, sempre com o usuário em mente."

Esse é um verdadeiro mantra que a equipe de Documentação Técnica segue e se empenha em colocar em prática. Daqui para a frente, a documentação técnica continuará evoluindo, principalmente no que diz respeito à usabilidade. Afinal, ter uma grande quantidade de informações só é útil se nossos usuários conseguirem encontrá-las. À medida que novidades, melhorias e funcionalidades forem disponibilizadas, esta página será atualizada para apresentar e destacar esses novos elementos e mostrar como utilizá-los da melhor forma para encontrar as informações de que você precisa.

 

AI-LocalizedLocalizado por IA
Caso encontre um problema, selecione o texto/imagem e primaCtrl + Enterpara nos enviar o seu feedback.
Contents
Contents