Office 加载项开发最佳做法

出色的外接程序提供独特且引人注目的功能,以具有视觉吸引力的方式扩展 Office 应用。 若要成功生成加载项,需要创建引人入胜的首次用户体验、设计精美的 UI 并优化性能。 遵循本文中的最佳做法,帮助用户快速高效地完成任务。

注意

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

提供明确值

生成可帮助用户快速高效地完成任务的加载项。 关注适用于 Office 应用的方案,例如:

  • 使核心创作任务更快、更轻松,中断更少。
  • 在 Office 内启用新方案。
  • 在 Office 应用中嵌入补充服务。
  • 改善 Office 体验来提高工作效率。

通过 创建引人入胜的首次运行体验,确保用户立即了解加载项的价值。

准备好推广外接程序时,请了解如何创建 有效的Microsoft市场一览

  • 在标题和说明中明确加载项的优点。 不要仅依赖你的品牌来传达加载项的功能。
  • 确保加载项提供足够的价值来证明用户投资的合理性。 它不应只是一个简单的实用工具或具有有限的范围。
  • 如果你的外接程序面向较大的组织和企业,则有几个Microsoft市场要求不同于常规商业市场外接程序的要求。 有关详细信息,请参阅 提交常见问题解答

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

从应用商店下载加载项后,新用户仍在决定是使用还是放弃加载项。 下面介绍如何赢得他们。

  • 明确后续步骤。 使用视频、位置图、分页面板或其他资源引导用户完成加载项。

  • 具有价值(而非注册)的潜在客户。 在加载项启动时加强其价值主张,而不是立即要求用户登录。

  • 提供有用的指导。 包括教学 UI,以指导用户并使体验个性化。

    有关如何指导用户使用 UI 的“执行”与“不”比较。“Do”示例显示了一个加载项,其中包含用户可以单击以开始使用的按钮。“请勿”示例显示没有介绍性步骤或按钮的加载项。

  • 向用户显示预期内容。 如果内容加载项绑定到用户文档中的数据,请包含示例数据或模板,向用户显示预期的数据格式。

    “Do”与“Don't”比较,包括用于在外接程序中插入示例数据的选项。“Do”示例显示了一个加载项,其中包含用户可以单击以插入示例数据的按钮。“请勿”示例显示没有示例数据或按钮的加载项。

  • 提供 免费试用版。 如果外接程序需要订阅,请使某些功能在没有订阅的情况下可用。

  • 简化注册。 预填充电子邮件和显示名称等信息,并尽可能跳过电子邮件验证。

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

有关在开发首次运行体验时可以应用的模式,请参阅 Office 外接程序的 UX 设计模式

使用加载项命令

使用加载项命令,为加载项提供相关 UI 入口点。 这些命令可帮助用户直接从 Office 功能区发现和访问加载项的功能。 有关详细信息和设计最佳做法,请参阅 外接程序命令

应用用户体验设计原则

遵循以下关键原则,创建与 Office 原生相关的加载项:

  • 匹配 Office 体验。 确保加载项的外观和功能是对 Office 体验的补充。 请参阅 设计 Office 加载项的 UI

  • 优先处理内容,而优先于版式。 避免不必要的 UI 元素,这些元素不会为用户体验增加价值。

  • 保持用户处于可控状态。 确保用户了解重要决策,并可以轻松撤消加载项执行的作。

  • 深思熟虑地使用品牌。 激发信任并帮助定位用户,但不要压倒他们或向他们做广告。

  • 最小化滚动。 优化为 1366 x 768 分辨率。

  • 仅使用许可映像。 避免来自未经许可的图像的法律和品牌问题。

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

  • 辅助功能设计。 使加载项易于所有用户与屏幕阅读器等辅助技术进行交互和适应。 请参阅我们的 辅助功能指南

  • 支持所有平台和输入方法。 针对鼠标/键盘和 触摸进行设计。 确保 UI 能够很好地响应不同的外形规格。

触摸优化

触摸支持对于新式 Office 加载项至关重要。

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

    注意

    Outlook 不支持此属性。

  • 适当地调整大小控件。 确保所有控件都能很好地与触摸交互配合使用。 例如,按钮需要足够的触摸目标,并且输入框应足够大,以便用户能够轻松输入文本。

  • 不要依赖悬停或右键单击。 这些输入方法在触摸设备上不可用。

  • 支持这两个方向。 确保加载项在纵向模式和横向模式下均有效。 请记住,在触摸设备上,软键盘可能会隐藏加载项的一部分。

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

优化和监视加载项性能

性能直接影响用户满意度。 请遵循以下指南,使加载项保持快速响应:

  • 旨在快速加载。 加载项应在 500 毫秒或更短时间内加载,以创建快速 UI 响应的感知。

  • 快速响应交互。 所有用户交互应在一秒内做出响应。

  • 显示长时间作的进度。 为需要时间的作提供加载指示器。

  • 使用 CDN。 在内容分发网络上托管映像、资源和公共库 (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 方法

发布和推销加载项

准备好与全世界共享加载项了吗? 下面是入门方法。

  • 创建合作伙伴中心帐户。 此过程可能需要一段时间,因此,如果计划发布到Microsoft市场,请尽早开始。 请参阅 合作伙伴中心帐户

  • 创建有效的Microsoft市场列表。 请按照以下提示作:

    • 使用简洁的描述性标题 (128 个字符或更少) 。
    • 编写简短而引人注目的说明,回答“此加载项解决了什么问题?”
    • 在标题和说明中清楚地传达加载项的价值主张。 不要只依赖你的品牌。

    详细了解如何 创建有效的Microsoft市场一览

  • 发布到Microsoft市场。 按照Microsoft市场 预发布清单提交指南进行作。 请确保:

    • 在所有支持的作系统、浏览器和设备上全面测试加载项。
    • 为认证审阅者提供详细的测试说明和资源。
  • 创建网站。 帮助用户在 Microsoft 市场外部发现加载项。

  • 从网站推广加载项。 了解如何 推广加载项

重要

如果你的外接程序面向较大的组织和企业,则有几个Microsoft市场要求不同于常规商业市场外接程序的要求。 有关详细信息,请参阅 提交常见问题解答

请参阅 支持较旧的Microsoft Web 视图和 Office 版本

另请参阅