ReSpec User Study 插件使用说明
本插件用于 ReSpec user study。用户只需要准备一个可运行 ReSpec_feedback_v2 的 Python/conda 环境,并在 VS Code 插件设置中配置该环境的 python.exe 路径。
需要准备的环境
推荐使用 conda 创建独立环境,Python 版本建议使用 3.10:
conda create -n debugpilot-study python=3.10
conda activate debugpilot-study
pip install openai
实验使用的 ReSpec_feedback_v2 后端已经随插件放在本目录中。除了 Python 标准库和本地模块外,后端实际只需要额外安装 openai 包。用户侧不需要修改后端代码;如果实验组织者已经提供了预装依赖的环境,直接使用该环境的 Python 路径。
需要配置的插件内容
只需要配置 Python 解释器路径。
在 VS Code 中打开命令面板,执行:
ReSpec: Select Python Interpreter
选择 conda 环境中的 python.exe,例如:
E:\anaconda3\envs\debugpilot-study\python.exe
也可以在 VS Code Settings 中手动设置:
{
"debugPilotFeedback.pythonPath": "E:\\anaconda3\\envs\\debugpilot-study\\python.exe"
}
使用流程
- 用 VS Code 打开某个 user study case 目录。
- 在
Debugging Process 面板中点击 Import Process。
- 查看 ReSpec 的定位流程节点。
- 在允许 feedback 的节点中打开 details,并提交 specification feedback。
- 等待插件运行 feedback debugging,并刷新新的 process branch。
- 确认最终结果后,点击右上角
Submit。
记录内容
插件会在当前 case 的 study_data/user_study_interaction_log.json 中记录用户交互时间点,包括:
- 导入 process 的时间;
- 提交 feedback 的时间;
- 点击
Submit 确认结果的时间。
这些记录用于 user study 分析,不需要用户手动编辑。