Korzystanie z dokumentacji Altium

Altium udostępnia obszerny zestaw dokumentacji technicznej dla całej gamy dostępnych rozwiązań projektowych. Ten dokument zawiera praktyczny zestaw „wskazówek i trików” dotyczących korzystania z dokumentacji, aby znaleźć potrzebne informacje, a także przedstawia rozszerzone szczegóły dotyczące wielu różnych aspektów dokumentacji, o których istnieniu możesz wcześniej nie wiedzieć.

Dostęp do dokumentacji technicznej

Główną bramą do dokumentacji technicznej — swoistymi „drzwiami wejściowymi” — jest: https://www.altium.com/documentation/. 

W samym centrum tej strony znajdują się następujące dwa zestawy dokumentacji:

• Altium Designer – oprogramowanie projektowe dla komputerów stacjonarnych, oznaczone następująco:

  • Altium Designer Develop – gdy stanowi część rozwiązania Altium Develop.

  • Altium Designer Agile – gdy stanowi część rozwiązania Altium Agile.

  • Altium Designer – gdy jest nadal używane (w ramach aktywnego okresu) i nie stanowi części rozwiązania platformowego.

• Altium 365 – platforma chmurowa, której podstawowy Workspace jest oznaczony następująco:

  • Altium Develop Workspace - gdy został utworzony jako część rozwiązania Altium Develop.

  • Altium Agile Workspace - gdy został utworzony jako część rozwiązania Altium Agile.

  • Altium 365 Workspace – gdy jest nadal używany z Altium Designer (w ramach aktywnego okresu) i nie stanowi części rozwiązania platformowego.

Zwróć uwagę, że w obu przypadkach do obsługi wszystkich rozwiązań używany jest jeden zestaw dokumentacji. W Altium Designer documentation skrócona forma „Altium Designer” jest zwykle używana przy odnoszeniu się do oprogramowania. W Altium 365 documentation określenia „Altium Platform” (lub „Altium 365”) używa się w odniesieniu do platformy, a „Altium Workspace” (lub „Altium 365 Workspace” albo po prostu „Workspace”) w odniesieniu do Workspace hostowanego na platformie.

Praca ze stroną:

• Kliknij główny nagłówek kafelka, aby przejść do strony głównej dokumentacji dla danego rozwiązania projektowego.

• Kliknij łącze w kafelku Altium Designer lub Altium 365, aby uzyskać dostęp do informacji dotyczących tego konkretnego obszaru.

• Użyj dostępnych menu QuickLinks , aby uzyskać dostęp do dodatkowych kluczowych stron, jak pokazano poniżej dla kafelków dokumentacji Altium Designer i Altium 365.

• Użyj pola Search u góry strony, aby szybko przeszukiwać całą dokumentację wszystkich rozwiązań projektowych (oraz ich wersji, jeśli dotyczy), a także bazę wiedzy. Więcej informacji o funkcji wyszukiwania znajdziesz w sekcji Documentation Search Facility.

• Kliknij pozycję Other Products, aby rozwinąć stronę i uzyskać dostęp do dokumentacji innych rozwiązań/obszarów: Renesas 365, Altium On-Prem Enterprise Server, Company Dashboard, Altium CircuitMaker, Altium CircuitStudio oraz Altium Infrastructure Server.

  

• Kliknij pozycję See Also, aby rozwinąć stronę i uzyskać dostęp do innych przydatnych zasobów oferowanych przez Altium, takich jak Knowledge Base, Learning Hub (pełne interesujących i ukierunkowanych artykułów, z których wiele zostało napisanych przez ekspertów branżowych), Altium Professional Training oraz Altium Forums (nieocenione źródło wiedzy z informacjami bezpośrednio od innych użytkowników).

  

Bezpośredni dostęp za pomocą „F1”

W przypadku oprogramowania projektowego, w tym Altium Designer, zdecydowanie warto zapoznać się ze skrótem klawiaturowym F1. Najedź kursorem myszy na wiele zasobów w środowisku oprogramowania — polecenie menu, okno dialogowe, panel, obiekt projektu lub słowo kluczowe języka zapytań — a następnie naciśnij F1, aby uzyskać dostęp do dokumentacji dotyczącej tego elementu. Za realizację tego połączenia między zasobem oprogramowania a dokumentacją techniczną odpowiada plik mapowania (*.HelpID), który znajduje się w folderze \Program Files\Altium\AD<Solution>\Help głównej instalacji.

Poniższy obraz ilustruje działanie tej funkcji. W tym przypadku skrót klawiaturowy F1 jest używany do uzyskania dostępu do dokumentacji polecenia Material Library, dostępnego podczas edycji stosu warstw dla PCB przy użyciu Layer Stack Manager.

Aktualizacje F1

W przypadku obsługiwanego oprogramowania projektowego plik mapowania HelpID w głównym folderze \Help instalacji jest aktualizowany przy każdym nowym wydaniu tego oprogramowania. Zdarza się jednak, że zespół dokumentacji technicznej wprowadza aktualizacje do pliku mapowania pomiędzy wydaniami. Aby dostarczać użytkownikom najnowsze zmiany F1 bez konieczności czekania na kolejne wydanie oprogramowania, stosujemy podejście aktualizacji „w locie”, które wykorzystuje ustawienie Check frequency na stronie System - Installation okna dialogowego Preferences.

Jeśli upłynął interwał sprawdzania, przy następnym użyciu funkcji F1 nowsza wersja pliku mapowania zostanie pobrana do folderu \ProgramData\Altium\Altium Designer <Solution> <GUID>\Help. Ta nowsza wersja pliku HelpID ma pierwszeństwo przed domyślnym plikiem w folderze \Help głównej instalacji.

Alternatywne metody dostępu

Do dokumentacji technicznej można również uzyskać dostęp na różne dodatkowe sposoby, w tym:

• Za pośrednictwem wyszukiwania zewnętrznego przy użyciu wyszukiwarki w przeglądarce internetowej, na przykład Google. Aby zawęzić takie wyszukiwanie do dokumentacji Altium, wpisz witrynę jako prefiks, używając formatu site:altium.com/documentation <Search String> (np. site:altium.com/documentation PCB Layout Replication).

• Przechodząc przez łącze podane w oficjalnym poście na forum Altium.

• Przechodząc przez łącza dostępne w innych obszarach głównej witryny altium.com (np. z obszaru Learning Hub lub z dedykowanych stron „What’s New” i stron poświęconych poszczególnym funkcjom).

• Przechodząc przez dedykowane łącza w oprogramowaniu. Na przykład z menu Help lub używając łączy „Learn More” (lub podobnie sformułowanych).

Interfejs dokumentacji

Interfejs dokumentacji zwykle składa się maksymalnie z 14 odrębnych obszarów, pokazanych na poniższym obrazie i opisanych dalej.

1. Product Documentation Selector – użyj tego elementu sterującego, aby przełączać się między dostępnymi dedykowanymi zestawami dokumentacji.

2. Theme Selector – użyj tego elementu sterującego, aby przełączać się między jasnym () i ciemnym () trybem prezentacji, jak pokazano w poniższym przykładzie.

   

    

   

    

    

3. Search – użyj tego pola, aby wprowadzić ciąg wyszukiwania i znaleźć informacje w aktualnie przeglądanej dokumentacji produktu. Powiązane filtry wyszukiwania umożliwiają następnie dostosowanie zakresu wyszukiwania. Więcej informacji znajdziesz w sekcji Documentation Search Facility.

4. Nav Tree Pane – przedstawia wszystkie strony składowe dokumentacji aktualnie przeglądanego produktu. Są one logicznie pogrupowane; kliknij wpis, aby wyświetlić daną stronę. Elementy sterujące w prawym górnym rogu panelu umożliwiają zmianę jego rozmiaru i/lub sterowanie jego widocznością.

5. QuickLinks – dedykowany i statyczny składnik panelu Nav Tree, który jest zawsze wyświetlany niezależnie od aktualnie przeglądanej dokumentacji produktu. Zapewnia szybki dostęp do tej strony, informacji o prawach autorskich i głównej bramy dokumentacji, a także szybki dostęp do Knowledge Base.

6. Breadcrumbs – zapewnia dodatkowy sposób nawigacji, oparty na aktualnie czytanej stronie, do stron nadrzędnych wyżej w hierarchii. Gdy ścieżka okruszków nawigacyjnych obejmuje wiele stron, używany jest element wielokropka, aby zachować czytelność widoku. Kliknij go, aby otworzyć wyskakujące okno zawierające wszystkie dodatkowe strony pośrednie na ścieżce, z których każda jest aktywnym łączem do odpowiedniej strony.

   

7. Main Page Content – jest to główny obszar interfejsu, prezentujący stronę wybraną w panelu Nav Tree . Więcej informacji o różnych aspektach zawartości strony, wraz ze wskazówkami dotyczącymi jej funkcji i możliwości, znajdziesz w sekcji Viewing a Technical Document.

8. Feature Availability Note – jest to prezentowane na każdej stronie w określonych zestawach dokumentacji. Dokumentacja techniczna obejmuje wszystkie cechy i funkcjonalności produktu lub elementu kompletnego rozwiązania. W przypadku Altium Designer i Altium 365 dostęp do funkcji przedstawionej na stronie zależy od tego, z którego rozwiązania Altium korzystasz – Altium Develop, edycji Altium Agile (Agile Teams lub Agile Enterprise), albo Altium Designer (z aktywną subskrypcją terminową). Jeśli nie widzisz omawianej funkcji w swoim oprogramowaniu, skontaktuj się z działem sprzedaży Altium, aby dowiedzieć się więcej.

9. Legacy Documentation Note – jest to prezentowane na każdej stronie w dokumentacji Altium Designer. Zapewnia szybki dostęp do sekcji Legacy Documentation na stronie Other Installers, zawierającej dokumentację dotyczącą starszych wersji oprogramowania.

10. Table of Contents – obszar Content  w prawym panelu przedstawia, tam gdzie ma to zastosowanie, strukturę aktywnej strony w postaci jej nagłówków (poziomy 2–4, ponieważ poziom 1 to tytuł strony). Kliknij wpis, aby przejść do tego miejsca na stronie. Analogicznie, podczas przewijania strony obszar Content będzie się aktualizował, śledząc Twoje położenie w dokumencie.

11. Like/Dislike – wszechobecna funkcja „kciuk w górę/w dół”, umożliwiająca szybkie ocenienie, czy strona była pomocna, czy nie, a jeśli nie – pozwalająca poinformować nas dlaczego (dostępne po zalogowaniu się na konto Altium). Więcej informacji znajdziesz w Like/Dislike Functionality.

12. Language Selector – zapewnia szybki sposób przełączenia widoku dokumentacji na jeden z różnych oficjalnie obsługiwanych języków.

13. Documentation Feedback (wyświetlane po zalogowaniu się na konto Altium) – ta funkcja zapewnia szybki sposób przesłania zespołowi Dokumentacji Technicznej opinii o stronie, ukierunkowanej bardziej na wskazywanie literówek, nieprawidłowych/nieaktualnych informacji lub brakujących informacji. Wystarczy zaznaczyć tekst i/lub obraz na stronie i użyć skrótu klawiaturowego Ctrl+Enter, aby uzyskać dostęp do tej funkcji. Więcej informacji znajdziesz w Documentation Feedback Mechanism.

14. Printer-friendly version – zapewnia możliwość dynamicznego wygenerowania wersji strony, której zawartość została przygotowana specjalnie z myślą o łatwym drukowaniu (np. do zapisania jako PDF).

Stronicowanie struktury

W panelu Nav Tree interfejsu czasami napotkasz wpisy, które po kliknięciu nie wyświetlają strony dokumentacji. Jest to zamierzone i służy jako sposób zapewnienia dodatkowej struktury drzewa, gdy strony trzeba pogrupować pod nadrzędnym „rodzicem”, ale informacje nie są potrzebne na samej stronie nadrzędnej. Taki typ strony – strona Structure – właśnie temu służy. Gdy przesuwasz kursor nad takim wpisem, nie zostaje on podkreślony (jak ma to miejsce w przypadku wpisu dla „prawdziwej” strony dokumentacji). Po kliknięciu takiego wpisu rozwijana jest tylko ta sekcja drzewa. Kliknij ponownie, aby ją zwinąć.

Wyświetlanie dokumentu technicznego

Poniższe sekcje zawierają informacje o różnych aspektach samej zawartości strony.

Konwencje dokumentu

Bold	Używane do wyróżnienia polecenia menu, kontrolki okna dialogowego, przycisku lub paska narzędzi, do których odnosi się tekst. Przykłady:   Użyj polecenia Annotate Schematics Quietly. Jeśli opcja Copy routed nets jest włączona w oknie dialogowym, zostanie umieszczone trasowanie od bloku źródłowego. Kliknij przycisk Refresh u góry Constraint Manager. Odszukiwanie i używanie polecenia Place Pad () na pasku narzędzi Active Bar lub Wiring .
Italic	Używane do wyróżnienia panelu lub okna dialogowego, do których odnosi się tekst. Przykłady:   Funkcje PCB CoDesign są dostępne i obsługiwane za pośrednictwem panelu PCB CoDesign. Adnotacja schematu jest konfigurowana przy użyciu okna dialogowego Annotate. Kursywa jest również używana, tam gdzie to potrzebne, do podkreślenia ważnej kwestii.
Monospace	Używane do wyróżnienia lokalizacji na dysku twardym, nazwy pliku, rozszerzenia pliku, wyrażenia języka zapytań lub słowa kluczowego języka, do których odnosi się tekst. Przykłady:   W ramach początkowej instalacji instalowany jest zestaw przykładowych projektów. W standardowej domyślnej instalacji oprogramowania można je znaleźć w folderze \Users\Public\Documents\Altium\AD<Solution>\Examples . Ten instalator oparty na kreatorze jest uruchamiany przez wykonanie małego pliku wykonywalnego – AltiumDesignerDevelopSetup.exe (lub AltiumDesignerAgileSetup.exe). Dokument rysunku produkcyjnego oparty na Draftsman można dodać do projektu PCB (*.PCBDwf), projektu wiązki przewodów (*.HarDwf) lub projektu wielopłytkowego (*.MbDwf). TouchesRoom('Monitor','Auxilary','Effects')
Bold + Monospace	Używane do wyróżnienia skrótu klawiaturowego, do którego odnosi się tekst. Przykłady:   Kliknij prawym przyciskiem myszy lub naciśnij Esc , aby wyjść z trybu rozmieszczania. Naciśnij Spacebar, aby obrócić obiekt tekstowy przeciwnie do ruchu wskazówek zegara, lub Shift+Spacebar, aby obrócić go zgodnie z ruchem wskazówek zegara.
Menu » Menu Item	Odwołania do menu głównego w dokumentacji Altium Designer używają znaku » jako separatora. Pierwszy wpis odnosi się do samego menu, po którym następuje polecenie z tego menu. Jeśli polecenie jest dostępne z podmenu, używany jest dodatkowy znak », aby to wskazać. Przykłady:   Konfiguracja sprawdzania reguł projektowych jest wykonywana w oknie dialogowym Design Rule Checker, dostępnym za pomocą polecenia Tools » Design Rule Check z dokumentu PCB. Elementy wiązki są dostępne do umieszczania w edytorze schematów. Wybierz Place » Harness » Harness Entry z menu głównych.
Tab | Group | Button	Odwołania do menu głównego w dokumentacji Altium CircuitStudio i Altium CircuitMaker używają znaku | jako separatora. Pierwszy wpis odnosi się do konkretnej karty menu wstążki, następnie do grupy (lub obszaru) tej karty, a na końcu do przycisku w tej grupie. Jeśli polecenie jest dostępne z menu powiązanego z przyciskiem, używany jest znak », aby to wskazać. Przykłady:   Panel View Configuration, który służy do konfigurowania tego, co jest aktualnie wyświetlane w obszarze projektowym i w jaki sposób jest wyświetlane, można otworzyć w edytorze PCB, wybierając View | PCB | View Configuration. Aby przenieść aktualnie zaznaczone obiekty, użyj polecenia Tools | Arrange | Move » Move Selection.
Key1+Key2	W odniesieniu do skrótów użycie symbolu plus (+) oznacza przytrzymanie wielu klawiszy na klawiaturze w podanej sekwencji. Przykłady:   Shift+H (aby włączyć lub wyłączyć Heads Up Display w edytorze PCB). Shift+Ctrl+X (aby włączyć lub wyłączyć tryb Cross Select Mode w edytorach Schematic/PCB).
Key1, Key2	W odniesieniu do sekwencji klawiszy akceleratorów użycie przecinka (,) oznacza naciskanie kolejnych klawiszy sekwencji jeden po drugim. Przykłady:   X, A (w edytorze schematów, aby odznaczyć wszystkie obiekty na bieżącym arkuszu). P, V, K (w edytorze schematów, aby umieścić dyrektywę maski kompilacji). T, D, R (w edytorze PCB, aby uruchomić wsadowe sprawdzanie reguł projektowych).
Łącze	Zwykłe hiperłącze do celu, którym może być:   Inny obszar tej samej strony. Inna strona w ramach tego samego zestawu dokumentacji produktu. Inna strona w ramach innego zestawu dokumentacji produktu. Strona poza dokumentacją techniczną.
Info Box	Służy do wyróżnienia kluczowych dodatkowych informacji dotyczących konkretnego tematu omawianego na stronie. Przykład:   Źródłem danych BOM dla projektu wiązki przewodów jest rysunek układu projektu. Jeśli więc schemat połączeń Twojego projektu wiązki został zmieniony i zmiana ta powinna zostać odzwierciedlona w BOM, najpierw należy zaktualizować rysunek układu.
Feature/Tip Box	Używane do wyróżnienia konkretnej cechy lub funkcjonalności, o której warto wiedzieć, albo wskazówki dotyczącej jej użycia. Przykład:   Zestaw przykładowych projektów Altium Designer obejmuje przykładowy projekt wiązki przewodów –Harness_Demo_Prj.PrjHar – domyślnie w folderze \Users\Public\Documents\Altium\AD<Solution>\Examples\Harness Demo MB\Harness_Demo_Prj , który jest powiązany z demonstracyjnym projektem wielopłytkowym (\Examples\Harness Demo MB\Harness_Demo_MB\Harness_Demo_MB.PrjMbd), dzięki czemu możesz od razu przetestować wiązki po wyjęciu z pudełka.
Warning Box	Używane do wyróżnienia czegoś, o czym należy pamiętać lub co powinno zostać wykonane. Przykład:   Szczególnie zaleca się, aby przed wygenerowaniem końcowej dokumentacji produkcyjnej zawsze przeprowadzać wsadowe sprawdzanie reguł projektowych. DRC online wykrywa tylko nowe naruszenia – naruszenia utworzone po włączeniu tej funkcji – podczas gdy Batch DRC pozwala ręcznie uruchomić kontrolę w dowolnym momencie procesu projektowania płytki. Dlatego dobrzy projektanci, choć znają wartość DRC online, wiedzą również, że projektowanie płytki powinno zaczynać się i kończyć od Batch DRC.

Atrakcyjne elementy wizualne

W całej dokumentacji znajdziesz różne elementy wizualne stosowane po to, aby przekazywać informacje w bardziej angażujący sposób. Poniższe sekcje pokazują, jak wyglądają one na stronie i jak są używane.

Obraz statyczny

Skromny obraz statyczny jest jednym z podstawowych elementów dokumentacji i jest używany wraz z otaczającym go tekstem, aby wiernie przedstawić szczegóły dotyczące kluczowego aspektu oprogramowania.

Aby zachować przejrzystość prezentacji (i czytelność) dokumentu, stosowana jest stała szerokość strony. W związku z tym obrazy zazwyczaj nie mogą być domyślnie prezentowane w pełnym rozmiarze. Po najechaniu kursorem na obraz zmieni się on z ikony wskaźnika () na ikonę lupy (). Oznacza to, że po kliknięciu obrazu zostanie wyświetlona jego pełnowymiarowa wersja w pływającym oknie (tam, gdzie ma to zastosowanie i zgodnie z bieżącym rozmiarem okna przeglądarki). Poniższy obraz ilustruje to dla obrazu statycznego w dokumentacji (ironicznie, aby zobaczyć go w pełnym rozmiarze, musisz kliknąć obraz).

Pokaz slajdów

Element pokazu slajdów może zawierać kilka obrazów (i filmów), aby w przejrzysty sposób pokazać więcej informacji wizualnych wraz z podpisami. Ten element jest szczególnie przydatny podczas ilustrowania postępu lub sekwencji kroków do wykonania przy korzystaniu z określonej funkcji oprogramowania.

Poniższy obraz przedstawia przykładowy pokaz slajdów w dokumentacji i wyróżnia niektóre kluczowe obszary opisane poniżej.

1. Użyj tych kontrolek, aby odpowiednio przechodzić do przodu i do tyłu w pokazie slajdów. Po najechaniu na dany obszar stanie się on ciemniejszy. Możesz kliknąć w dowolnym miejscu w obrębie „ramki strzałki”, a nie tylko na samej ikonie strzałki.

2. Te „bąbelki” pokazują, ile slajdów znajduje się w pokazie i w którym miejscu zestawu aktualnie jesteś (ciemniejszy bąbelek). Możesz kliknąć bąbelek, aby szybko przejść do tego slajdu.

3. Pokaz slajdów może zawierać podpisy – po jednym podpisie na slajd. Będą one aktualizowane podczas przechodzenia między slajdami.

Animowany GIF

Animowany GIF jest używany wtedy, gdy zachodzi potrzeba pokazania procesu lub aspektu oprogramowania w sposób przypominający wideo, ale gdy ilustracja wizualna jest krótka i użycie filmu byłoby przesadą. Animowany GIF w dokumentacji można rozpoznać po wyraźnym przycisku „odtwarzania” pośrodku, jak pokazano na poniższym obrazie. Po kliknięciu przycisku GIF zostanie odtworzony do końca i zatrzyma się, ponownie wyświetlając przycisk odtwarzania.

Wideo (MP4)

Wideo, podobnie jak GIF, jest używane wtedy, gdy istnieje potrzeba wizualnego pokazania procesu lub aspektu oprogramowania „w trakcie wykonywania”, a taki materiał wizualny jest dłuższy niż odpowiedni dla GIF-a. Wideo w dokumentacji można rozpoznać po panelu sterowania przy dolnej krawędzi, jak pokazano na poniższym obrazie. Kliknij w dowolnym miejscu filmu, aby rozpocząć odtwarzanie (nie musisz klikać strzałki odtwarzania w lewym dolnym rogu). Kliknij ponownie (w dowolnym miejscu filmu), aby wstrzymać. Użyj dostępnych kontrolek wideo, aby na przykład przełączyć się do pełnego rozmiaru i z powrotem, przewijać do przodu i do tyłu na osi czasu oraz zmieniać prędkość odtwarzania.

Obraz po najechaniu

Obraz po najechaniu służy do przedstawienia scenariusza „przed i po” albo pewnego rodzaju porównania w odniesieniu do funkcji lub możliwości oprogramowania. Składa się tylko z dwóch obrazów. Na stronie wygląda jak zwykły obraz statyczny, przy czym domyślnie wyświetlany jest pierwszy obraz. Po najechaniu na niego kursorem pojawia się drugi obraz.

Poniżej znajduje się rzeczywisty przykład obrazu po najechaniu używanego w dokumentacji. W tym przypadku służy on do zilustrowania przelotek ekranujących (obraz domyślny/pierwszy) oraz przelotek łączących (drugi obraz, dostępny po najechaniu).

Obraz wyskakujący

Obraz wyskakujący służy do pokazania czegoś w kontekście otaczającego tekstu, bez dodawania tego obrazu bezpośrednio do głównego przepływu treści. W tym sensie można go traktować bardziej jako „wtrącenie” lub przykład wzmacniający komentarz albo stwierdzenie zawarte w tekście. Taki element pojawia się z jedną z dwóch ikon –  (wyskakujący obraz) lub  (wyskakujący animowany GIF albo wideo). Poniższy obraz pokazuje element wyskakujący po kliknięciu, w tym przypadku wyskakujące okno typu „obraz”, które wyświetla obraz w pełnym rozmiarze.

Tekst po najechaniu (podpowiedź)

Tekst po najechaniu (lub podpowiedź) służy do dostarczania dodatkowych, pomocnych wskazówek w kontekście konkretnego wpisu na stronie. Może to być na przykład objaśniająca uwaga do wpisu albo wyjaśnienie używanej terminologii w stylu słownika. Podpowiedź może pojawić się na jeden z dwóch sposobów:

• Ikona . Najedź na ikonę, aby uzyskać dostęp do podpowiedzi.

  

• Tekst z kropkowanym podkreśleniem. Najedź na tekst, aby uzyskać dostęp do podpowiedzi.

  

Sekcje zwijane

Aby utrzymać zawartość strony w porządku i nie przytłaczać użytkownika, stosowane są sekcje zwijane. Zwykle są one używane dla informacji bardziej szczegółowych, które nie są jednak konieczne do zrozumienia typowego toku strony (i dlatego nie muszą być prezentowane otwarcie). Taka treść może obejmować na przykład opcje dostępne w oknie dialogowym lub panelu albo szczególne kwestie związane z określonym aspektem funkcji omawianej w głównej treści. Rozwiń/zwiń taką sekcję, klikając w dowolnym miejscu jej nagłówka.

Uzyskiwanie łącza do strony lub określonej sekcji

Jeśli chcesz udostępnić stronę innym osobom, musisz mieć możliwość szybkiego uzyskania jej adresu URL. Można go uzyskać (skopiować do Schowka systemu Windows) na kilka sposobów:

1. Z paska adresu przeglądarki po pierwszym otwarciu strony.

2. Klikając prawym przyciskiem myszy wpis strony w lewym drzewie nawigacji, a następnie używając polecenia Copy link address z menu kontekstowego.

Idąc o krok dalej, możesz również uzyskać adres URL do konkretnej sekcji strony, którą aktualnie czytasz, w następujący sposób:

1. Użyj prawego panelu, aby przejść do żądanej sekcji w strukturze Zawartości strony, a następnie skopiuj adres URL z paska adresu przeglądarki.

2. Przewiń stronę w dół do żądanej sekcji. Podczas przewijania pasek adresu przeglądarki aktualizuje się tak, aby odzwierciedlać bieżącą sekcję, do której dotarłeś.

3. Kliknij prawym przyciskiem myszy wpis żądanej sekcji w strukturze Zawartości strony (w prawym panelu), a następnie użyj polecenia Copy link address z menu kontekstowego.

Możesz też szybko „pobrać link” z następujących miejsc:

• Main Section Header - kliknij kontrolkę „Copy Link” po lewej stronie nagłówka głównej sekcji.

  

• Collapsible Section - kliknij kontrolkę „Copy Link” po prawej stronie tytułu sekcji zwijanej.

  

Dokumentacja wersjonowana

W przypadku Altium On-Prem Enterprise Server powiązana z nim dokumentacja jest wersjonowana. Umożliwia to wybranie właściwej wersji dokumentacji dla używanej wersji oprogramowania. Wersję można wybrać albo z głównej bramy dokumentacji (z menu QuickLinks kafelka produktu), albo w dowolnym momencie w samej dokumentacji, korzystając z selektora wersji dostępnego w górnym banerze, jak pokazano poniżej.

System wersjonowania ostrzega Cię, jeśli czytasz stronę, która nie jest najnowszą wersją tej strony. Robi to na dwa sposoby:

• Numer wersji na rozwijanej liście selektora wersji jest wyświetlany w innym kolorze i oznaczony symbolem ostrzeżenia.
• U góry strony wyświetlane jest ostrzeżenie z łączem do najnowszej wersji. Kliknięcie tego łącza automatycznie przełączy wpis w selektorze wersji na najnowszą dostępną wersję.

Obowiązujące wersje

Podczas gdy oprogramowanie ewoluuje z wersji na wersję, dodając nowe funkcje i ulepszenia swojej funkcjonalności, powiązana dokumentacja wersjonowana dla Altium On-Prem Enterprise Server może ulegać zmianom tylko w niektórych obszarach. Wiele stron nie będzie miało wpływu na kolejną wersję oprogramowania, więc ta sama treść, która miała zastosowanie wcześniej, ma również zastosowanie do tej późniejszej wersji. Dlatego na każdej stronie podawana jest informacja wskazująca, dla których wersji oprogramowania można używać treści danej strony.

Poniższy obraz ilustruje takie oznaczenie. Tutaj otwarta jest wersja 8.0 strony opisującej funkcję Project History. Ta treść ma również zastosowanie do wersji 7.0, 7.1 i 7.2 oprogramowania. Innymi słowy, nie ma różnicy w treści strony, jeśli ustawisz selektor wersji dokumentacji na 7.0, 7.1, 7.2 lub 8.0.

Funkcja wyszukiwania w dokumentacji

Aby pomóc Ci znaleźć informacje w dokumentacji technicznej rozwiązań projektowych Altium, udostępniono zaawansowaną Search funkcję. Jest ona oparta na Google i w rzeczywistości obejmuje jedną wyszukiwarkę dla całej witryny altium.com. Sposób i miejsce dostępu do wyszukiwania określają, jak bardzo „przefiltrowane” będą Twoje początkowe wyniki:

• Z banera głównego witryny — dostęp i użycie pokazano na poniższym pokazie slajdów. Wyszukiwanie jest wykonywane w całej witrynie, a wyniki są prezentowane na osobnej karcie przeglądarki.

• Z „głównego wejścia” do dokumentacji technicznej (altium.com/documentation) — dostęp i użycie pokazano na poniższym pokazie slajdów. Wyszukiwanie jest wykonywane we wszystkich zestawach dokumentacji dostępnych dla różnych rozwiązań projektowych Altium, a także w Bazie Wiedzy. Wyniki są prezentowane na tej samej karcie przeglądarki.

• Z poziomu strony w dokumentacji technicznej — dostęp i użycie pokazano na poniższym pokazie slajdów. Wyszukiwanie jest wykonywane tylko w aktywnym zestawie dokumentacji, który jest aktualnie przeglądany. Wyniki są prezentowane na tej samej karcie przeglądarki.

Strony QuickNav (dokumentacja Altium Designer)

Jeśli chodzi o obiekty projektowe i panele w Altium Designer, informacje o tych elementach są rozproszone na bardzo wielu stronach w zestawie dokumentacji Altium Designer. Aby zapewnić łatwy sposób nawigacji do takich informacji, zastosowano koncepcję stronicowania QuickNav. Analogicznie do mapy „spisu sklepów” w centrum handlowym, strona QuickNav dostarcza szybkich informacji referencyjnych o elementach projektowych dostępnych dla określonego obszaru projektowania, umożliwiając szybkie przejście do bardziej szczegółowych informacji o każdym z nich.

W większości przypadków strona QuickNav prezentuje informacje w trzech odrębnych sekcjach:

• Graphical Overview - zestawienie wizualne często używanych obiektów, na przykład.
• Slideshow - przedstawiająca bardziej ogólne informacje o niektórych elementach, których będziesz używać częściej.
• A-Z Listing - wygodna lista alfabetyczna. Bez zbędnych dodatków i komplikacji. Po prostu bezpośrednie odnośniki do szczegółów konkretnego elementu.

Strony QuickNav są dostępne dla następujących obszarów:

• Obiekty projektowe schematów

• Obiekty projektowe PCB

• Obiekty projektowe Draftsman

• Obiekty projektowe schematów wielopłytkowych

• Obiekty projektowe Harness

• Panele

Strony QuickStart (dokumentacja Altium Designer)

W zestawie dokumentacji Altium Designer (który stanowi podstawę i obsługuje rozwiązania platformowe dostępne od Altium) znajdują się kluczowe strony najwyższego poziomu, które rozpatrywane łącznie tworzą wartościowy zestaw informacji typu „QuickStart”. Tego rodzaju strony prowadzą Cię przez określony obszar projektowania, dostarczając dokładnie tyle szczegółów, aby umożliwić szybkie rozpoczęcie pracy i zrozumienie danego obszaru, bez zbytniego zagłębiania się w temat. Są to następujące strony:

• Poznanie środowiska projektowego Altium

• Ujęcie pomysłu projektowego w postaci schematu

• Analiza projektu przy użyciu symulacji obwodów

• Zarządzanie BOM za pomocą ActiveBOM

• Zarządzanie zmianami projektowymi między schematem a PCB

• Projektowanie układu PCB

• Usprawnienie dokumentacji projektowej płytki dzięki Draftsman

• Przygotowanie projektu do produkcji

• Projektowanie z użyciem wielu PCB

• Projektowanie Harness

Funkcja polubienia/niepolubienia

Aby umożliwić nam uzyskanie ogólnych analiz dotyczących stron w dokumentacji technicznej, zastosowano powszechnie znaną funkcję „kciuk w górę/w dół”. Pozwala nam to ocenić, jak użyteczna jest dana strona, a jeśli nie jest, zaplanować działania naprawcze. Elementy sterujące tej funkcji znajdują się pod obszarem Content (ToC) strony, w prawym panelu. Kliknij raz ikonę kciuka, aby zarejestrować swój „głos”, kliknij ponownie, aby go usunąć. Jeśli klikniesz ikonę Thumbs Down i AND jesteś zalogowany na swoje konto Altium, będziesz mieć możliwość przekazania opinii, dlaczego strona nie była dla Ciebie użyteczna. To wysyła raport bezpośrednio do zespołu dokumentacji technicznej.

Mechanizm przekazywania opinii o dokumentacji

Od czasu do czasu możesz natknąć się na problem z dokumentem lub go odkryć, taki jak literówka, problem z dostępem, nieprawidłowe/niejasne informacje albo nieaktualne informacje. Błądzić jest rzeczą ludzką i liczymy na Ciebie, naszego czytelnika, aby pomóc nam skorygować takie problemy. W tym celu dokumentacja techniczna zawiera mechanizm opinii dostępny z każdej strony, który wysyła raport bezpośrednio do zespołu dokumentacji technicznej.

Do tego mechanizmu opinii uzyskuje się dostęp za pomocą skrótu klawiaturowego Ctrl+Enter. Jeśli chcesz odnieść się do konkretnego fragmentu tekstu i/lub obrazu, zaznacz go (maksymalnie 200 znaków) przed naciśnięciem Ctrl+Enter.

Po uruchomieniu tej funkcji wyświetlane jest okno Report Document Issue, z dodanym tekstem/obrazem, do którego się odnosisz (jeśli dotyczy). Użyj pola Issue (maks. 500 znaków), aby podać jak najwięcej szczegółów — naprawdę pomaga nam to szybciej zbadać i rozwiązać zasadny problem. Gdy wszystko będzie gotowe, kliknij przycisk Send Feedback, aby wysłać zgłoszenie. Komunikat z podziękowaniem potwierdzi pomyślne przesłanie i odebranie Twojego raportu. Nie da się wystarczająco podkreślić, jak ważna jest dla nas Twoja opinia i jak bardzo ją cenimy!

Obsługa wyświetlania na dowolnym urządzeniu

Minęły już czasy, gdy każdy projektant siedział przed komputerem stacjonarnym z jednym monitorem 1280x1024. Dziś nasze komputery stacjonarne mają wiele monitorów o różnych rozmiarach i rozdzielczościach. Musimy też mieć możliwość pracy z laptopa w terenie lub w biurze klienta. A ponieważ jesteśmy pasjonatami wiedzy, lubimy również korzystać z tabletu lub telefonu, aby przyswajać więcej informacji podczas oczekiwania na lot lub jazdy autobusem do biura.

Aby prezentować treści tak, by działały na wszystkich tych różnych urządzeniach, dokumentacja techniczna (jako część nadrzędnej witryny altium.com) wykorzystuje responsive web design. Responsywna witryna komunikuje się z urządzeniem docelowym i dostosowuje układ oraz rozmiar treści do tego urządzenia, rozdzielczości ekranu i rozmiaru okna przeglądarki. Możesz to łatwo zauważyć, zmieniając rozmiar okna przeglądarki; gdy zmniejszasz jego szerokość, elementy strony zmieniają układ, a czcionki i obrazy stają się mniejsze. Nawet na ekranie 5-calowym witryna pozostaje funkcjonalna — na przykład drzewo nawigacji jest nadal dostępne na tablecie lub telefonie jako rozwijane menu.

Dokumentacja przyjazna do druku

Szukasz możliwości wydrukowania części dokumentacji technicznej? Ponieważ stawiamy na funkcjonalność „online” i korzystamy również z wielu efektownych efektów wizualnych do przekazywania informacji, najpierw trzeba upewnić się, że strona jest odpowiednio przygotowana do wysłania na zaufane urządzenie drukujące (lub zapisania jako PDF). Po prawej stronie dolnego banera znajduje się odpowiednia kontrolka, która właśnie to umożliwia, pozwalając uzyskać wersję strony przyjazną do druku.

Zlokalizowana dokumentacja

Część naszych treści jest dostępna w językach innych niż angielski. Użyj selektora języka, znajdującego się po lewej stronie dolnego banera, aby wybrać żądany język spośród obecnie obsługiwanych.

Alternatywna wersja językowa treści dla konkretnej wersji strony zostanie wyświetlona automatycznie, jeśli jest dostępna; w przeciwnym razie pokazana zostanie treść w języku angielskim. Poniższy pokaz slajdów ilustruje lokalizację w praktyce dla strony dostępnej w językach angielskim, japońskim, chińskim, koreańskim i polskim.

Tłumaczenie w przeglądarce (nieoficjalne)

W zależności od używanej przeglądarki internetowej możesz mieć dostęp do tymczasowego tłumaczenia aktualnie czytanej strony „w locie”. Poniższy pokaz slajdów ilustruje użycie funkcji Tłumacz w Google Chrome do szybkiego wyświetlenia strony w jednym z wielu obsługiwanych języków, w tym przypadku po niemiecku. Pamiętaj, że tłumaczenie jest tymczasowe — przejście do innej strony i powrót albo odświeżenie strony spowoduje przywrócenie oryginalnego aktualnie wyświetlanego języka.

Baza wiedzy

Użytkownicy często trafiają do Bazy wiedzy Altium i zakładają, że to całość naszej dokumentacji technicznej. W rzeczywistości jest to odrębny zasób sam w sobie. Oba te elementy tworzą wręcz symbiotyczną relację, w której Baza wiedzy i Dokumentacja techniczna wzajemnie się łączą i uzupełniają, aby dostarczyć Ci poszukiwane informacje.

Baza wiedzy to podstawowe miejsce samoobsługi, którego treści są opracowywane przez członków działu wsparcia Altium — osoby posiadające ekspercką wiedzę o rozwiązaniach Altium. Treści te powstają bezpośrednio na podstawie problemów napotkanych przez innych użytkowników. Efektem jest organicznie rozwijające się repozytorium artykułów zawierających ukierunkowane odpowiedzi/rozwiązania dotyczące konkretnych tematów i przypadków brzegowych. Precyzyjne, krótkie artykuły, które pomagają szybko wrócić do pracy.

Interfejs Bazy wiedzy jest niezwykle prosty. Możesz wyszukiwać we wszystkich artykułach albo ograniczyć wyszukiwanie do artykułów w jednej z obsługiwanych kategorii rozwiązań projektowych. Następnie po prostu zacznij wpisywać szukaną frazę — filtrowanie będzie stosowane na bieżąco. Gdy znajdziesz interesujący artykuł, kliknij jego wpis, aby go otworzyć.

Prawa autorskie do dokumentacji

Informacje o prawach autorskich dotyczących Dokumentacji technicznej są wygodnie przedstawione na poniższym obrazie i są dostępne w sekcji QuickLinks panelu Nav Tree (Informacje o prawach autorskich do dokumentacji), który jest dostępny podczas przeglądania dowolnej strony dokumentacji technicznej. Strona zawiera łącze do strony Copyrights & Trademarks w głównym serwisie altium.com.

Na zakończenie cytat...

To w dużej mierze mantra, którą kieruje się zespół Dokumentacji technicznej i którą stara się realizować. W przyszłości dokumentacja techniczna będzie nadal rozwijana, szczególnie z perspektywy użyteczności. W końcu nawet ogrom informacji jest przydatny tylko wtedy, gdy użytkownicy potrafią je znaleźć. W miarę udostępniania nowych rozwiązań, ulepszeń i funkcji ta strona będzie aktualizowana, aby odzwierciedlać i wyróżniać te dodatkowe elementy oraz pokazywać, jak najlepiej z nich korzystać, aby dotrzeć do potrzebnych informacji.