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

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

Документация

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

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

Итак, как же создать учетный и справочный ресурс, который позволит проектировщику выполнить всё это? Документирование программного обеспечения – это достаточно сложная задача. Это единый процесс, но, тем не менее, большая часть объема знаний должна пересекаться с другими аспектами, чтобы донести полную картину. Мы используем несколько процессов, которые позволяют обеспечить, полноту, доступность и, самое главное, правильность документации на наше программное обеспечение.

Содержимое

Главной страницей документацией является www.altium.com/documentation/ru. Отсюда вы можете перейти в различные разделы документации Altium.

Главная страница открывает доступ к различным разделам документации.

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

Страницы более высокого уровня содержимого предлагают более подробный обзор процессов и функций, с примерами и пошаговыми инструкциями.

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

Нужная информация

Altium использует систему версионности для документации, чтобы обеспечить соответствие просматриваемой документации и версии ПО, которую вы используете.

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

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

Доступ на любом устройстве

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

Как же обеспечить работу документации на всех этих устройствах? Правильный способ решения этой задачи – использовать так называемый адаптивный веб-дизайн. Адаптивные сайты связываются с целевым устройством, подстраивая структуру и размер своего содержимого в соответствии этим устройством, его разрешением экрана и размером браузера. Вы можете попробовать изменить размер своего браузера и увидеть, что при уменьшении его ширины элементы перестраиваются, а шрифты и изображения уменьшаются. Сайт работает даже на 5-дюймовых экранах – например, дерево навигации доступно на планшете или смартфоне в виде выпадающего списка.

Благодаря адаптивному дизайну документация доступна на всех типах устройств.

Поиск ответа

Итак, вы открыли сайт, и вам доступно более 2700 страниц документации. Теперь перед вами стоит задача, возникающая при работе с любым онлайн-контентом – как легко найти то, что вам необходимо?

Для этого есть три способа: нажать F1 при работе с командой/панелью/диалоговым окном/объектом и т.д. в ПО, перейти на нужную страницу или воспользоваться поиском.

Переход на нужную страницу

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

В дереве навигации вы найдете документация верхнего уровня в верхней части и справочники – в нижней. Подробная информация по проектированию в решениях Altium находится в разделе Изучение Altium Designer.

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

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

Используйте область Содержание для изучения разделов страницы.

Поиск

Многие предпочитают использовать поиск. Для поиска воспользуйтесь иконкой лупы в левом поле страницы.

Поиск отображает результаты на новой странице.

Замыкание петли

Даже писатели могут ошибаться, и мы надеемся, что наши читатели помогут нам в исправлении этих ошибок. Существует механизм обратной связи, который можно запустить с любой страницы для отправки электронного сообщения непосредственно в отдел документации. Нажмите сочетание Ctrl+Enter, чтобы открыть диалоговое окно Сообщить о проблеме в документации. Если вы хотите обратить внимание на определенную часть страницы, выделите его (максимум 200 символов) перед тем, как нажать Ctrl+Enter. Нажмите Отправить, чтобы отправить сообщение отделу документации. Ваш отзыв важен и ценен для нас.

Вы можете легко отправить отзыв непосредственно техническим писателям.

Другие языки

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