Performing Design Reviews

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

Altium Designer предоставляет такую возможность в очень гибком виде с помощью процессов рецензирования Process Workflows, которые размещаются в подключенном Workspace и доступны непосредственно из Altium Designer.

► Дополнительные сведения о процессах и их рабочих потоках см. Creating & Managing Processes (Altium 365 Workpace, Enterprise Server Workspace).

Рабочие потоки процессов включают интерактивные формы, которые показываются пользователю по мере прохождения шагов потока и дают возможность оставлять комментарии, прикреплять файлы, просматривать проектную документацию и многое другое. Процессы рецензирования может запускать любой пользователь Altium Designer с доступом к проекту; затем они назначаются другим пользователям (участникам команды) или группам пользователей (ролям команды).

Со стороны Workspace администратор работает с процессами как с диаграммными потоками, где пользовательские формы и шаги, включенные в потоки, полностью настраиваемы. Это позволяет при необходимости создавать (и обеспечивать соблюдение) очень специфические процессы — например, ориентированные на принятые в компании требования к рецензированию. Можно создать любое количество процессов рабочих потоков.

► Дополнительные сведения см. Defining a Process Workflow (Altium 365 Workspace, Enterprise Server Workspace).

Процессы рецензирования

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

• Ad Hoc Review – Неформальный процесс рецензирования без фиксируемого итога.
• Handoff Review – Более формальный процесс рецензирования, в котором инициатор (отправитель) при закрытии рецензии фиксирует итог «пройдено/не пройдено» (Completed/Rejected). Статус Completed означает, что проект готов к передаче на следующий этап разработки.
• Milestone Review – Более сложный замкнутый процесс рецензирования, в котором отправитель использует обратную связь, чтобы решить, будет ли статус Completed, Rejected или проект следует исправить (Reworked). В последнем случае доработанный проект затем проверяется, и решение Completed/Rejected/Rework повторяется. Рецензия закрывается, когда цель или веха проекта успешно достигнута.

Во всех перечисленных случаях и отправитель/утверждающий (Initiator), и рецензенты (Assignees) проходят по потоку процесса с помощью последовательности форм пользовательского интерфейса. Требования и варианты на каждом шаге потока определяются соответствующей записью Process в Workspace, которой, в свою очередь, управляет администратор сервера — он также может как инициировать, так и отменять процесс рецензирования.

Проведение рецензирования

Рецензирование обычно состоит из трех последовательных этапов:

1. Пользователь, инициирующий рецензию (отправитель), определяет, что будет проверяться и кем, и добавляет любые данные или сведения, которые понадобятся.
2. Рецензенты получают доступ к данным проекта и предоставляют соответствующую обратную связь, а при необходимости добавляют релевантные данные или сведения.
3. Утверждающий рецензии (обычно инициатор) оценивает и суммирует обратную связь от рецензентов и завершает процесс.

Все этапы рецензирования представлены соответствующей задачей Task (Altium 365 Workspace, Enterprise Server Workspace) на панели Tasklist в программе, которая уведомляет каждого пользователя о необходимости действия и предоставляет информацию о выполненных задачах. Выбор ожидающей задачи Task активирует соответствующий этап рецензирования.

Инициация и определение рецензии

Процесс рецензирования запускается из меню Project » Project Activities в Altium Designer. Изначально рецензия будет применяться к текущему активному проекту.

Рассмотрим в качестве примера процесс Ad Hoc Review: в стандартном, неизмененном виде, начальная форма диалога позволяет отправителю (Barry в примере ниже) указать проект, который будет рецензироваться, и пользователей, которым назначается этап предоставления обратной связи.

Поля ввода и меню в диалоге Ad Hoc Review:

• Request title – режим AUTO по умолчанию использует имя процесса как основу для имени активного процесса (заголовка Activity). Вместо него можно ввести пользовательское имя.
• Project – имя проекта, который будет рецензироваться. Это активный проект на момент запуска процесса, но можно выбрать любой доступный проект из контекстного выпадающего списка.
• Description – текст для предоставления дополнительной информации рецензентам.
• Reviewers – указанные участники команды или группы ролей, которым будет назначена задача по предоставлению обратной связи. Начните ввод, чтобы увидеть доступные варианты.

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

Следующая форма диалога Prepare review data позволяет указать конкретные ресурсы проектных данных и добавить вложения. Обратите внимание: любой текст формы, выделенный синим, является активной ссылкой на соответствующие исходные данные. Диалог также включает описательную диаграмму потока процесса на вкладке Diagram, которая показывает и ваше текущее положение в шагах потока.

Ключевые параметры в форме диалога:

• Data – используйте выпадающее меню, чтобы выбрать конкретный набор данных релиза проекта (по дате), либо используйте связанную опцию , чтобы перейти к выбору и указать конкретный набор данных релиза. В состоянии по умолчанию, когда данные не выбраны, рецензент(ы) будут иметь доступ только к исходным данным проекта.
• Attachments – выберите файлы () или перетащите их мышью, чтобы добавить в качестве данных рецензирования или источников информации.

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

На этом этапе активная задача Prepare review data закрывается на панели Tasklist, поскольку этап отправки рецензии завершен — обратите внимание, что пользователь Altium Designer в этот момент является отправителем процесса рецензирования (Initiator). Текущий процесс рецензирования отображается в списке Activities панели со статусом «активен». Нажмите кнопку , чтобы убедиться, что вы видите актуальный статус Activities.

Чтобы просмотреть статус выполнения активного процесса рецензирования, выберите его запись в списке Activities, чтобы отобразить текущие данные и аннотированную диаграмму потока (вкладка Diagram).

Предоставление обратной связи по рецензии

После того как инициатор настроил и отправил процесс рецензирования, активность автоматически создаст задачи Tasks для пользователей, указанных как рецензенты. Когда рецензент (например, Norm Smith в этом примере) затем входит в Altium Designer, область Tasks покажет назначенную задачу Provide review feedback.

Выбор этой задачи Task активирует для рецензента этап Review в потоке процесса. Следующая форма диалога Provide review feedback предлагает соответствующие данные проекта (как указано отправителем рецензии), возможность добавить комментарии и вложения или открыть проект в Web Viewer (), а также требование отправить голос (Vote) с обратной связью.

Ключевые параметры в диалоге Provide Review feedback:

• Open Project – выберите, чтобы открыть проект в Workspace Web Viewer. Это предоставляет большой объем данных проекта и полностью отрисованные интерактивные представления исходных документов проекта, что позволяет добавлять выделенные комментарии и при необходимости назначать их конкретному пользователю (участнику Workspace).
  ► Дополнительные сведения см. на странице Web Viewer (Altium 365 Workspace, Enterprise Server Workspace).
• Comment – комментарии, добавленные здесь, будут привязаны к имени рецензента при финализации процесса рецензирования.
• Vote – выберите подходящее итоговое резюме заключения рецензии.
• Reviewers attachments – выберите файлы () или перетащите их мышью — например, более подробные заметки или справочные документы — которые будут включены в обратную связь по рецензии.

Обратите внимание: любой текст, выделенный синим, является активной ссылкой на соответствующие исходные данные. Нажмите кнопку , чтобы завершить этап рецензирования — это будет отражено на панели Tasklist, которая закроет (удалит) активную задачу.

Сводка и закрытие рецензии

Когда все указанные рецензенты завершат назначенные им задачи по предоставлению обратной связи, активный процесс Review переходит на этап сводки/закрытия. Создается задача Summarize review для пользователя, назначенного оценить активность рецензирования — в данном случае это Barry, тот же пользователь, который отправил (инициировал) рецензию. Обратите внимание: для этого пользователя процесс рецензирования отображается как активный на панели Tasklist в разделе Activities. Для рецензентов активность теперь закрыта, поскольку их задачи-вклады выполнены.

Выбор задачи Summarize review на панели Tasklist переведет поток рецензирования на его финальный этап, как показано в форме диалога Summarize review.

Заметные элементы в этой форме:

• Information provided by reviewers
  • Comment – список комментариев, оставленных рецензентами по завершении своих задач (Tasks) по проверке.
  • Vote – итоговая оценка/вердикт по проверке, выбранный каждым рецензентом.
  • Review attachments – любые связанные файлы, добавленные рецензентами в задачу (Task).
• Summary
  • Summary note – заключительные примечания, добавляемые оценщиком процесса проверки (в данном случае — отправителем/инициатором), которые будут зафиксированы при закрытии проверки.

Нажатие кнопки в этом диалоговом окне завершит активный процесс Design Review. Обратите внимание: в более продвинутых процессах Design Review, которые доступны, на этапе оценки предусмотрены дополнительные шаги — например, указание итога «завершено/отклонено» или инициирование задачи на доработку (design Rework).

Чтобы просмотреть завершённый Design Review, обновите записи Activities на панели Tasklist (), включите параметр Show Closed в меню и выберите закрытую задачу из списка. Следующее диалоговое окно содержит сводку информации по проверке (на вкладке Data) и диаграмму потока процесса (вкладка Diagram) с подсвеченным состоянием прогресса — это Completed, как и ожидается.

Пользовательские процессы проверки

Процессы Design Review, в том виде, в каком они в итоге представлены пользователю в Altium Designer, разрабатываются и редактируются в подключённом Workspace назначенным администратором. Гибкость элементов шагов потока и UI-форм, которые вместе образуют рабочий процесс Design Review, позволяет создавать проверки, удовлетворяющие широкому спектру конкретных потребностей.

Некоторые дополнительные параметры, которые можно применить к шагам и формам:

• назначение любого шага в потоке конкретному пользователю или роли, отличным от тех, кто назначен рецензентами или оценщиком.
• запрет пользователю или роли доступа к конкретному шагу рабочего процесса (an Exception), чтобы для них он был пропущен в потоке.
• принудительное требование обязательного заполнения поля формы перед отправкой диалогового окна формы.
• добавление промежуточных шагов рабочего процесса, которые накладывают дополнительные задачи и пользовательские формы.
• формирование цикла принятия решения в рабочем процессе, где только определённое действие замкнёт (закроет) этот цикл.
• отображение или скрытие определённых данных либо сообщений о событиях/ошибках в UI-форме шага рабочего процесса.
• использование функции Web Viewer в Workspace, чтобы позволить рецензентам, не имеющим прямого доступа к исходным документам проекта, просматривать проектную документацию и оставлять комментарии.

Как отмечалось ранее, можно создать любое количество процессов проверки и сделать их доступными в Altium Designer; при этом их можно разрабатывать для уровней проверки — от неформального сбора отзывов от коллег до утверждённых компанией формальных процессов проверки, которые передают данные в другие корпоративные системы (например, PLM).

► Подробную информацию о создании пользовательских процессов см. в разделе Defining a Process Workflow (Altium 365 Workspace, Enterprise Server Workspace).