Поделиться через

Настройка или перенаправление руководства по процессу

  • Статья

 

С помощью руководства по процессу команда может зафиксировать порядок координации при работе над командным проектом, правила использования типов рабочих элементов (WIT) и процедуры работы с отчетами, используемые на протяжении всего жизненного цикла проекта. В библиотеке MSDN имеется универсальное руководство по процессу, включающее артефакты шаблонов процессов Scrum, Agile и CMMI. Вы можете изменить свое руководство по процессу и задать ссылки, перенаправляющие на соответствующие разделы пользовательского руководства при вызове справки с помощью клавиши F1.

Если командный проект создан на основе базовой конфигурации или размещен в Visual Studio Online, ни портал проекта, ни руководство по процессу в нем не включены. Это означает, что ссылки, которые перенаправляют на справку F1 из формы рабочего элемента, недоступны.

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

  • Проверка наличия руководства по процессу для командного проекта

    Выберите этот вариант, чтобы определить наличие руководства по процессу.

  • Указание веб-сайта, на котором размещается пользовательское руководство по процессу

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

  • Указание библиотеки документов SharePoint, содержащей руководство по процессу

    Выберите этот вариант, если сервер TFS для интеграции с веб-приложением SharePoint уже настроен, а ссылки на справку F1 в формах рабочих элементов должны указывать на содержимое руководства по процессу. Кроме того, этот вариант следует выбирать в тех случаях, когда руководство по процессу должно совместно использоваться в нескольких командных проектах в пределах одной организации.

  • Отправка вспомогательных файлов руководства по процессу из шаблона процесса

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

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

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

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

  1. В Visual Studio или Team Explorer подключитесь к командному проекту.

  2. Откройте параметры портала.

    Откройте страницу параметров портала из Team Explorer

  3. Откройте вкладку "Руководство по процессу". Если флажок Включить ссылку на руководство по процессу не установлен, руководство по процессу не включено.

    Руководство по процессам не включено

    Если руководство по процессу не включено, ссылки на справку F1 в формах рабочих элементов не будут открывать содержимое справки.

Указание веб-сайта для руководства по процессу

Выберите этот параметр, если продукты SharePoint не используются или если командный проект размещен в Visual Studio Online.

  1. Если пользователь не является членом группы администраторов командного проекта, добавьте его в эту группу.

  2. Откройте параметры портала и перейдите на вкладку "Руководство по процессу".

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

    Укажите веб-сайт руководства по процессам

  4. Чтобы ссылки на справку F1 указывали на содержимое на этом веб-сайте, отправьте и измените вспомогательные файлы.

Указание библиотеки документов SharePoint, содержащей руководство по процессу

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

  1. Если пользователь не является членом группы администраторов командного проекта, добавьте его в эту группу.

  2. Откройте параметры портала и перейдите на вкладку "Руководство по процессу".

  3. Установите флажок "Включить ссылку на руководство по процессу" и настройте URL-адрес.

  4. Введите URL-адрес библиотеки документов SharePoint, содержащей вспомогательные файлы или содержимое руководства по процессу.

    Укажите URL-адрес библиотеки документов SharePoint

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

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

  2. Отправьте содержимое папки Windows SharePoint Services/Process Guidance в библиотеку документов SharePoint, настроенную для хранения руководства по процессу.

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

    Папка Scrum Agile CMMI
    Process Guidance ProcessGuidance.html ProcessGuidance.html ProcessGuidance.html
    Process Guidance/Supporting Files Bug.htm

    CodeReviewRequest.htm

    CodeReviewResponse.htm

    Feature.htm

    FeedbackRequest.htm

    FeedbackResponse.htm

    Impediment.htm

    Impediment.htm

    ProductBacklogItem.htm

    SharedSteps.htm

    Task.htm

    TestCase.htm    		 AboutWorkItems.htm

    Bug.htm

    CodeReviewRequest.htm

    CodeReviewResponse.htm

    Feature.htm

    FeedbackRequest.htm

    FeedbackResponse.htm

    Issue.htm

    SharedSteps.htm

    Task.htm

    TestCase.htm

    UserStory.htm    		 AboutWorkItems.htm

    Bug.htm

    ChangeRequest

    CodeReviewRequest.htm

    CodeReviewResponse.htm

    Feature.htm

    FeedbackRequest.htm

    FeedbackResponse.htm

    Issue.htm

    Requirement.htm

    Review.htm

    Risk.htm

    SharedSteps.htm

    Task.htm

    TestCase.htm

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

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

При выборе значка руководства по процессу Руководство по открытию процесса для рабочего элемента выполняется поиск файла .aspx, .htm или .html. Эти файлы могут включать содержимое или предоставлять URL-адрес для перенаправления на это содержимое.

Эти файлы необходимо отправить в папку Supporting Files в библиотеке документов SharePoint, настроенную для хранения руководства по процессу командного проекта.

Отправка ASPX-страниц содержимого

  • Для каждого типа рабочего элемента, для которого требуется руководство по процессу, необходимо отправить на веб-сайт руководства по процессу ASPX-страницу содержимого, имя которой соответствует типу рабочего элемента.

    Имя файла .aspx должно совпадать со значением WORKITEMTYPE в определении типа. Например, если содержимое руководства по процессу относится к типу рабочего элемента "ошибка", определение типа которого содержит строку <WORKITEMTYPE name="Bug">, назовите файл Bug.aspx.

Изменение файла поддержки руководства по процессам

  1. В папке Process Guidance и ее подпапке Supporting Files откройте каждый из файлов .htm, загруженных на шаге 1 процедуры Отправка вспомогательных файлов руководства по процессу.

  2. В каждом файле найдите оператор meta, задающий URL-адрес. Например:

    <meta http-equiv="Refresh" content="0;URL=https://go.microsoft.com/fwlink/?LinkId=190653" />

  3. Замените значение URL-адреса на URL-адрес пользовательского руководства, хранящегося на настроенном веб-сайте руководства по процессу. Например:

    <meta http-equiv="Refresh" content="0;URL=http://YourPortal/Process Guidance/scrum/html/Bug.html" />

  4. Сохраните и закройте все файлы.

  5. Отправьте каждый файл на веб-сайт руководства по процессу.

    Эти файлы должны храниться в соответствующей папке, как указано в шаге 2 процедуры Отправка вспомогательных файлов руководства по процессу.

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

  1. В Visual Studio выберите Команда, Показать сайт отчетов.

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

  3. Откройте контекстное меню отчета и выберите Загрузить.

  4. Откройте файл в Visual Studio или в текстовом редакторе.

  5. Найдите в отчете оператор Hyperlink.

  6. Замените URL-адрес в этой инструкции на URL-адрес файла, содержащего пользовательское содержимое.

  7. Сохраните и закройте файл.

  8. Вернитесь к папке Report Manager отчета и выберите команду Отправить файл.

Вопросы и ответы

Как открывать руководство по процессу из рабочих элементов и отчетов?

О. Для рабочих элементов: в Командный обозреватель нажмите клавишу F1 или щелкните значок руководства по процессу Руководство по открытию процесса для рабочего элемента в открытом рабочем элементе.

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

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

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

В зависимости от параметров в веб-браузере будет открыта страница с содержимым MSDN или пользовательское руководство по процессу.

В. Можно ли встроить руководство по процессу в форму рабочего элемента?

Ответ. Да. Описание способа добавления текста или гиперссылки в форме рабочего элемента см. в разделе Элементы LabelText и Text.

Описание способа внедрения веб-страницы или HTML-содержимого в форме рабочего элемента см. в разделе WebpageControlOptions.