Рекомендации по разработке надстроек Office

Статья
05/20/2023

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

Примечание.

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

Преимущества должны быть очевидными

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

Удобство работы с первого запуска

Привлекайте новых пользователей удобным и интуитивно понятным интерфейсом. Помните, что пользователи все еще решают, использовать вашу надстройку или забросить ее после загрузки из магазина.
Make the steps that the user needs to take to engage with your add-in clear. Use videos, placemats, paging panels, or other resources to entice users.
Если пользователям необходимо войти, чтобы использовать надстройку, следует донести до них ценность этой надстройки уже при ее запуске, а не просто просить их выполнить вход.
Разработайте обучающий интерфейс, чтобы помочь пользователям и персонализировать среду.
Если ваша контентная надстройка привязывается к данным в документе, включите пример данных или шаблон, чтобы показать пользователям рекомендуемый формат данных.
Предлагайте бесплатные пробные версии. Если для вашей надстройки требуется подписка, сделайте некоторые функции доступными без нее.
Упростите процесс регистрации. Предварительно укажите сведения, такие как адрес электронной почты и отображаемое имя, а также пропустить проверки электронной почты.
Избегайте всплывающих окон. Если вам нужно использовать их, направьте пользователя на включение всплывающего окна.

Шаблоны, которые можно применять при разработке для первого запуска, представлены в статье Конструктивные шаблоны для надстроек Office.

Команды надстроек

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

Принципы оформления элементов пользовательского интерфейса

Убедитесь, что внешний вид и поведение вашей надстройки согласованы с интерфейсом Office. См . раздел Проектирование пользовательского интерфейса надстроек Office.
Больше содержимого, меньше хрома. Избегайте лишних элементов интерфейса, которые не представляют ценности для пользователя.
Пользователь должен быть главным. Убедитесь, что пользователи понимают важные решения и могут с легкостью отменять действия, выполняемые надстройкой.
Используйте фирменную символику как повод для доверия и ориентир. Она не должна слишком бросаться в глаза или служить рекламой.
Избегайте прокрутки. Оптимизируйте надстройку для разрешения 1366 x 768.
Не включайте нелицензированные изображения.
Используйте понятный и простой язык в надстройке.
Учитывайте специальные возможности. Обеспечьте удобство работы для всех пользователей и поддержку таких специальных возможностей, как средство чтения с экрана.
Обеспечьте поддержку всех платформ и методов ввода, включая мышь, клавиатуру и сенсорное управление. Убедитесь, что ваш пользовательский интерфейс поддерживает различные форм-факторы.

Оптимизация для сенсорного управления

Используйте свойство Context.touchEnabled , чтобы определить, включено ли сенсорное приложение Office, в котором выполняется надстройка.

Примечание.

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

Примечание.

Если вы используете React пользовательского интерфейса Fluent для элементов дизайна, многие из этих элементов встроены в систему проектирования.

Оптимизация и отслеживание производительности приложения

Создайте ощущение быстрой реакции пользовательского интерфейса. Надстройка должна загружаться за 500 мс или меньше.
Убедитесь, что все команды пользователя выполняются менее, чем за одну секунду.
Добавьте индикаторы загрузки для продолжительных операций.
Используйте сеть доставки содержимого (CDN) для размещения образов, ресурсов и общих библиотек. Загружайте как можно больше компонентов из одного источника.
Соблюдайте стандартные методики для оптимизации веб-страницы. В производственной версии используйте только компактные версии библиотек. Загружайте только необходимые ресурсы и оптимизируйте их загрузку.

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

Класс взаимодействия	Target	Верхняя граница	Человеческое восприятие
Мгновенно	<=50 мс	100 мс	Без заметной задержки.
Быстро	50–100 мс	200 мс	Минимально заметная задержка. Нет необходимости в информативном сопровождении.
Нормальное	100–300 мс	500 мс	Достаточная скорость, но не более того. Нет необходимости в информативном сопровождении.
Оперативно	300–500 мс	1 секунда	Не быстро, но надстройка реагирует хорошо. Нет необходимости в информативном сопровождении.
Продолжительно	>500 мс	5 секунд	Среднее время ожидания, надстройка реагирует не так хорошо. Может потребоваться информативное сопровождение.
Длительно	>500 мс	10 секунд	Длительная задержка, но не настолько, чтобы пользователь занялся чем-то другим. Может потребоваться информативное сопровождение.
Долго	>500 мс	>10 секунд	Длительная задержка, при которой пользователь может заняться чем-то другим. Может потребоваться информативное сопровождение.
Слишком долго	>5 секунд	>1 минута	Пользователи наверняка будут заниматься чем-то другим.

Отслеживайте работоспособность службы и используйте телеметрию для отслеживания успешной работы пользователя.
Сведите к минимуму обмен данными между надстройкой и документом Office. Дополнительные сведения см. в статье Предотвращение использования метода context.sync в циклах.

Маркетинг

Опубликуйте надстройку в AppSource и рекламируйте ее на своем веб-сайте. Создайте эффективное описание для AppSource.
Давайте надстройкам лаконичные и информативные названия. Их длина не должна превышать 128 символов.
Составьте краткие и привлекательные описания надстройки. Дайте ответ на вопрос "Какую проблему решает эта надстройка?"
Опишите преимущества надстройки в названии и описании. Не полагайтесь на свою торговую марку.
Создайте веб-сайт, который поможет пользователям найти и использовать вашу надстройку.

Поддержка старых веб-представлений Майкрософт и версий Office (рекомендуется, но не обязательно)

См. раздел Поддержка старых веб-представлений Майкрософт и версий Office.