跳到主要内容

问题反馈排查指南

当你在使用微搭搭建应用时遇到问题,希望在论坛提问或者得到相关研发人员的帮助时,首先要简单明了地阐述问题,最好提供一个可重现问题的示例。

提问模版#

  • 问题描述:请清晰简洁地描述问题,和预期结果
  • 运行环境:
    • 编辑器内环境,例如预览区/编辑区/移动端/pc端/小程序端
    • 应用发布后运行平台,例如移动端/pc端/小程序端
    • 浏览器,例如谷歌、safari、企微内部访问等
    • 操作系统,例如 MacOS、Windows、安卓、ios等
  • 异常信息:
    • 通过截图或录屏提供相关的报错信息, 同时请把错误信息完整复制出来
    • 错误信息来源:控制台的错误日志、平台的错误提示、或其他。
  • 实时预览链接: 在微搭编辑器中,通过发布实时预览,生成实时预览链接。可选择首页或当前页。请把实时预览地址复制出来。

自助排查问题指南#

一个直接重现问题的示例,能帮助研发更快速, 更便捷地定位到问题所在,从而迅速响应解决。同时也能帮助你快速自查,排除自己使用方式导致的非预期结果。 如何构建一个简单的问题示例,可以参考下面的原则:

参考原则
  1. 完整 —— 拥有问题复现的必要代码和配置。
  2. 简单 —— 用最少的代码和组件复现问题场景,没有复杂的依赖性。
  3. 稳定复现 —— 拥有一个清晰的复现路径。

具体操作:

如何保证示例完整?#

  1. 对于不依赖数据源的问题场景,创建示例时,仅保留问题复现的必要代码
  • 变量绑定的实现
  • 代码编辑器里的编码内容(生命周期方法,自定义方法)
  • 右侧属性区的配置
  • 样式编写
  1. 对于依赖数据源的问题场景,创建示例后,可进一步核对下面的内容,给到产研侧。
  • 数据源的数据结构
  • 数据源的数据版本——正式/预览
  • 数据源的类型场景——自定义连接器/数据模型
  • 数据源的使用场景——表单容器/数据容器/新增/编辑等
  • 数据源相关操作的步骤描述

如何保证示例足够小?#

  1. 能准确判定问题的时候,新建一个自定义应用/模型应用,拖入存在问题的组件。提供最少的代码实现。例如存在变量绑定的场景,仅设置能支持该场景下复现问题的变量。
  2. 在不能准确定位到问题根本原因的时候,可以采用排除法。对照原来的实现,新建一个自定义应用/模型应用,然后逐步删减组件和代码实现,直到问题消失,再将最后一次的改动添加回来,以确定最小范围的复现场景。

如何保证问题稳定复现?#

  1. 排除与问题无关的其他干扰因素。 可以对照组件文档自查使用组件的方式和场景 。排除代码实现部分的单词拼写、样式编写、自定义组件实现等非平台实现导致的问题。
  2. 缩小问题范围。如果能提供一个清晰的复现路径,可以补充说明。例如问题仅出现在小程序端,或仅存在于应用发布后,或仅存在于编辑器内。