Использование документации Altium

Для доступных от Altium решений для проектирования предоставляется обширный набор технической документации. В этом документе собраны удобные «советы и приемы» по использованию документации для поиска нужной информации, а также приведены расширенные сведения о многочисленных и разнообразных аспектах документации, о существовании которых вы могли не знать.

Доступ к технической документации

Основной шлюз к технической документации — своего рода «входная дверь» — находится здесь: https://www.altium.com/documentation/. 

В самом центре страницы представлены следующие два набора документации:

• Altium Designer – программное обеспечение для настольного проектирования, представленное под следующими брендами:

  • Altium Designer Develop – когда оно является частью решения Altium Develop.

  • Altium Designer Agile – когда оно является частью решения Altium Agile.

  • Altium Designer – когда оно по-прежнему используется (по действующей срочной лицензии) и не входит в состав платформенного решения.

• Altium 365 – облачная платформа, основное Workspace которой представлено под следующими брендами:

  • Altium Develop Workspace - когда оно создано как часть решения Altium Develop.

  • Altium Agile Workspace - когда оно создано как часть решения Altium Agile.

  • Altium 365 Workspace – когда оно по-прежнему используется с Altium Designer (по действующей срочной лицензии) и не входит в состав платформенного решения.

Обратите внимание, что в обоих случаях для поддержки всех решений используется единый набор документации. В документации Altium Designer при упоминании программного обеспечения обычно используется сокращенная форма «Altium Designer». В документации Altium 365 для обозначения платформы используется «Altium Platform» (или «Altium 365»), а для обозначения Workspace, размещенного на платформе, — «Altium Workspace» (или «Altium 365 Workspace», или просто «Workspace»).

Работа со страницей:

• Нажмите на основной заголовок плитки, чтобы открыть домашнюю страницу документации для соответствующего решения для проектирования.

• Нажмите на ссылку внутри плитки Altium Designer или Altium 365, чтобы открыть информацию по этой конкретной области.

• Используйте доступные QuickLinks меню для перехода к дополнительным ключевым страницам, как показано ниже для плиток документации Altium Designer и Altium 365.

• Используйте поле Search в верхней части страницы, чтобы быстро выполнять поиск по всей документации для всех решений для проектирования (и их версий, где применимо), а также по базе знаний. Подробнее о функции поиска см. в разделе Средство поиска по документации.

• Нажмите на элемент Other Products, чтобы развернуть страницу и получить доступ к документации по другим решениям/областям: Renesas 365, Altium On-Prem Enterprise Server, Company Dashboard, Altium CircuitMaker, Altium CircuitStudio и Altium Infrastructure Server.

  

• Нажмите на элемент See Also, чтобы развернуть страницу и получить доступ к другим полезным ресурсам, предлагаемым Altium, таким как база знаний, Learning Hub (с множеством интересных и тематических статей, многие из которых написаны отраслевыми экспертами), Altium Professional Training и форумы Altium (ценнейший ресурс для обучения с информацией непосредственно от ваших коллег).

  

Прямой доступ с помощью «F1»

Для программного обеспечения для проектирования, включая Altium Designer, с сочетанием клавиш F1 определенно стоит познакомиться поближе. Наведите указатель мыши на многие элементы в среде программы — команду меню, диалоговое окно, панель, объект проекта или ключевое слово языка запросов — затем нажмите F1 , чтобы открыть документацию по этому элементу. Связь между элементом программы и технической документацией обеспечивает файл сопоставления (*.HelpID), который находится в папке \Program Files\Altium\AD<Solution>\Help основной установки.

На следующем изображении показана работа этой функции. Здесь сочетание клавиш F1 используется для доступа к документации по команде Material Library, доступной при редактировании стека слоев для PCB с помощью Layer Stack Manager.

Обновления F1

Для поддерживаемого программного обеспечения для проектирования файл сопоставления HelpID в основной папке установки \Help обновляется с каждым новым выпуском этого ПО. Однако бывают случаи, когда команда Technical Documentation вносит изменения в файл сопоставления между выпусками. Чтобы пользователи могли получать последние изменения F1, не дожидаясь следующего выпуска программного обеспечения, мы используем подход обновления «на лету», в котором задействуется параметр Check frequency на странице System - Installation диалогового окна Preferences.

Если интервал проверки истек, то при следующем использовании функции F1 более поздняя версия файла сопоставления загружается в папку \ProgramData\Altium\Altium Designer <Solution> <GUID>\Help. Эта более поздняя версия файла HelpID имеет приоритет над файлом по умолчанию в папке \Help основной установки.

Альтернативные способы доступа

Доступ к технической документации также можно получить различными дополнительными способами, включая:

• Через внешний поиск с помощью поисковой системы вашего веб-браузера, например Google. Чтобы ограничить такой поиск документацией Altium, укажите сайт в качестве префикса, используя формат site:altium.com/documentation <Search String> (например, site:altium.com/documentation PCB Layout Replication).

• Переходя по ссылке, приведенной в официальном сообщении Altium на форуме.

• Переходя по ссылкам, доступным в других разделах основного сайта altium.com (например, из раздела Learning Hub или со специальных страниц «Что нового» и страниц, посвященных отдельным функциям).

• Переходя по специальным ссылкам в программном обеспечении. Например, из Help меню или с помощью ссылок «Learn More» (или аналогично сформулированных).

Интерфейс документации

Интерфейс документации обычно включает до 14 отдельных областей, показанных на следующем изображении и подробно описанных далее.

1. Product Documentation Selector – используйте этот элемент управления для переключения между доступными специализированными наборами документации.

2. Theme Selector – используйте этот элемент управления для переключения между светлым () и темным () режимами отображения, как показано в следующем примере.

   

    

   

    

    

3. Search – используйте это поле для ввода поискового запроса и поиска информации в документации по продукту, которая просматривается в данный момент. Связанные фильтры поиска позволяют затем скорректировать область поиска. Подробнее см. в разделе Средство поиска по документации.

4. Nav Tree Pane – отображает все страницы, входящие в документацию по просматриваемому продукту. Они логически сгруппированы; нажмите на элемент, чтобы открыть соответствующую страницу. Элементы управления в правом верхнем углу панели позволяют изменять ее размер и/или управлять ее видимостью.

5. QuickLinks – выделенный и статический компонент панели Nav Tree, который отображается всегда, независимо от того, документация по какому продукту просматривается. Он обеспечивает быстрый доступ к этой странице, сведениям об авторских правах и основному шлюзу документации, а также быстрый доступ к базе знаний.

6. Breadcrumbs – обеспечивает дополнительное средство навигации на основе активной просматриваемой страницы, позволяя переходить к родительским страницам выше по иерархии. Если цепочка навигации содержит много страниц, для удобства отображения используется многоточие. Нажмите его, чтобы открыть всплывающее окно со всеми дополнительными промежуточными страницами в цепочке, каждая из которых является активной ссылкой на соответствующую страницу.

   

7. Main Page Content – это основная область интерфейса, в которой отображается страница, выбранная на панели Nav Tree . Подробнее о различных аспектах содержимого страницы, а также советы по входящим в нее функциям и возможностям см. в разделе Просмотр технического документа.

8. Feature Availability Note – это отображается на каждой странице в определенных наборах документации. Техническая документация охватывает все возможности и функциональность продукта или элемента общего решения. В случае с Altium Designer и Altium 365 доступность функции, представленной на странице, зависит от того, какое решение Altium вы используете: Altium Develop, редакцию Altium Agile (Agile Teams или Agile Enterprise) либо Altium Designer (с активной подпиской). Если вы не видите описанную функцию в своем программном обеспечении, свяжитесь с отделом продаж Altium, чтобы узнать больше.

9. Legacy Documentation Note – это отображается на каждой странице документации Altium Designer. Это обеспечивает быстрый доступ к разделу Legacy Documentation на странице Other Installers, где размещена документация по более ранним версиям программного обеспечения.

10. Table of Contents – область Content в правой панели отображает, где это применимо, структуру текущей страницы в виде ее заголовков (уровни 2–4, поскольку уровень 1 — это заголовок страницы). Щелкните по записи, чтобы перейти к соответствующему месту на странице. И наоборот, при прокрутке страницы область Content будет обновляться, отслеживая ваше текущее положение в документе.

11. Like/Dislike – повсеместно доступная функция «палец вверх/вниз», позволяющая быстро оценить, была ли страница полезной, и, если нет, сообщить нам почему (доступно при входе в вашу учетную запись Altium). Подробнее см. Like/Dislike Functionality.

12. Language Selector – обеспечивает быстрый способ переключения просмотра документации на один из нескольких официально поддерживаемых языков.

13. Documentation Feedback (отображается при входе в вашу учетную запись Altium) – эта функция предоставляет вам быстрый способ отправить команде Technical Documentation отзыв о странице, в первую очередь для указания опечаток, неверной/устаревшей информации или отсутствующих сведений. Просто выделите текст и/или изображение на странице и используйте сочетание клавиш Ctrl+Enter, чтобы открыть эту функцию. Подробнее см. Documentation Feedback Mechanism.

14. Printer-friendly version – предоставляет возможность на лету создать версию страницы, содержимое которой специально подготовлено для удобной печати (например, для сохранения в PDF).

Структурная навигация по страницам

В панели интерфейса Nav Treeвы иногда будете встречать элементы, которые при щелчке не открывают страницу документации. Это сделано намеренно и используется как средство добавления дополнительной структуры в дерево, когда требуется сгруппировать страницы под общим «родительским» элементом, но информация на самой родительской странице не нужна. Такой тип страницы — Structure — именно для этого и служит. При наведении курсора на такой элемент он не подчеркивается (в отличие от элемента «настоящей» страницы документации). При щелчке по такому элементу просто раскрывается соответствующий раздел дерева. Щелкните еще раз, чтобы свернуть его.

Просмотр технического документа

В следующих разделах приводится информация о различных аспектах содержимого самой страницы.

Соглашения в документации

Bold	Используется для выделения команды меню, элемента управления диалогового окна, кнопки или панели инструментов, упоминаемых в тексте. Примеры:   Используйте команду Annotate Schematics Quietly. Если в диалоговом окне включен параметр Copy routed nets, будет выполнена трассировка от исходного блока. Нажмите кнопку Refresh в верхней части Constraint Manager. Поиск и использование команды Place Pad () на панели инструментов Active Bar или Wiring .
Italic	Используется для выделения панели или диалогового окна, упоминаемых в тексте. Примеры:   Функции PCB CoDesign доступны и используются через панель PCB CoDesign. Аннотирование схемы настраивается в диалоговом окне Annotate. Курсив также используется там, где это необходимо, для акцентирования важного момента.
Monospace	Используется для выделения расположения на жестком диске, имени файла, расширения файла, выражения языка запросов или ключевого слова языка, упоминаемых в тексте. Примеры:   Набор примеров проектов устанавливается как часть первоначальной установки. При стандартной установке программного обеспечения по умолчанию их можно найти в папке \Users\Public\Documents\Altium\AD<Solution>\Examples . Этот установщик на основе мастера запускается выполнением небольшого исполняемого файла — AltiumDesignerDevelopSetup.exe (или AltiumDesignerAgileSetup.exe). Документ производственного чертежа на основе Draftsman можно добавить в проект PCB (*.PCBDwf), проект жгута (*.HarDwf) или многоплатный проект (*.MbDwf). TouchesRoom('Monitor','Auxilary','Effects')
Bold + Monospace	Используется для выделения сочетания клавиш, упоминаемого в тексте. Примеры:   Щелкните правой кнопкой мыши или нажмите Esc , чтобы выйти из режима размещения. Нажмите Spacebar, чтобы повернуть текстовый объект против часовой стрелки, или Shift+Spacebar для поворота по часовой стрелке.
Menu » Menu Item	Ссылки на главное меню в документации Altium Designer используют символ » в качестве разделителя. Первая запись указывает на само меню, за ней следует команда в этом меню. Если команда вызывается из подменю, используется дополнительный символ », чтобы обозначить это. Примеры:   Настройка проверки правил проектирования выполняется в диалоговом окне Design Rule Checker, которое открывается командой Tools » Design Rule Check из документа PCB. Элементы жгута доступны для размещения в редакторе схем. Выберите Place » Harness » Harness Entry в главном меню.
Tab | Group | Button	Ссылки на главное меню в документации Altium CircuitStudio и Altium CircuitMaker используют символ | в качестве разделителя. Первая запись указывает на конкретную вкладку ленточного меню, затем следует группа (или область) этой вкладки и, наконец, кнопка в этой группе. Если команда вызывается из меню, связанного с кнопкой, используется символ », чтобы обозначить это. Примеры:   Панель View Configuration, которая используется для настройки того, что в данный момент отображается в рабочей области проекта и как именно это отображается, можно открыть в редакторе PCB, выбрав View | PCB | View Configuration. Чтобы переместить выбранные в данный момент объекты, используйте команду Tools | Arrange | Move » Move Selection.
Key1+Key2	При указании сочетаний клавиш использование символа плюс (+) означает, что несколько клавиш на клавиатуре нужно удерживать одновременно в указанной последовательности. Примеры:   Shift+H (для включения или выключения Heads Up Display в редакторе PCB). Shift+Ctrl+X (для включения или выключения режима Cross Select Mode в редакторах Schematic/PCB).
Key1, Key2	При указании последовательностей клавиш быстрого доступа использование запятой (,) означает, что каждую клавишу в последовательности нужно нажимать по очереди. Примеры:   X, A (в редакторе схем — чтобы снять выделение со всех объектов на текущем листе). P, V, K (в редакторе схем — чтобы разместить директиву compile mask). T, D, R (в редакторе PCB — чтобы запустить пакетную проверку Design Rule Check).
Ссылка	Обычная гиперссылка на цель, которой может быть:   Другая область той же страницы. Другая страница в рамках того же набора документации по продукту. Другая страница в рамках другого набора документации по продукту. Страница вне технической документации.
Информационный блок	Используется для выделения важной дополнительной информации по конкретной теме, рассматриваемой на странице. Пример:   Источником данных BOM для проекта жгута является чертеж компоновки проекта. Поэтому, если схема соединений вашего проекта жгута была изменена и это изменение должно отразиться в BOM, сначала необходимо обновить чертеж компоновки.
Блок Feature/Tip	Используется для выделения конкретной функции или возможности, о которой следует знать, либо полезного совета по ее использованию. Пример:   В набор примеров проектов Altium Designer входит пример проекта жгута —Harness_Demo_Prj.PrjHar — в папке \Users\Public\Documents\Altium\AD<Solution>\Examples\Harness Demo MB\Harness_Demo_Prj по умолчанию; он связан с демонстрационным многоплатным проектом (\Examples\Harness Demo MB\Harness_Demo_MB\Harness_Demo_MB.PrjMbd), поэтому вы можете опробовать жгуты сразу после установки.
Предупреждающий блок	Используется для выделения того, о чем важно знать или что следует выполнить. Пример:   Особенно рекомендуется всегда выполнять пакетную проверку правил проектирования перед созданием финальных производственных файлов. Online DRC обнаруживает только новые нарушения — нарушения, созданные после включения этой функции, — тогда как Batch DRC позволяет вручную запускать проверку в любой момент процесса проектирования платы. Поэтому, хотя хорошие разработчики знают ценность Online DRC, они также знают, что проектирование платы должно начинаться и заканчиваться с Batch DRC.

Наглядные визуальные элементы

Во всей документации используются различные визуальные элементы для более наглядной и увлекательной подачи информации. В следующих разделах показано, как они выглядят на странице и как используются.

Статическое изображение

Обычное статическое изображение — один из основных элементов документации; оно используется вместе с окружающим текстом, чтобы точно передать детали ключевого аспекта программного обеспечения.

Чтобы сохранить удобное оформление документа (и его читаемость), для страницы используется фиксированная ширина. Поэтому изображения обычно не могут по умолчанию отображаться в полном размере. Когда вы наводите курсор на изображение, он меняется со значка указателя () на значок лупы (). Это означает, что при щелчке по изображению откроется его полноразмерная версия во всплывающем окне (если это применимо и в соответствии с текущим размером окна браузера). Следующее изображение иллюстрирует это для статического изображения в документации (иронично, но вам придется щелкнуть по изображению, чтобы увидеть его в полном размере).

Слайд-шоу

Элемент слайд-шоу может содержать несколько изображений (и видео), позволяя аккуратно показать больше визуальной информации вместе с подписями. Этот элемент особенно полезен при демонстрации последовательности действий или пошагового процесса при использовании определенной функции программного обеспечения.

Следующее изображение показывает пример слайд-шоу в документации и выделяет несколько ключевых областей, описанных ниже.

1. Используйте эти элементы управления, чтобы переходить вперед и назад по слайд-шоу соответственно. При наведении на область она становится темнее. Можно щелкнуть в любом месте внутри «рамки стрелки», а не только по самому значку стрелки.

2. Эти «пузырьки» показывают, сколько слайдов входит в показ и на каком из них вы находитесь (более темный пузырек). Можно щелкнуть по пузырьку, чтобы быстро перейти к соответствующему слайду.

3. Слайд-шоу может включать подписи — по одной подписи на каждый слайд. Они будут обновляться при переходе между слайдами.

Анимированный GIF

Анимированный GIF используется, когда нужно показать процесс или аспект работы программного обеспечения в формате, похожем на видео, но при этом визуальная демонстрация короткая, и использование видео было бы излишним. Анимированный GIF в документации можно узнать по заметной кнопке «воспроизведения» в центре, как показано на следующем изображении. После нажатия кнопки GIF проигрывается до конца и останавливается, снова отображая кнопку воспроизведения.

Видео (MP4)

Видео, как и GIF, используется когда необходимо визуально показать выполняемый процесс или аспект работы программного обеспечения, и когда такой визуальный материал длиннее, чем подходит для GIF. Видео в документации отличается наличием панели управления в нижней части, как показано на следующем изображении. Щелкните в любом месте видео, чтобы начать воспроизведение (необязательно нажимать на стрелку воспроизведения внизу слева). Щелкните еще раз (в любом месте видео), чтобы поставить на паузу. Используйте доступные элементы управления видео, чтобы, например, переключаться в полноразмерный режим и обратно, перемещаться вперед и назад по временной шкале и изменять скорость воспроизведения.

Изображение при наведении

Изображение при наведении используется для показа сценария «до и после» или какого-либо сравнения, связанного с функцией или возможностью программного обеспечения. Оно состоит только из двух изображений. На странице оно выглядит как обычное статическое изображение, при этом по умолчанию показывается первое изображение. При наведении курсора появляется второе изображение.

Ниже приведен реальный пример такого визуального элемента, используемого в документации. В данном случае он применяется для иллюстрации экранирующих переходных отверстий (изображение по умолчанию/первое изображение) и stitching vias (второе изображение, доступное при наведении).

Всплывающее изображение

Всплывающее изображение используется, чтобы показать что-либо в контексте окружающего текста, не добавляя само изображение непосредственно в поток содержимого. В этом смысле его можно считать своего рода «врезкой» или примером, усиливающим комментарий или утверждение, сделанное в тексте. Такой элемент отображается с одним из двух значков —  (всплывающее изображение) или  (всплывающий анимированный GIF или видео). Следующее изображение показывает всплывающий элемент после щелчка; в данном случае это всплывающий элемент типа «изображение», который открывает полноразмерное изображение.

Текст при наведении (подсказка)

Текст при наведении (или подсказка) используется для предоставления дополнительной полезной информации в контексте конкретного элемента на странице. Это может быть, например, поясняющее примечание к элементу или объяснение используемой терминологии в стиле глоссария. Подсказка может отображаться одним из двух способов:

• Значок . Наведите курсор на значок, чтобы открыть подсказку.

  

• Текст с пунктирным подчеркиванием. Наведите курсор на текст, чтобы открыть подсказку.

  

Сворачиваемые разделы

Чтобы содержимое страницы оставалось аккуратным и не выглядело перегруженным, используются сворачиваемые разделы. Обычно они применяются для информации более глубокого уровня, которая не обязательно нужна для понимания основного хода страницы (и потому не требует постоянного открытого отображения). Таким содержимым могут быть, например, параметры, доступные в диалоговом окне или панели, либо особые замечания, относящиеся к определенному аспекту функции, обсуждаемой в основном содержимом. Развернуть/свернуть такой раздел можно, щелкнув в любом месте заголовка раздела.

Получение ссылки на страницу или конкретный раздел

Если вы хотите поделиться страницей с другими, вам нужна возможность быстро получить ее URL-адрес. Это можно сделать (скопировав его в буфер обмена Windows) несколькими способами:

1. Из адресной строки браузера при первом открытии страницы.

2. Щелкнув правой кнопкой мыши по записи страницы в левом дереве навигации, а затем выбрав команду Copy link address в контекстном меню.

Кроме того, можно получить URL-адрес конкретного раздела страницы, которую вы сейчас читаете, следующим образом:

1. Используйте правую панель, чтобы перейти к нужному разделу в структуре содержимого страницы, затем скопируйте URL-адрес из адресной строки браузера.

2. Прокрутите страницу до нужного раздела. По мере прокрутки адресная строка браузера обновляется, отражая текущий достигнутый раздел.

3. Щелкните правой кнопкой мыши по записи нужного раздела в структуре содержимого страницы (на правой панели), затем выберите команду Copy link address в контекстном меню.

Также можно быстро «получить ссылку» из следующих мест:

• Main Section Header - нажмите элемент управления «Copy Link» слева от заголовка основного раздела.

  

• Collapsible Section - нажмите элемент управления «Copy Link» справа от заголовка сворачиваемого раздела.

  

Версионируемая документация

Для Altium On-Prem Enterprise Server связанная с ним документация имеет версии. Это позволяет выбрать правильную версию документации для используемой вами версии программного обеспечения. Версию можно выбрать либо на главной странице документации (в меню QuickLinks плитки продукта), либо в любой момент внутри документации с помощью селектора версии, доступного в верхней области баннера, как показано ниже.

Система версионирования предупреждает вас, если вы читаете страницу, которая не является последней версией этой страницы. Это делается двумя способами:

• Номер версии в раскрывающемся селекторе версии отображается другим цветом и помечается предупреждающим символом.
• В верхней части страницы отображается предупреждение со ссылкой на последнюю версию. Переход по ссылке автоматически переключит запись в селекторе версии на последнюю доступную версию.

Применимые версии

Хотя программное обеспечение развивается от версии к версии, получая новые функции и улучшения, связанная с ним версионируемая документация для Altium On-Prem Enterprise Server может затрагиваться лишь в отдельных областях. Многие страницы не будут изменяться в следующей версии ПО, поэтому тот же контент, который был актуален ранее, остается применимым и для более поздней версии. Поэтому на каждой странице приводится указание, показывающее, для каких версий программного обеспечения можно использовать содержимое этой страницы.

Следующее изображение иллюстрирует такое указание. Здесь открыта версия 8.0 страницы с описанием функции Project History. Это содержимое в равной степени применимо и к версиям 7.0, 7.1 и 7.2 программного обеспечения. Иными словами, содержимое страницы не отличается, если в селекторе версии документации выбрать 7.0, 7.1, 7.2 или 8.0.

Средство поиска по документации

Чтобы помочь вам находить информацию в технической документации по решениям Altium для проектирования, предусмотрено мощное Search средство. Оно работает на базе Google, и фактически для всего сайта altium.com используется единый механизм поиска. То, как и откуда вы запускаете поиск, определяет, насколько «отфильтрованными» будут первоначальные результаты:

• Из верхнего баннера сайта — доступ и использование показаны в следующем слайд-шоу. Поиск выполняется по всему сайту, а результаты отображаются в отдельной вкладке браузера.

• С «главной страницы» технической документации (altium.com/documentation) — доступ и использование показаны в следующем слайд-шоу. Поиск выполняется по всем наборам документации, доступным для различных решений Altium для проектирования, а также по базе знаний. Результаты отображаются в той же вкладке браузера.

• Со страницы внутри технической документации — доступ и использование показаны в следующем слайд-шоу. Поиск выполняется только в пределах активного набора документации, который вы просматриваете в данный момент. Результаты отображаются в той же вкладке браузера.

Страницы QuickNav (документация Altium Designer)

Что касается объектов проектирования и панелей в Altium Designer, информация об этих элементах распределена по очень большому числу страниц в наборе документации Altium Designer. Чтобы обеспечить удобный способ перехода к такой информации, была применена концепция страниц QuickNav. Подобно карте-справочнику магазинов в торговом центре, страница QuickNav предоставляет краткую справочную информацию об элементах проектирования, доступных для определенной области проектирования, позволяя быстро переходить к более подробной информации по каждому из них.

В большинстве случаев страница QuickNav представляет информацию в трех отдельных разделах:

• Graphical Overview - сводное визуальное представление часто используемых объектов, например.
• Slideshow - содержит более обзорную информацию о некоторых элементах, которые вы будете использовать чаще всего.
• A-Z Listing - удобный алфавитный список. Без излишеств и лишних сложностей. Просто прямые ссылки на подробную информацию по конкретному элементу.

Страницы QuickNav доступны для следующих разделов:

• Объекты схемотехнического проектирования

• Объекты проектирования PCB

• Объекты проектирования Draftsman

• Объекты схемотехнического проектирования Multi-board

• Объекты проектирования Harness

• Панели

Страницы QuickStart (документация Altium Designer)

В наборе документации Altium Designer (который лежит в основе и обслуживает платформенные решения, доступные от Altium) есть ключевые страницы верхнего уровня, которые в совокупности образуют ценный набор информации «QuickStart». Такие страницы проводят вас через определенную область проектирования, давая ровно столько деталей, сколько нужно, чтобы вы могли начать работу и разобраться в этой области, не погружаясь слишком глубоко. Это следующие страницы:

• Знакомство со средой проектирования Altium

• Представление вашей идеи в виде схемы

• Анализ проекта с использованием схемотехнического моделирования

• Управление BOM с помощью ActiveBOM

• Управление изменениями проекта между схемой и PCB

• Трассировка вашей PCB

• Оптимизация подготовки конструкторской документации платы с помощью Draftsman

• Подготовка проекта к производству

• Проектирование с использованием нескольких PCB

• Проектирование Harness

Функциональность Like/Dislike

Чтобы мы могли получать аналитические данные общего уровня по страницам технической документации, используется повсеместная функция «Thumbs Up/Down». Она позволяет нам видеть, насколько полезна страница, и, если это не так, планировать работу по ее улучшению. Элементы управления этой функцией находятся под областью Content (ToC) страницы, на правой панели. Нажмите один раз на значок большого пальца, чтобы зарегистрировать свой «голос», нажмите еще раз, чтобы убрать его. Если вы нажмете на значок Thumbs Down AND и при этом будете авторизованы в своей учетной записи Altium, у вас будет возможность указать, почему страница оказалась для вас бесполезной. Это отправляет отчет напрямую команде Technical Documentation.

Механизм обратной связи по документации

Время от времени вы можете столкнуться с проблемой в документе или обнаружить ее, например опечатку, проблему доступа, неверную/неясную информацию или устаревшие сведения. Ошибаться свойственно человеку, и мы рассчитываем на вас, наших читателей, чтобы помогать нам исправлять такие проблемы. Для этого в техническую документацию встроен механизм обратной связи, доступный с любой страницы и отправляющий отчет напрямую команде Technical Documentation.

Этот механизм обратной связи вызывается с помощью сочетания клавиш Ctrl+Enter. Если вы хотите сослаться на определенный фрагмент текста и/или изображение, выделите его (не более 200 символов) перед нажатием Ctrl+Enter.

После вызова этой функции отображается окно Report Document Issue, в которое добавляется указанный текст/изображение (если применимо). Используйте поле Issue (максимум 500 символов), чтобы предоставить как можно больше подробностей — это действительно помогает нам быстрее исследовать и устранять подтвержденную проблему. Когда все будет готово, нажмите кнопку Send Feedback, чтобы отправить сообщение. Подтверждающее сообщение с благодарностью укажет на успешную отправку и получение вашего отчета. Трудно переоценить, насколько важна для нас ваша обратная связь, и мы искренне ее ценим!

Поддержка просмотра на любом устройстве

Прошли те времена, когда каждый разработчик сидел перед настольным компьютером с одним монитором 1280x1024. Сегодня наши настольные ПК оснащены несколькими мониторами разных размеров и разрешений. Нам также необходимо иметь возможность работать с ноутбука в полевых условиях или в офисе клиента. Кроме того, поскольку мы любим знания, нам нравится иметь возможность использовать планшет или телефон, чтобы получать больше информации, пока мы ждем рейс или едем на автобусе в офис.

Чтобы представить содержимое так, чтобы оно корректно работало на всех этих различных устройствах, техническая документация (как часть основного сайта altium.com) использует responsive web design. Адаптивный веб-сайт взаимодействует с целевым устройством и подстраивает компоновку и размер содержимого под это устройство, разрешение экрана и размер окна браузера. Вы можете сами увидеть это, изменяя размер окна браузера: по мере уменьшения ширины элементы страницы перестраиваются, а шрифты и изображения становятся меньше. Даже на 5-дюймовом экране сайт остается функциональным — например, дерево навигации по-прежнему доступно на планшете или телефоне в виде раскрывающегося списка.

Версия документации для печати

Хотите распечатать часть технической документации? Поскольку мы активно используем «онлайн»-функциональность, а также множество эффектных визуальных элементов для подачи информации, сначала необходимо подготовить страницу к отправке на ваше надежное печатающее устройство (или к сохранению в PDF). В правой части нижней панели вы найдете элемент управления, который позволяет сделать именно это, предоставляя вам версию страницы, удобную для печати.

Локализованная документация

Часть нашего контента доступна на языках, отличных от английского. Используйте переключатель языка, расположенный в левой части нижней панели, чтобы выбрать нужный язык из числа поддерживаемых в настоящий момент.

Если для определенной версии страницы доступен контент на альтернативном языке, он будет показан автоматически; в противном случае будет отображаться английская версия. Следующее слайд-шоу иллюстрирует локализацию в действии на примере страницы, доступной на английском, японском, китайском, корейском и польском языках.

Перевод в браузере (неофициальный)

В зависимости от используемого веб-браузера у вас может быть доступ к временному переводу открытой страницы «на лету». Следующее слайд-шоу демонстрирует использование функции перевода в Google Chrome для быстрого просмотра страницы на одном из множества поддерживаемых языков, в данном случае — на немецком. Обратите внимание, что такой перевод является временным: переход на другую страницу и обратно или обновление страницы вернет исходный отображаемый язык.

База знаний

Пользователи часто попадают в Базу знаний Altium и предполагают, что она охватывает всю нашу техническую документацию. На самом деле это отдельный ресурс сам по себе. Более того, эти два ресурса образуют симбиотическую связь: База знаний и техническая документация взаимосвязаны и дополняют друг друга, помогая вам получить нужную информацию.

База знаний — это удобная точка самообслуживания, содержимое которой курируется сотрудниками службы поддержки Altium — людьми, обладающими экспертными знаниями о решениях Altium. Этот контент формируется непосредственно на основе проблем, с которыми сталкивались другие пользователи. В результате получается органично развивающееся хранилище статей, предлагающих точечные ответы и решения по конкретным темам и нестандартным случаям. Точные, короткие статьи, которые помогут вам быстро вернуться к работе.

Интерфейс Базы знаний предельно прост. Вы можете искать по всем статьям сразу или ограничить поиск статьями в одной из поддерживаемых категорий проектных решений. Затем просто начните вводить поисковый запрос — фильтрация будет применяться по мере ввода. Когда найдете интересующую статью, нажмите на ее запись, чтобы открыть ее.

Авторские права на документацию

Информация об авторских правах, относящаяся к технической документации, удобно представлена на изображении ниже, а также доступна в разделе QuickLinks панели Nav Tree (Информация об авторских правах на документацию), которая доступна при просмотре любой страницы технической документации. Страница содержит ссылку на страницу Copyrights & Trademarks основного сайта altium.com.

Напоследок цитата...

Это в полной мере отражает принцип, которым руководствуется команда технической документации и который она стремится воплощать в своей работе. В дальнейшем техническая документация будет продолжать развиваться, особенно с точки зрения удобства использования. В конце концов, даже изобилие информации полезно только в том случае, если наши пользователи могут ее найти. По мере появления новых разработок, улучшений и функций эта страница будет обновляться, чтобы отражать и выделять эти дополнительные элементы, а также показывать, как лучше всего использовать их для получения нужной вам информации.