# 智流录制器 - AI 操作说明书生成工具-SmartFlowRecorder

**Repository Path**: vipfhl/SFR

## Basic Information

- **Project Name**: 智流录制器 - AI 操作说明书生成工具-SmartFlowRecorder
- **Description**: 智流录制器 - AI 操作说明书生成工具（SmartFlowRecorder，简称 SFR）是一款AI智能操作流程录制工具，专注于自动记录屏幕操作步骤、生成操作说明书。支持鼠标 / 键盘操作录制、截图标注编辑、Markdown 自动生成，可导出 PDF/Word/HTML/MD 多格式文档，无需手动整理操作流程，大幅提升操作说明书编写效率。适用于产品文档、教程编写、运维操作梳理等场景。
- **Primary Language**: Python
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-09
- **Last Updated**: 2025-12-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 智流录制器 - AI 操作说明书生成工具-SmartFlowRecorder

## 介绍
智流录制器 - AI 操作说明书生成工具（SmartFlowRecorder，简称 SFR）是一款AI智能操作流程录制工具，专注于自动记录屏幕操作步骤、生成操作说明书。支持鼠标 / 键盘操作录制、截图标注编辑、Markdown 自动生成，可导出 PDF/Word/HTML/MD 多格式文档，无需手动整理操作流程，大幅提升操作说明书编写效率。适用于产品文档、教程编写、运维操作梳理等场景。

## 软件架构
软件架构说明：采用分层设计 + 模块化开发，整体分为界面层、核心功能层、基础工具层，各层解耦，便于扩展和维护。

SmartFlowRecorder
界面层（UI Layer）        # 负责用户交互，基于PySide6实现
核心功能层（Core Layer）  # 核心业务逻辑，拆分多个子模块
基础工具层（Utils Layer） # 通用工具函数，提供全局支撑

##### 核心流程
录制流程：用户触发录制 → ScreenRecorder 启动监听 → 捕获鼠标/键盘事件 → 实时截图 → 存储步骤数据 → 停止录制后生成初始Markdown
编辑流程：用户编辑步骤/截图 → StepManager 更新数据 → 同步刷新Markdown编辑区
导出流程：用户选择导出格式 → Exporter 调用对应子模块 → 读取步骤数据+截图 → 生成目标格式文件 → 保存到指定路径

##### 数据流转
核心数据结构：Step 类（包含步骤 ID、时间戳、操作类型、窗口信息、坐标、截图路径、描述文本等）
数据存储：录制过程中步骤数据暂存于内存，停止录制后可持久化到本地（可选），导出时读取内存数据生成文档
截图存储：自动创建 screenshots_${时间戳} 目录，按步骤 ID 命名截图文件，便于关联和查找

## 📋 核心功能

### 1. 操作录制
- 自动记录鼠标左键点击事件（窗口标题、坐标位置、时间戳）
- 实时截取屏幕并标记点击位置
- 录制过程中实时显示操作日志
- 支持键盘操作记录（含组合键，如 Ctrl+C、Alt+Tab 等），按时间轴统一整理

### 2. 编辑功能
- 录制完成后自动生成 Markdown 格式流程文档
- 内置截图编辑器：支持裁剪、标注（自定义颜色/线条宽度）、马赛克、文字标注、一键重置
- 步骤管理：拖拽排序、右键菜单（删除/上移/下移/编辑描述），操作后自动更新Markdown内容

### 3. 多格式导出
- 支持导出为 Markdown、PDF、Word、HTML 格式
- 导出文件包含所有操作步骤和对应截图，无需手动整理

### 4. 便捷辅助功能
- 快捷键操作：F9（开始/停止录制）、F10（清空内容）、Ctrl+S（导出）、Ctrl+Up/Down（调整步骤顺序）
- 录制悬浮窗：半透明置顶显示，实时展示鼠标坐标，停止录制后自动隐藏

## 🖥️ 环境要求

- 操作系统：Windows 10 / 11（其他系统需调整窗口捕获逻辑）
- Python 版本：3.8 及以上

#### 安装教程

1.  前往仓库「Releases」页面下载最新的 Windows 打包版压缩包
2.  解压到任意目录（建议非中文路径）
3.  右键点击 SmartFlowRecorder.exe，选择「以管理员身份运行」

#### 使用说明

1.  开始录制：点击界面 “开始录制” 按钮 或 按 F9 快捷键
2.  执行操作：正常操作目标软件 / 系统，工具自动记录鼠标 + 键盘操作
3.  停止录制：点击 “停止录制” 按钮 或 按 F9 快捷键
4.  编辑步骤：右键步骤列表可编辑截图 / 描述 / 顺序，支持截图精细化编辑
5.  导出文件：按 Ctrl+S 或点击导出按钮，选择 MD/PDF/Word/HTML 格式导出

#### ⚠️ 注意事项
1.  运行程序时需以管理员权限启动，确保能捕获所有窗口信息
2.  录制时鼠标点击 / 键盘操作间隔建议大于 0.5 秒，避免重复记录
3.  截图默认保存在程序运行目录下的 screenshots_xxx 文件夹（xxx 为时间戳）
4.  编辑后的截图会覆盖原文件，重要截图建议提前备份
5.  导出 PDF 前需确保 wkhtmltopdf 已正确安装并配置环境变量

#### 📌 快捷键说明
| 快捷键  | 功能  |
|-----------|-----------------|
| F9        | 开始 / 停止录制  |
| F10       | 清空所有录制内容  |
| Ctrl+S    | 导出文件  |
| Ctrl+Up   | 选中步骤上移  |
| Ctrl+Down | 选中步骤下移  |

	

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request