Office 加载项开发最佳做法

有效的外接程序提供独特且极具吸引力的功能，采用具有视觉吸引力的方式扩展 Office 应用程序。 若要创建出色的外接程序，需为用户提供极具吸引力的首次使用体验、设计一流的 UI 体验和优化外接程序的性能。 将本文中描述的最佳实践应用于创建有助于您的用户快速有效地完成其任务的外接程序。

注意

如果你计划将加载项发布到 AppSource，并使其在 Office 体验中可用，请确保你遵守商业市场认证政策。 例如，加载项必须适用于支持你定义的方法的所有平台，才能通过验证（有关详细信息，请参阅第 1120.3 部分以及 Office 加载项应用程序和可用性页）。

提供明确值

• 创建可帮助用户快速、高效地完成任务的外接程序。 专注于对 Office 应用程序有用的方案。 例如：
  • 使核心创作任务更快、更简单，且中断更少。
  • 在 Office 内启用新方案。
  • 在 Office 应用程序中嵌入补充服务。
  • 改善 Office 体验来提高工作效率。
• 通过 创建引人入胜的首次运行体验，确保加载项的价值立即对用户清晰可见。
• 创建有效的 AppSource 一览。 在标题和说明中明确介绍加载项的优势。 不要依赖于您的品牌来传达您的外接程序的功能。

创建极具吸引力的首次运行体验

• 要用具有高可用性和直观性的首次体验吸引新用户。 请注意，用户从商店下载外接程序之后，仍可决定是使用还是放弃该外接程序。

• 明确用户与您的外接程序交互所需执行的步骤。 使用视频、泡沫垫、分页面板或其他资源来吸引用户。

• 在启动时强调您的外接程序的价值主张，而不只是让用户登录。

• 提供用以指导用户的教学 UI，并使您的 UI 富有个性化。

  

• 如果内容外接程序绑定到用户文档中的数据，请将那些用于向用户显示要使用的数据格式的示例数据或模板包含在内。

  

• 提供 免费试用版。 如果外接程序需要订阅，那么让某些功能在不订阅的情况下也可使用。

• 简化注册体验。 预填充信息（如电子邮件和显示名称），并跳过电子邮件验证。

• 避免弹出窗口。 如果必须使用它们，请引导用户启用弹出窗口。

如需你在开发首次运行体验时可应用的模式，请参阅适用于 Office 加载项的 UX 设计模式。

使用加载项命令

• 使用加载项命令，为加载项提供相关 UI 入口点。 有关详细信息（包括设计最佳做法），请参阅加载项命令。

应用用户体验设计原则

• 确保你的外接程序的外观和功能很好地补充了 Office 体验。 请参阅 设计 Office 加载项的 UI。

• 支持内容胜过支持部件版式。 避免使用对用户体验毫无价值的不必要的 UI 元素。

• 保持用户处于可控状态。 确保用户了解重要的决定，并且可以轻松地倒退外接程序执行的操作。

• 使用品牌唤起用户的信任感和亲切感。 但不要过度使用品牌或向用户做广告推销。

• 避免滚动。 优化为 1366 x 768 分辨率。

• 不要包含未经许可的图像。

• 在加载项中使用简单明确的语言。

• 考虑辅助功能 - 方便所有用户都可以与加载项轻松交互，并提供屏幕阅读器等辅助技术。

• 针对所有平台和输入方法（包括鼠标/键盘和 触摸）的设计。 确保您的 UI 可响应不同的外观设置。

触摸优化

• 使用 Context.touchEnabled 属性检测运行加载项的 Office 应用程序是否已启用触摸。

  注意

  Outlook 不支持此属性。

• 确保所有控件都相应符合触控交互的尺寸大小。 例如，按钮有足够大的触摸目标，且输入框要足够大，方便用户输入。

• 不要依赖于非触摸输入方法，例如悬停或右键单击。

• 确保外接程序可以在纵向和横向模式中正常工作。 请注意在触控设备上，外接程序的一部分可能通过软键盘隐藏。

• 使用旁加载在实际设备上测试加载项。

注意

如果对设计元素使用 Fluent UI React，则其中许多元素都内置于设计系统中。

优化和监视加载项性能

• 创建快速 UI 响应的感觉。 外接程序的加载时间应在 500 毫秒以内。

• 确保所有用户交互响应时长都在一秒内。

• 为长时间运行的操作提供加载指示器。

• 使用内容分发网络 (CDN) 来托管映像、资源和公共库。 尽可能地从一个位置进行加载。

• 请按照标准 Web 实践来优化您的网页。 在生产中，仅使用库的缩小版本。 仅加载所需的资源，并优化加载资源的方式。

• 如果操作需要执行时间，请为用户提供反馈。 请注意下表中列出的阈值。 有关详细信息，请参阅 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 个字符。

• 编写加载项的简短且引人注目的说明。 回答“此加载项解决什么问题？”的问题。

• 在您的标题和说明中传达外接程序的价值主张。 不要依赖于您的品牌。

• 创建有助于用户查找和使用加载项的网站。

支持较旧的 Microsoft Webview 和 Office 版本 (建议但不需要)

请参阅 支持较旧的 Microsoft Webview 和 Office 版本。

另请参阅

• Office 加载项平台概述
• 了解 Microsoft 365 开发人员计划