Комментирование

Requirements Portal поддерживает комментирование в проектах требований. Комментарий — это добавленная пользователем заметка, привязанная к определенному требованию, на которую другие пользователи могут отвечать. Комментарии способствуют совместной работе пользователей, не изменяя сами общие данные, поскольку комментарии хранятся Workspace независимо от этих данных. В комментарии можно упомянуть одного или нескольких людей либо групп. Комментарий также можно назначить участнику Workspace.

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

Размещение комментария

В режим размещения комментария можно перейти одним из следующих способов:

  • Нажмите кнопку в верхней части панели Comments and Tasks, а затем используйте появившийся курсор размещения (), чтобы выбрать строку требования для комментирования.

  • Нажмите кнопку  в строке требования и выберите команду Comment в появившемся меню.

В обоих случаях откроется окно комментирования, в котором можно задать комментарий в контексте выбранного требования. Введите комментарий в предусмотренное поле. В комментарии можно упомянуть одного или нескольких людей либо групп. Введите символ @ в поле комментария, чтобы быстро получить доступ к списку участников Workspace. Комментарий также можно назначить участнику. Дополнительные сведения об этих возможностях см. в разделе Работа с контекстным окном комментирования.

После ввода комментария, добавления упоминаний и, при необходимости, назначения нажмите расположенную ниже кнопку . Комментарий будет сохранен и появится как в контекстном окне комментирования, так и на панели Comments and Tasks. В столбце Identifier для требования с комментарием будет показан маркер комментария ().

До публикации в любой момент можно выйти из режима размещения комментария, нажав Esc.

К одному требованию можно добавить любое количество комментариев. Число рядом с маркером комментария в столбце Identifier отражает количество комментариев, добавленных к требованию.

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

Откройте или закройте панель Comments and Tasks с помощью значка .

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

Введите текст комментария в окне комментирования, при необходимости добавив упоминание пользователя. Введите символ @, чтобы получить доступ к списку участников и групп Workspace для выбора ссылок упоминания.

Установите параметр Assign a task, чтобы создать задачу (запрос на работу) для упомянутого пользователя или другого пользователя, выбранного из связанного раскрывающегося списка.

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

Запись комментария будет добавлена на панель Comments and Tasks. Окно комментирования, которое можно открыть в любой момент, позволяет добавлять последующие комментарии, упоминания и назначения, а также изменять статус задачи. В столбце Identifier прокомментированного требования будет показан маркер комментария .

 

Работа с контекстным окном комментирования

Следующие пункты относятся к работе с комментариями и контекстным окном комментирования интерфейса:

  • К окну комментирования можно получить доступ, щелкнув запись комментария на панели Comments and Tasks.

  • Окно можно свободно перемещать, щелкая и перетаскивая его верхнюю панель.

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

    Для перехода к предыдущим и следующим комментариям соответственно можно также использовать Shift+Left Arrow и Shift+Right Arrow.

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

  • В комментарии можно упомянуть человека или группу. Введите символ @, чтобы открыть всплывающий список всех участников команды Workspace. Либо начните поиск группы или человека (для человека — по имени или адресу электронной почты), введя @ и один или несколько символов — будет показан список подходящих групп, участников команды и людей вне команды (но внутри вашей организации), из которого можно выбрать нужный вариант. Можно либо щелкнуть по записи, чтобы добавить ее, либо использовать клавиши Up Arrow / Down Arrow и нажать Enter , чтобы добавить.

    Упомянутый человек, который является либо участником команды, либо участником упомянутой группы, получит уведомление о комментарии по электронной почте.

    В комментарии можно упомянуть любого человека или группу. Введите символ @, чтобы открыть список всех участников и групп Workspace.

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

    При ответе на комментарий вы также можете назначить задачу новому упомянутому пользователю.

    Нужный человек, люди или группы появятся в тексте комментария как упоминания (по имени, где это возможно).

     
  • Вы можете назначить задачу человеку, который был упомянут. Для этого включите параметр Assign a Task to — по умолчанию будет выбран первый упомянутый человек, а если упоминаний нет, то вы сами (Me). Либо используйте раскрывающееся меню, чтобы выбрать другого участника Workspace, которому следует назначить задачу. Назначенный человек отображается в записи панели Comments and Tasks в виде изображения профиля пользователя/буквы, вместе со связанной ссылкой на задачу. Назначение задачи можно изменить или удалить при редактировании комментария.

    Если с комментарием связана задача, в верхней границе ее окна отображаются:

    • значок (изображение/буква), указывающий участника, которому назначена задача комментария. Выберите значок, чтобы переназначить задачу другому участнику Workspace из раскрывающегося списка.

    • буквенно-цифровая ссылка задачи, состоящая из идентификатора требования с суффиксом номера задачи. Щелкните по ссылке, чтобы выполнить переход к записи этой задачи на странице Tasks page Workspace.

      На странице Workspace Tasks также можно просматривать и изменять приоритет задачи (Medium по умолчанию).

    • текущий статус активности задачи (To Do, In Progress, Resolved), который можно изменить в связанном раскрывающемся меню ().

  • Задачу можно добавить к существующему комментарию с помощью параметра Convert to Task, доступного в меню  окна. Изначально новая задача назначается вам и может быть переназначена другому участнику Workspace путем выбора его записи из раскрывающегося списка, открываемого из аватара исполнителя (вверху слева).

  • Окно комментирования также принимает файл изображения или снимок экрана, вставленный из буфера обмена Windows. Снимок экрана (или скопированный файл изображения) можно вставить в поле комментария до или после любых текстовых заметок и упоминаний пользователей. Графика изображения отображается в теле окна комментирования — щелкните по изображению, чтобы открыть его для просмотра в полном размере. Запись размещенного комментария на панели Comment and Tasks будет содержать соответствующую пометку includes images.

  • Комментарий можно редактировать или удалять только через окно комментирования, используя команды Edit и Delete соответственно. Они доступны из меню, связанного с элементом управления . Обратите внимание, что эти команды доступны только для комментария, который создали вы сами — вы не можете редактировать или удалять комментарий, созданный другим пользователем. Если вы редактируете существующий комментарий, внесите изменения, затем нажмите кнопку  для сохранения. Чтобы выйти без применения изменений, нажмите Esc.

    Если вы удаляете комментарий, имейте в виду, что все связанные ответы также будут удалены.

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

  • Комментарий можно перевести в состояние resolved (или снова сделать активным), переключив элемент управления в верхней части окна комментирования. Если для комментария есть assigned task, его текущий статус можно изменить на Resolved (или другой уровень) в раскрывающемся меню статуса. Комментарии со статусом resolved по умолчанию не отображаются на панели Comments and Tasks, однако их можно показать с помощью опции отображения/скрытия pins — подробнее см. в следующем разделе.

Работа с панелью Comments

Следующие пункты относятся к работе с комментариями и панелью интерфейса Comments and Tasks:

  • Панель Comments and Tasks служит средством обзора/навигации по комментариям в рамках проекта, а не рабочим интерфейсом для публикации, редактирования и ответов. Эта функциональность полностью реализована только в контекстном окне комментирования.

  • Панель Comments and Tasks также можно открыть, щелкнув маркер комментария в основной области просмотра. При этом также откроется контекстное окно комментирования.

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

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

    Параметры фильтра панели ограничивают записи комментариев следующим:

    • Tasks only – только теми комментариями, которым назначены user Tasks, которые, в свою очередь, доступны в потоке Tasks page.

    • Assigned to – только комментариями, назначенными пользователям, выбранным в списке ниже. Когда установлен флажок пользователя, на панели (и в отображаемом документе) будут показаны только те комментарии, у которых есть задачи, назначенные этому пользователю. Обратите внимание, что текущий вошедший в систему пользователь включается в верхнюю часть списка независимо от каких-либо назначений задач комментариев.

    Второй уровень фильтрации, который применяется совместно с основным методом фильтрации, предлагает два параметра, позволяющих скрыть все комментарии или задачи со статусом resolved (если включен Unresolved only) и/или показывать комментарии только для текущего выбранного контекста (то есть папки, спецификации или раздела), а не для всего проекта (если включен Current context only ).

  • Щелкните запись Notification Settings (в нижней части приведенного выше окна параметров), чтобы открыть окно, в котором можно настроить, для каких комментариев в проекте вы будете получать уведомления по электронной почте. Можно выбрать получение уведомлений для всех веток комментариев, ни для одной ветки или только для тех, в которых вы участвуете (которые вы создали, на которые ответили или в которых вас упомянули).

  • Что касается порядка веток комментариев на панели, здесь также есть два уровня. Во-первых, комментарии упорядочиваются по спецификациям, в которых они находятся, и этот порядок соответствует структуре Requirements в дереве проекта слева. Во-вторых, для каждого требования комментарии сортируются по дате их создания — в порядке убывания.

  • Когда вы щелкаете запись ветки комментариев на панели, этот комментарий открывается в контекстном окне комментирования. Запись этого комментария на панели Comments and Tasks также выделяется синим цветом. Если щелкнуть комментарий, который находится не в просматриваемой в данный момент спецификации, произойдет переход к соответствующей спецификации.

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

AI-LocalizedЛокализовано с помощью ИИ
Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.
Доступность функциональных возможностей

Набор доступных функциональных возможностей зависит от вашего решения Altium – Altium Develop, редакция Altium Agile (Agile Teams или Agile Enterprise) или Altium Designer (на активной подписке).

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

Content