Utilizzo della documentazione di Altium

Altium mette a disposizione un’ampia raccolta di documentazione tecnica per l’intera gamma di soluzioni di progettazione disponibili. Questo documento offre una pratica serie di “suggerimenti e trucchi” per usare la documentazione e trovare ciò di cui hai bisogno, fornendo anche dettagli aggiuntivi sui numerosi e diversi aspetti della documentazione di cui potresti non aver conosciuto l’esistenza.

Accesso alla documentazione tecnica

Il punto di accesso principale alla documentazione tecnica – la “porta d’ingresso”, per così dire – è: https://www.altium.com/documentation/. 

Al centro della pagina si trovano i due seguenti insiemi di documentazione:

• Altium Designer – il software desktop di progettazione, identificato come segue:

  • Altium Designer Develop – quando fa parte della soluzione Altium Develop.

  • Altium Designer Agile – quando fa parte delle soluzioni Altium Agile Teams o Altium Agile Enterprise.

  • Altium Designer – quando è ancora in uso (con abbonamento attivo) e non fa parte di una soluzione di piattaforma.

• Altium 365 – la piattaforma cloud, il cui Workspace principale è identificato come segue:

  • Altium Develop Workspace - quando viene creato come parte della soluzione Altium Develop.

  • Altium Agile Teams Workspace - quando viene creato come parte della soluzione Altium Agile Teams.

  • Altium Agile Enterprise Workspace - quando viene creato come parte della soluzione Altium Agile Enterprise.

  • Altium 365 Workspace – quando è ancora utilizzato con Altium Designer (con abbonamento attivo) e non fa parte di una soluzione di piattaforma.

Si noti che in entrambi i casi viene utilizzato un unico insieme di documentazione a supporto di tutte le soluzioni. Nella documentazione di Altium Designer, la forma abbreviata “Altium Designer” viene generalmente utilizzata quando ci si riferisce al software. Nella documentazione di Altium 365, “Altium Platform” (o “Altium 365”) viene utilizzato quando ci si riferisce alla piattaforma e “Altium Workspace” (o “Altium 365 Workspace” o semplicemente “Workspace”) quando ci si riferisce a un Workspace ospitato sulla piattaforma.

Lavorare con la pagina:

• Fai clic sull’intestazione principale di un riquadro per accedere alla home page della documentazione di quella specifica soluzione di progettazione.

• Fai clic su un collegamento all’interno dei riquadri Altium Designer o Altium 365 per accedere alle informazioni relative a quell’area specifica.

• Usa i menu QuickLinks disponibili per accedere ad altre pagine chiave, come mostrato di seguito per i riquadri della documentazione di Altium Designer e Altium 365.

• Usa il campo Search nella parte superiore della pagina per eseguire rapidamente una ricerca in tutta la documentazione di tutte le soluzioni di progettazione (e delle relative versioni, ove applicabile), nonché nella Knowledge Base. Per maggiori dettagli sulla funzione di ricerca, vedi Funzione di ricerca della documentazione.

• Fai clic sulla voce Other Products per espandere la pagina e accedere alla documentazione di altre soluzioni/aree: Renesas 365, Altium Developer Center, Altium On-Prem Enterprise Server, Company Dashboard, Altium CircuitMaker, Altium CircuitStudio, e Altium Infrastructure Server.

  

• Fai clic sulla voce See Also per espandere la pagina e accedere ad altre risorse utili offerte da Altium, come la Knowledge Base, il Learning Hub (ricco di articoli interessanti e mirati, molti dei quali scritti da esperti del settore), Altium Professional Training e gli Altium Forums (una preziosa risorsa di apprendimento con informazioni direttamente dai tuoi colleghi).

  

Accesso diretto con “F1”

Per il software di progettazione, incluso Altium Designer, vale decisamente la pena familiarizzare con la scorciatoia da tastiera F1 . Passa il mouse sopra molte delle risorse presenti nell’ambiente del software - un comando di menu, una finestra di dialogo, un pannello, un oggetto di progettazione o una parola chiave del linguaggio di query - quindi premi F1 per accedere alla relativa documentazione. A rendere possibile questa connessione tra la risorsa del software e la documentazione tecnica è un file di mappatura (*.HelpID), che si trova nella cartella \Program Files\Altium\AD<Solution>\Help dell’installazione principale.

L’immagine seguente illustra la funzione in azione. Qui, la scorciatoia da tastiera F1 viene utilizzata per accedere alla documentazione del comando Material Library, disponibile durante la modifica dello stack dei layer di un PCB tramite il Layer Stack Manager.

Aggiornamenti F1

Per il software di progettazione supportato, il file di mappatura HelpID nella cartella principale \Help dell’installazione viene aggiornato a ogni nuova release del software. Tuttavia, a volte il team della documentazione tecnica apporta aggiornamenti al file di mappatura tra una release e l’altra. Per fornire agli utenti le modifiche più recenti a F1 senza dover attendere la successiva release del software, utilizziamo un approccio di aggiornamento dinamico che sfrutta l’impostazione Check frequency, nella pagina System - Installation della finestra di dialogo Preferences.

A condizione che sia trascorso l’intervallo di controllo, la volta successiva che viene utilizzata la funzione F1, una versione più recente del file di mappatura viene scaricata nella cartella \ProgramData\Altium\Altium Designer <Solution> <GUID>\Help. Questa versione più recente del file HelpID ha la precedenza sul file predefinito presente nella cartella \Help dell’installazione principale.

Metodi di accesso alternativi

Alla documentazione tecnica è possibile accedere anche in vari modi aggiuntivi, tra cui:

• Tramite una ricerca esterna usando il motore di ricerca del tuo browser Web, ad esempio Google. Per limitare tale ricerca alla documentazione Altium, inserisci il sito come prefisso, nel formato site:altium.com/documentation <Search String> (ad esempio, site:altium.com/documentation PCB Layout Replication).

• Seguendo un collegamento fornito in un post ufficiale del forum di Altium.

• Seguendo collegamenti disponibili in altre aree del sito web principale altium.com (ad esempio, dall’area Learning Hub o da pagine dedicate “What’s New” e pagine a livello di funzionalità).

• Seguendo collegamenti dedicati nel software. Ad esempio da un menu Help , oppure utilizzando collegamenti “Learn More” (o diciture simili).

L’interfaccia della documentazione

L’interfaccia della documentazione comprende in genere fino a 14 aree distinte, mostrate nell’immagine seguente e descritte in dettaglio successivamente.

1. Product Documentation Selector – usa questo controllo per passare tra i diversi insiemi dedicati di documentazione disponibili.

2. Theme Selector – usa questo controllo per passare tra la modalità di visualizzazione chiara () e scura (), come illustrato dall’esempio seguente.

   

    

   

    

    

3. Search – usa questo campo per inserire una stringa di ricerca e trovare informazioni all’interno della documentazione del prodotto attualmente visualizzata. I filtri di ricerca correlati ti consentono poi di regolare l’ambito della ricerca. Per maggiori dettagli, vedi Funzione di ricerca della documentazione.

4. Nav Tree Pane – presenta tutte le pagine che compongono la documentazione del prodotto visualizzato. Organizzate in modo logico, fai clic su una voce per visualizzare quella pagina. I controlli in alto a destra nel riquadro consentono di ridimensionarlo e/o gestirne la visibilità.

5. QuickLinks – un componente dedicato e statico del riquadro Nav Tree, sempre presente indipendentemente dalla documentazione del prodotto visualizzata. Fornisce accesso immediato a questa pagina, alle informazioni sul copyright e al gateway principale della documentazione, oltre a un accesso rapido alla Knowledge Base.

6. Breadcrumbs – fornisce un mezzo secondario di navigazione, basato sulla pagina attiva in lettura, verso le pagine padre superiori nella gerarchia. Quando il percorso breadcrumb coinvolge molte pagine, viene utilizzato un controllo con ellissi per mantenere gestibile la visualizzazione. Fai clic su di esso per accedere a un popup contenente tutte le ulteriori pagine intermedie del percorso, ciascuna con un link attivo alla pagina corrispondente.

   

7. Main Page Content – questa è l'area principale dell'interfaccia, che mostra la pagina selezionata nel Nav Tree riquadro. Per maggiori dettagli sui vari aspetti del contenuto di una pagina, insieme a suggerimenti sulle relative caratteristiche e funzionalità, vedere Visualizzazione di un documento tecnico.

8. Feature Availability Note – viene visualizzato in tutte le pagine all'interno di determinati insiemi della documentazione. La documentazione tecnica copre tutte le caratteristiche e le funzionalità di un prodotto o di un elemento di una soluzione complessiva. Nel caso di Altium Designer e Altium 365, la disponibilità di una funzione presentata in una pagina dipende dalla soluzione Altium in uso – Altium Develop, Altium Agile Teams, Altium Agile Enterprise oppure Altium Designer (con termine attivo). Se non vedi una funzionalità documentata nel tuo software effettivo, contatta il reparto vendite di Altium per saperne di più.

9. Legacy Documentation Note – viene visualizzato in tutte le pagine della documentazione di Altium Designer. Fornisce accesso rapido alla sezione Documentazione legacy della pagina Altri installer, relativa alla documentazione delle versioni precedenti del software.

10. Table of Contents – la Content regione del riquadro di destra presenta, ove applicabile, la struttura della pagina attiva in termini di intestazioni (livelli 2-4, poiché il livello 1 è il titolo della pagina). Fai clic su una voce per passare a quella posizione nella pagina. Viceversa, durante lo scorrimento della pagina, la Content regione si aggiorna per indicare la posizione corrente nel documento.

11. Like/Dislike – la diffusa funzionalità "pollice in su/giù", che consente di valutare rapidamente se una pagina è stata utile o meno e, in caso negativo, di comunicarci il motivo (disponibile quando si è connessi al proprio account Altium). Per maggiori dettagli, vedere Funzionalità Mi piace/Non mi piace.

12. Language Selector – fornisce un modo rapido per passare alla visualizzazione della documentazione in una delle varie lingue ufficialmente supportate.

13. Documentation Feedback (visualizzato quando si è connessi al proprio account Altium) – questa funzione offre un modo rapido per inviare al team della documentazione tecnica il proprio feedback su una pagina, soprattutto per segnalare refusi, informazioni errate/obsolete o informazioni mancanti. È sufficiente selezionare testo e/o un'immagine nella pagina e usare la scorciatoia da tastiera Ctrl+Enter per accedere alla funzione. Per maggiori dettagli, vedere Meccanismo di feedback sulla documentazione.

14. Printer-friendly version – fornisce i mezzi per generare, al volo, una versione della pagina il cui contenuto è preparato appositamente per facilitarne la stampa (ad esempio, per il salvataggio come PDF).

Paginazione della struttura

All'interno del Nav Tree riquadro dell'interfaccia, a volte si incontrano voci che, se selezionate, non mostrano una pagina di documentazione. Ciò è intenzionale e serve a fornire una struttura aggiuntiva all'albero, quando è necessario raggruppare più pagine sotto un "genitore" ombrello, ma non sono necessarie informazioni nella pagina genitore stessa. Questo tipo di pagina - una pagina Structure - svolge semplicemente proprio questo compito. Spostando il cursore su una di queste voci, essa non viene sottolineata (come invece accade per la voce di una "vera" pagina di documentazione). Facendo clic su una di queste voci, si espande semplicemente quella sezione dell'albero. Fai di nuovo clic per comprimerla.

Visualizzazione di un documento tecnico

Le sezioni seguenti forniscono informazioni su vari aspetti del contenuto della pagina stessa.

Convenzioni del documento

Bold	Usato per evidenziare un comando di menu, un controllo di finestra di dialogo, un pulsante o una barra degli strumenti citati nel testo. Esempi:   Usa il comando Annotate Schematics Quietly. Se l'opzione Copy routed nets è abilitata nella finestra di dialogo, verrà posizionato il routing dal blocco sorgente. Fai clic sul pulsante Refresh nella parte superiore di Constraint Manager. Individuazione e utilizzo del comando Place Pad () sulla barra degli strumenti Active Bar o Wiring .
Italic	Usato per evidenziare un pannello o una finestra di dialogo citati nel testo. Esempi:   Le funzionalità PCB CoDesign sono accessibili e utilizzate tramite il pannello PCB CoDesign. L'annotazione dello schema viene configurata usando la finestra di dialogo Annotate. Il corsivo viene usato anche, ove necessario, per dare enfasi a un punto importante.
Monospace	Usato per evidenziare un percorso del disco rigido, un nome file, un'estensione file, una voce di elenco opzioni (nel menu a discesa di un campo), un'espressione del linguaggio di query o una parola chiave del linguaggio citati nel testo. Esempi:   Una selezione di progetti di esempio viene installata come parte dell'installazione iniziale. In un'installazione predefinita standard del software, questi si trovano nella cartella \Users\Public\Documents\Altium\AD<Solution>\Examples . A questo installer basato su procedura guidata si accede eseguendo un piccolo file eseguibile – AltiumDesignerDevelopSetup.exe (oppure AltiumDesignerAgileSetup.exe). Un documento di disegno di produzione basato su Draftsman può essere aggiunto a un progetto di progettazione PCB (*.PCBDwf), a un progetto di progettazione Harness (*.HarDwf) o a un progetto di progettazione multi-board (*.MbDwf). TouchesRoom('Monitor','Auxilary','Effects')
Bold + Monospace	Usato per evidenziare una scorciatoia da tastiera citata nel testo. Esempi:   Fai clic con il pulsante destro oppure premi Esc per uscire dalla modalità di posizionamento. Premi Spacebar per ruotare l'oggetto di testo in senso antiorario oppure Shift+Spacebar per la rotazione in senso orario.
Menu » Menu Item	I riferimenti al menu principale nella documentazione di Altium Designer usano il carattere » come separatore. La prima voce fa riferimento al menu stesso, seguita dal comando contenuto in quel menu. Se si accede a un comando da un sottomenu, viene usato un ulteriore carattere » per indicarlo. Esempi:   La configurazione per il controllo delle regole di progettazione viene eseguita nella finestra di dialogo Design Rule Checker, accessibile tramite il comando Tools » Design Rule Check da un documento PCB. Le voci Harness sono disponibili per il posizionamento nell'editor Schematic. Scegli Place » Harness » Harness Entry dai menu principali.
Tab | Group | Button	I riferimenti al menu principale nella documentazione di Altium CircuitStudio e Altium CircuitMaker usano il carattere | come separatore. La prima voce fa riferimento alla scheda specifica del menu ribbon, seguita dal gruppo (o regione) della scheda e infine dal pulsante all'interno di quel gruppo. Se si accede a un comando da un menu associato a un pulsante, viene usato il carattere » per indicarlo. Esempi:   Il pannello View Configuration, usato per configurare ciò che è attualmente visualizzato nello spazio di progettazione e il modo in cui viene visualizzato, è accessibile dall'editor PCB scegliendo View | PCB | View Configuration. Per spostare gli oggetti attualmente selezionati, usa il comando Tools | Arrange | Move » Move Selection.
Key1+Key2	Quando si fa riferimento alle scorciatoie, l'uso del simbolo più (+) indica che più tasti devono essere tenuti premuti sulla tastiera nella sequenza indicata. Esempi:   Shift+H (per attivare o disattivare l'Heads Up Display nell'editor PCB). Shift+Ctrl+X (per attivare o disattivare la modalità Cross Select negli editor Schematic/PCB).
Key1, Key2	Quando si fa riferimento alle sequenze di tasti di scelta rapida, l'uso del simbolo virgola (,) indica la pressione di ciascun tasto della sequenza in successione. Esempi:   X, A (nell'editor Schematic, per deselezionare tutti gli oggetti sul foglio corrente). P, V, K (nell'editor Schematic, per posizionare una direttiva di compile mask). T, D, R (nell'editor PCB, per eseguire un Design Rule Check in batch).
Collegamento	Un normale collegamento ipertestuale verso una destinazione che può essere:   Verso un'altra area della stessa pagina. Verso una pagina diversa all'interno dello stesso set di documentazione del prodotto. Verso una pagina diversa all'interno di un diverso set di documentazione del prodotto. Verso una pagina esterna alla documentazione tecnica.
Riquadro informativo	Usato per evidenziare alcune informazioni aggiuntive fondamentali relative a un particolare argomento trattato nella pagina. Esempio:   La sorgente dei dati BOM di un progetto di progettazione harness è il disegno di layout del progetto. Quindi, se il diagramma di cablaggio del tuo progetto harness è stato modificato e questa modifica deve essere riportata nella BOM, il disegno di layout deve essere aggiornato per primo.
Riquadro funzionalità/suggerimento	Usato per evidenziare una particolare caratteristica o funzionalità di cui tenere conto, oppure un suggerimento per il suo utilizzo. Esempio:   L'insieme dei progetti di esempio di Altium Designer include un progetto di esempio di progettazione harness –Harness_Demo_Prj.PrjHar – nella cartella \Users\Public\Documents\Altium\AD<Solution>\Examples\Harness Demo MB\Harness_Demo_Prj per impostazione predefinita, che è associato a un progetto dimostrativo multi-board (\Examples\Harness Demo MB\Harness_Demo_MB\Harness_Demo_MB.PrjMbd), così puoi provare gli harness fin da subito.
Riquadro di avviso	Usato per evidenziare qualcosa di importante di cui essere consapevoli o che dovrebbe essere eseguito. Esempio:   Si raccomanda in particolare di eseguire sempre un controllo delle regole di progettazione in modalità batch prima di generare gli artwork finali. L'Online DRC rileva solo le nuove violazioni, ossia quelle create dopo l'attivazione della funzione, mentre il Batch DRC consente di eseguire manualmente un controllo in qualsiasi momento del processo di progettazione della scheda. Perciò, se i bravi progettisti conoscono il valore dell'Online DRC, sanno anche che la progettazione della scheda dovrebbe iniziare e concludersi con un Batch DRC.

Elementi visivi coinvolgenti

In tutta la documentazione troverai vari elementi visivi utilizzati per trasmettere le informazioni in modo più coinvolgente. Le sezioni seguenti illustrano come questi elementi appaiono in una pagina e come vengono usati.

Immagine statica

La semplice immagine statica è una pietra miliare della documentazione, usata insieme al testo circostante per fornire in modo fedele dettagli su un aspetto chiave del software.

Per mantenere gestibile la presentazione (e la leggibilità) di un documento, la pagina ha una larghezza fissa. Di conseguenza, in genere le immagini non possono essere visualizzate, per impostazione predefinita, a dimensione intera. Quando passi il cursore su un'immagine, questo cambia da un'icona a puntatore () a un'icona a forma di lente di ingrandimento (). Questo indica che facendo clic sull'immagine verrà presentata la sua versione a dimensione intera in una finestra mobile (ove applicabile e in base alle dimensioni correnti della finestra del browser). L'immagine seguente illustra questo comportamento per un'immagine statica nella documentazione (ironicamente, dovrai fare clic sull'immagine per vederla a dimensione intera).

Presentazione

Un elemento presentazione può comprendere diverse immagini (e video) per mostrare in modo ordinato più informazioni visive, insieme alle didascalie. Questo elemento è particolarmente utile per illustrare una progressione o una sequenza di passaggi da seguire quando si utilizza una specifica funzione del software.

L'immagine seguente illustra un esempio di presentazione nella documentazione e mette in evidenza alcune aree chiave, descritte di seguito.

1. Usa questi controlli per scorrere rispettivamente avanti e indietro nella presentazione. Quando passi sopra un'area, questa diventa più scura. Puoi fare clic in qualsiasi punto della "cornice della freccia", non solo sull'icona della freccia stessa.

2. Queste "bolle" indicano quante diapositive sono presenti nella presentazione e in quale posizione ti trovi nel set (bolla più scura). Puoi fare clic su una bolla per passare rapidamente a quella diapositiva.

3. Una presentazione può includere didascalie: una didascalia per diapositiva. Queste si aggiornano man mano che fai clic sulle diverse diapositive.

Gif animata

Una Gif animata viene usata quando è necessario catturare un processo o un aspetto del software in modo simile a un video, ma quando l'illustrazione visiva è di breve durata e usare un video sarebbe eccessivo. Una gif animata nella documentazione si distingue per la presenza di un evidente pulsante "play" al centro, come illustrato nell'immagine seguente. Dopo aver fatto clic sul pulsante, la gif verrà riprodotta fino alla fine e si fermerà, mostrando nuovamente il pulsante play.

Video (MP4)

Un video, come una gif, viene usato quando è necessario acquisire visivamente un processo o un aspetto del software mentre viene "eseguito", e quando tale contenuto visivo è più lungo di quanto sia adatto a una gif. Un video nella documentazione si distingue per un pannello di controllo nella parte inferiore, come illustrato nell'immagine seguente. Fai clic in qualsiasi punto del video per avviarne la riproduzione (non è necessario fare clic sulla freccia di riproduzione in basso a sinistra). Fai di nuovo clic (in qualsiasi punto del video) per metterlo in pausa. Usa i controlli video disponibili per, ad esempio, passare alla visualizzazione a dimensione intera e tornare indietro, avanzare o tornare indietro lungo la timeline e modificare la velocità di riproduzione.

Immagine al passaggio del mouse

Un'immagine al passaggio del mouse viene usata per presentare uno scenario "prima e dopo" o un qualche tipo di confronto rispetto a una funzione del software. È composta soltanto da due immagini. Appare sulla pagina proprio come una normale immagine statica, con la prima immagine mostrata per impostazione predefinita. Quando il cursore vi passa sopra, compare la seconda immagine.

Quello che segue è un esempio reale di elemento visivo con immagine al passaggio del mouse usato nella documentazione. In questo caso, viene usato per illustrare gli shielding vias (immagine predefinita/prima immagine) e gli stitching vias (seconda immagine, accessibile al passaggio del mouse).

Immagine pop-up

Un'immagine pop-up viene usata per mostrare qualcosa nel contesto del testo circostante, senza aggiungere specificamente quell'immagine al flusso del contenuto. In questo senso, può essere considerata più come un'"nota a margine" o un esempio, che rafforza un commento o un'affermazione fatta nel testo. Un elemento di questo tipo appare con una di due icone:  (un'immagine pop-up) oppure  (una Gif animata o un video pop-up). L'immagine seguente mostra un elemento pop-up dopo il clic, in questo caso un pop-up di tipo "immagine", che restituisce l'immagine a dimensione intera.

Testo al passaggio del mouse (tool tip)

Il testo al passaggio del mouse (o tool tip) viene usato per fornire ulteriore assistenza utile nel contesto di una specifica voce in una pagina. Può trattarsi, per esempio, di una nota esplicativa per una voce oppure di una spiegazione in stile glossario della terminologia utilizzata. Un tool tip può apparire in uno di due modi:

• L'icona . Passa sopra l'icona per accedere al suggerimento.

  

• Testo con sottolineatura puntinata. Passa sopra il testo per accedere al suggerimento.

  

Sezioni comprimibili

Per mantenere ordinato il contenuto della pagina ed evitare che risulti opprimente, vengono usate sezioni comprimibili. Tendono a essere usate per informazioni più approfondite, ma non necessariamente indispensabili per comprendere il normale flusso della pagina (e quindi non da presentare apertamente). Tali contenuti potrebbero essere, ad esempio, opzioni disponibili in una finestra di dialogo o in un pannello, oppure considerazioni specifiche relative a un particolare aspetto di una funzione trattata nel contenuto principale. Espandi/comprimi una sezione di questo tipo facendo clic in qualsiasi punto dell'intestazione della sezione.

Ottenere un link alla pagina o a una sezione specifica

Quando vuoi condividere una pagina con altri, devi poter ottenere rapidamente il relativo URL. Questo può essere ottenuto (copiato negli Appunti di Windows) in un paio di modi:

1. Dalla barra degli indirizzi del browser quando accedi per la prima volta alla pagina.

2. Facendo clic con il pulsante destro del mouse sulla voce della pagina nel Nav Tree a sinistra, quindi usando il comando Copy link address nel menu contestuale.

Andando oltre, puoi anche ottenere un URL a una specifica sezione della pagina che stai leggendo, come segue:

1. Usa il riquadro destro per accedere alla sezione desiderata all'interno della struttura dei contenuti della pagina, quindi copia l'URL dalla barra degli indirizzi del browser.

2. Scorri la pagina fino alla sezione desiderata. Man mano che scorri, la barra degli indirizzi del browser si aggiorna per riflettere la sezione corrente che hai raggiunto.

3. Fai clic con il pulsante destro del mouse sulla voce della sezione desiderata all'interno della struttura dei contenuti della pagina (nel riquadro destro), quindi usa il comando Copy link address dal menu contestuale.

Puoi anche "afferrare rapidamente un link" dai seguenti punti:

• Main Section Header - fai clic sul controllo "Copy Link" a sinistra dell'intestazione di una sezione principale.

  

• Collapsible Section - fai clic sul controllo "Copy Link" a destra del titolo di una sezione comprimibile.

  

Documentazione con controllo delle versioni

Per Altium On-Prem Enterprise Server, la documentazione associata è soggetta a controllo delle versioni. Questo ti consente di selezionare la versione corretta della documentazione per la versione del software che stai usando. La versione può essere selezionata sia dal gateway principale della documentazione (dal menu QuickLinks del riquadro del prodotto) sia in qualsiasi momento all'interno della documentazione, usando il selettore di versione disponibile nell'area del banner superiore, come mostrato di seguito.

Il sistema di controllo delle versioni ti avvisa se stai leggendo una pagina che non è la versione più recente di quella pagina. Lo fa in due modi:

• Il numero di versione nel selettore a discesa delle versioni viene visualizzato con un colore diverso ed è contrassegnato da un simbolo di avviso.
• Viene mostrato un avviso nella parte superiore della pagina, con un link alla versione più recente. Seguendo il link, la voce nel selettore delle versioni passerà automaticamente all’ultima versione disponibile.

Versioni applicabili

Sebbene il software evolva da una versione all’altra, aggiungendo nuove funzionalità e miglioramenti alle sue caratteristiche, la documentazione versionata associata per Altium On-Prem Enterprise Server può essere interessata solo in determinate aree. Molte pagine non saranno influenzate dalla versione successiva del software, quindi lo stesso contenuto che era applicabile in precedenza continuerà a essere valido anche per quella versione successiva. Per questo motivo, su ogni pagina viene fornita un’indicazione che mostra per quali versioni del software il contenuto di quella pagina può essere utilizzato.

L’immagine seguente illustra tale indicazione. Qui è aperta la versione 8.0 della pagina che descrive la funzionalità Cronologia progetto. Questo contenuto si applica allo stesso modo anche alle versioni 7.0, 7.1 e 7.2 del software. In altre parole, non vi è alcuna differenza nel contenuto della pagina se imposti il selettore di versione della documentazione su 7.0, 7.1, 7.2 o 8.0.

Funzionalità di ricerca della documentazione

Per aiutarti a trovare informazioni nella documentazione tecnica delle soluzioni di progettazione Altium, è disponibile una potente Search . Basata su Google, esiste in effetti un’unica funzione di ricerca per l’intero sito altium.com. Il modo e il punto da cui accedi alla ricerca determinano quanto saranno inizialmente “filtrati” i risultati:

• Dalla barra superiore del sito - accessibile e utilizzabile come illustrato nella presentazione seguente. La ricerca viene eseguita sull’intero sito, con i risultati mostrati in una scheda separata del browser.

• Dalla “porta d’ingresso” della documentazione tecnica (altium.com/documentation) - accessibile e utilizzabile come illustrato nella presentazione seguente. La ricerca viene eseguita su tutti i set di documentazione disponibili per le varie soluzioni di progettazione Altium, oltre che nella Knowledge Base. I risultati vengono mostrati nella stessa scheda del browser.

• Da una pagina della documentazione tecnica - accessibile e utilizzabile come illustrato nella presentazione seguente. La ricerca viene eseguita solo all’interno del set di documentazione attivo attualmente visualizzato. I risultati vengono mostrati nella stessa scheda del browser.

Pagine QuickNav (documentazione di Altium Designer)

Per quanto riguarda gli oggetti di progettazione e i pannelli in Altium Designer, le informazioni su questi elementi sono distribuite su moltissime pagine all’interno del set di documentazione di Altium Designer. Per offrire un modo semplice per raggiungere tali informazioni, è stato adottato il concetto di pagine QuickNav. Analogamente a una mappa “directory del negozio” in un centro commerciale, una pagina QuickNav fornisce informazioni di riferimento rapide sugli elementi di progettazione disponibili per una particolare area di progettazione, dandoti un mezzo per raggiungere velocemente informazioni più dettagliate su ciascuno di essi.

Nella maggior parte dei casi, una pagina QuickNav presenta le informazioni in tre sezioni distinte:

• Graphical Overview - una raccolta visiva di oggetti di uso comune, per esempio.
• Slideshow - presenta informazioni più generali su alcuni degli elementi che utilizzerai più regolarmente.
• A-Z Listing - un pratico elenco alfabetico. Senza fronzoli, senza complicazioni. Solo collegamenti diretti ai dettagli di uno specifico elemento.

Le pagine QuickNav sono disponibili per i seguenti elementi:

• Oggetti di progettazione schematica

• Oggetti di progettazione PCB

• Oggetti di progettazione Draftsman

• Oggetti di progettazione schematica multi-board

• Oggetti di progettazione harness

• Pannelli

Pagine QuickStart (documentazione di Altium Designer)

All’interno del set di documentazione di Altium Designer (che costituisce la base e supporta le soluzioni di piattaforma disponibili da Altium) esistono pagine principali di alto livello che, considerate insieme, forniscono un prezioso insieme di informazioni “QuickStart”. Questo tipo di pagine ti guida attraverso una particolare area di progettazione, offrendoti il giusto livello di dettaglio per iniziare a comprenderla e usarla rapidamente, senza entrare troppo a fondo. Queste pagine sono:

• Prendere familiarità con l’ambiente di progettazione Altium

• Trasformare la tua idea di progetto in uno schema

• Analizzare il tuo progetto usando la simulazione di circuito

• Gestione della BOM con ActiveBOM

• Gestire le modifiche di progetto tra schema & PCB

• Realizzare il layout del tuo PCB

• Semplificare la documentazione di progetto della scheda con Draftsman

• Preparare il tuo progetto per la produzione

• Progettare con più PCB

• Progettazione harness

Funzionalità Mi piace/Non mi piace

Per consentirci di ottenere analisi di massima sulle pagine della documentazione tecnica, viene utilizzata l’onnipresente funzionalità “Pollice su/giù”. Questo ci permette di vedere quanto una pagina sia utile e, se non lo è, di pianificare un intervento correttivo. Troverai i controlli della funzionalità sotto la sezione Content (ToC) della pagina, nel pannello di destra. Fai clic una volta su un’icona del pollice per registrare il tuo “voto”, fai di nuovo clic per rimuoverlo. Se fai clic sull’icona Thumbs Down AND e hai effettuato l’accesso al tuo account Altium, avrai l’opportunità di fornire un feedback sul perché la pagina non ti è stata utile. Questo invia un report direttamente al team della Documentazione Tecnica.

Meccanismo di feedback della documentazione

Di tanto in tanto potresti incontrare/scoprire un problema in un documento, come un refuso, un problema di accesso, informazioni errate/non chiare o informazioni obsolete. Errare è umano e ci rivolgiamo a voi, nostri lettori, per aiutarci a correggere questi problemi. A tal fine, la documentazione tecnica incorpora un meccanismo di feedback accessibile da qualsiasi pagina, che invia un report direttamente al team della Documentazione Tecnica.

Questo meccanismo di feedback si attiva usando la scorciatoia da tastiera Ctrl+Enter. Se c’è una particolare sezione di testo e/o immagine che vuoi citare, selezionala (massimo 200 caratteri) prima di premere Ctrl+Enter.

Dopo aver attivato la funzionalità, viene visualizzata la finestra Report Document Issue, con il testo/le immagini di riferimento aggiunti (se applicabile). Usa il campo Issue (max 500 caratteri) per fornire quanti più dettagli possibile: ci aiuta davvero a indagare e risolvere un problema valido più rapidamente. Quando sei pronto, fai clic sul pulsante Send Feedback per inviare. Un messaggio di conferma e ringraziamento confermerà l’avvenuto invio e la ricezione del tuo report. Non si sottolineerà mai abbastanza quanto il tuo feedback sia importante per noi e quanto lo apprezziamo sinceramente!

Supporto per la visualizzazione su qualsiasi dispositivo

Sono finiti i tempi in cui ogni progettista sedeva davanti a un computer desktop con un singolo monitor 1280x1024. Oggi i nostri PC desktop hanno più monitor di varie dimensioni e risoluzioni. Dobbiamo anche essere in grado di lavorare da un laptop quando siamo sul campo o presso l’ufficio del cliente. Inoltre, dato che siamo appassionati di conoscenza, ci piace anche poter usare tablet o telefono per assorbire altre informazioni mentre aspettiamo quel volo o prendiamo l’autobus per andare in ufficio.

Per presentare i contenuti in modo che funzionino su tutti questi diversi dispositivi, la documentazione tecnica (come parte del sito principale altium.com) utilizza responsive web design. Un sito web responsive comunica con il dispositivo di destinazione e adatta il layout e le dimensioni dei contenuti in base a quel dispositivo, alla risoluzione dello schermo e alle dimensioni del browser. Puoi fartene un'idea ridimensionando il browser; man mano che riduci la larghezza, gli elementi della pagina si riorganizzano e i caratteri e le immagini diventano più piccoli. Anche su uno schermo da 5 pollici il sito rimane funzionale, con, ad esempio, l'albero di navigazione ancora disponibile sul tablet o sul telefono come menu a discesa.

Documentazione ottimizzata per la stampa

Vuoi stampare parte della documentazione tecnica? Poiché puntiamo molto sulle funzionalità 'online' e utilizziamo anche numerosi effetti visivi accattivanti per trasmettere le informazioni, dovrai prima assicurarti che una pagina sia preparata per l'invio al tuo fedele dispositivo di stampa (o per il salvataggio come PDF). Sul lato destro dell'area del banner inferiore troverai un controllo che consente proprio di farlo, permettendoti di ottenere una versione della pagina adatta alla stampa.

Documentazione localizzata

Alcuni dei nostri contenuti sono disponibili in lingue diverse dall'inglese. Utilizza il selettore della lingua, situato sul lato sinistro dell'area del banner inferiore, per selezionare la lingua desiderata tra quelle attualmente supportate.

Il contenuto nella lingua alternativa per una particolare versione di una pagina verrà presentato automaticamente, se disponibile; in caso contrario verrà visualizzato il contenuto in inglese. La seguente presentazione mostra la localizzazione in azione per una pagina, visualizzando il contenuto originale in inglese insieme ad alcune delle altre lingue disponibili (giapponese, cinese, coreano e polacco).

Traduzione del browser (non ufficiale)

A seconda del browser Web che preferisci, potresti avere accesso alla traduzione temporanea e al volo della pagina attiva che stai leggendo. La seguente presentazione illustra l'uso della funzione Traduci di Google Chrome per visualizzare rapidamente la pagina in una delle tante lingue supportate, in questo caso il tedesco. Tieni presente che la traduzione è temporanea: facendo clic su un'altra pagina e poi tornando indietro, oppure aggiornando la pagina, verrà ripristinata la lingua originale visualizzata.

La Knowledge Base

Le persone spesso arrivano alla Knowledge Base di Altium e presumono che rappresenti l'intera nostra documentazione tecnica. In realtà, si tratta di una risorsa separata a pieno titolo. In effetti, le due instaurano una relazione simbiotica in cui Knowledge Base e documentazione tecnica si interconnettono e si completano a vicenda, per fornirti le informazioni che stai cercando.

La Knowledge Base è un punto di riferimento self-service, i cui contenuti sono curati dai membri dell'organizzazione di Supporto di Altium, persone che hanno una conoscenza esperta delle soluzioni Altium. Tali contenuti vengono creati direttamente a partire dai problemi riscontrati da altri utenti. Il risultato è un archivio organico di articoli che forniscono risposte/soluzioni mirate per argomenti e casi limite. Articoli precisi e rapidi da leggere per permetterti di tornare subito operativo.

L'interfaccia della Knowledge Base è di una semplicità disarmante. Puoi scegliere di cercare in tutti gli articoli oppure di limitare la ricerca agli articoli in una delle categorie di soluzioni di progettazione supportate. Quindi, inizia semplicemente a digitare una stringa di ricerca: il filtraggio verrà applicato man mano. Quando trovi un articolo di interesse, fai clic sulla relativa voce per aprirlo.

Copyright della documentazione

Le informazioni sul copyright relative alla documentazione tecnica sono comodamente mostrate nell'immagine seguente e sono accessibili dalla sezione QuickLinks del riquadro Nav Tree (Informazioni sul copyright della documentazione), disponibile durante la visualizzazione di qualsiasi pagina della documentazione tecnica. La pagina include un collegamento alla pagina Copyrights & Trademarks del sito principale altium.com.

Una citazione conclusiva...

È molto più di un semplice mantra: è il principio a cui il team della documentazione tecnica si attiene e che si impegna a realizzare. In futuro, la documentazione tecnica continuerà a evolversi, in particolare dal punto di vista dell'usabilità. Dopotutto, avere un'abbondanza di informazioni è utile solo se i nostri utenti riescono a trovarle. Man mano che saranno resi disponibili nuovi sviluppi, miglioramenti e funzionalità, questa pagina verrà aggiornata per riflettere ed evidenziare tali elementi aggiuntivi e il modo migliore per usarli per ottenere le informazioni di cui hai bisogno.