新增:文档体系重构+CHANGELOG补充+发布产物清理
This commit is contained in:
292
docs/08-用户指南/user-manual.md
Normal file
292
docs/08-用户指南/user-manual.md
Normal file
@@ -0,0 +1,292 @@
|
||||
# U-Desk 使用手册
|
||||
|
||||
> 轻量级桌面工具集 - 数据库管理 | 文件管理 | 设备测试
|
||||
|
||||
---
|
||||
|
||||
## 📖 快速开始
|
||||
|
||||
| 操作 | 说明 |
|
||||
|------|------|
|
||||
| **启动应用** | 双击 `u-desk.exe` |
|
||||
| **默认界面** | 数据库、文件管理、设备调用测试 |
|
||||
| **打开设置** | 点击右上角 ⚙️ 按钮 |
|
||||
| **拖动窗口** | 按住标题栏 "U-Desk" 文字区域 |
|
||||
|
||||
---
|
||||
|
||||
## 💾 数据库管理
|
||||
|
||||
### 界面布局
|
||||
|
||||
```
|
||||
┌──────────────┬──────────────────────────────┐
|
||||
│ 连接树 │ SQL 编辑器 │
|
||||
│ │ ───────────── │
|
||||
│ ▼ 连接1 │ SELECT * FROM users... │
|
||||
│ 📋 表1 │ │
|
||||
│ 📋 表2 │ ───────────── │
|
||||
│ │ 结果区域 │
|
||||
│ ▼ 连接2 │ ┌───┬────┬────┐ │
|
||||
│ │ │id │name│ age│ │
|
||||
│ │ ├───┼────┼────┤ │
|
||||
│ │ │ 1 │Tom │ 20 │ │
|
||||
│ │ └───┴────┴────┘ │
|
||||
└──────────────┴──────────────────────────────┘
|
||||
```
|
||||
|
||||
### 常用操作
|
||||
|
||||
#### 添加数据库连接
|
||||
|
||||
1. 点击连接树顶部的 **+ 新建连接**
|
||||
2. 填写连接信息
|
||||
|
||||
| 字段 | 说明 |
|
||||
|------|------|
|
||||
| 类型 | MySQL / PostgreSQL / SQLite / MongoDB / Redis |
|
||||
| 主机 | `localhost` 或服务器 IP |
|
||||
| 端口 | MySQL 默认 `3306`,PostgreSQL 默认 `5432` |
|
||||
| 用户名/密码 | 数据库登录信息 |
|
||||
| 数据库名 | SQLite 填文件路径 |
|
||||
|
||||
3. 点击 **测试连接** 验证
|
||||
4. 点击 **保存**
|
||||
|
||||
#### 查询数据
|
||||
|
||||
```
|
||||
展开连接 → 点击表名 → 自动生成SQL → 执行(Ctrl + Enter)
|
||||
```
|
||||
|
||||
#### 查看表结构
|
||||
|
||||
```
|
||||
右键表名 → 查看结构 → 切换到"结构"标签页
|
||||
```
|
||||
|
||||
#### 修改表结构
|
||||
|
||||
```
|
||||
编辑模式 → 修改字段/索引 → 保存 → 预览SQL → 确认执行
|
||||
```
|
||||
|
||||
#### 查看历史
|
||||
|
||||
```
|
||||
点击"历史"标签页 → 查看所有执行过的SQL
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📁 文件管理
|
||||
|
||||
### 界面布局
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────┐
|
||||
│ 路径框 [快捷访问▼] [历史▼] [刷新] [☰] │
|
||||
├──────┬────────────┬────────────────────┤
|
||||
│收藏夹│ 文件列表 │ 文件内容 │
|
||||
└──────┴────────────┴────────────────────┘
|
||||
```
|
||||
|
||||
### 导航操作
|
||||
|
||||
| 方式 | 操作 |
|
||||
|------|------|
|
||||
| **输入路径** | 在路径框输入(如 `C:\Users\Documents`),按回车 |
|
||||
| **快捷访问** | 点击按钮选择:桌面、文档、下载、图片 |
|
||||
| **历史记录** | 查看最近访问的 10 个路径 |
|
||||
|
||||
### 文件操作
|
||||
|
||||
| 操作 | 方法 |
|
||||
|------|------|
|
||||
| **查看文件** | 单击文件 |
|
||||
| **打开文件** | 双击文件(预览/编辑) |
|
||||
| **进入目录** | 双击文件夹 |
|
||||
| **收藏文件** | 点击 ⭐ 按钮,添加到左侧收藏夹 |
|
||||
| **重命名** | 右键 → 重命名 → 按回车确认 |
|
||||
|
||||
### 文件预览支持
|
||||
|
||||
| 类型 | 扩展名 | 功能 |
|
||||
|------|--------|------|
|
||||
| **图片** | `.jpg`, `.png`, `.gif`, `.svg`, `.webp` | 预览 |
|
||||
| **视频** | `.mp4`, `.webm`, `.ogg` | 播放器 |
|
||||
| **音频** | `.mp3`, `.wav`, `.ogg` | 播放器 |
|
||||
| **PDF** | `.pdf` | 预览 |
|
||||
| **HTML** | `.html`, `.htm` | 预览 ↔ 编辑切换 |
|
||||
| **Markdown** | `.md` | 渲染 ↔ 编辑切换 |
|
||||
| **代码** | `.js`, `.py`, `.go`, `.java`, `.sql`, `.json` 等 | 语法高亮 |
|
||||
|
||||
### ZIP 文件浏览
|
||||
|
||||
```
|
||||
双击 .zip 文件 → 进入浏览模式 → 查看文件列表 → 双击预览 → 退出 ZIP
|
||||
```
|
||||
|
||||
### 面板调整
|
||||
|
||||
| 操作 | 方法 |
|
||||
|------|------|
|
||||
| **调整宽度** | 拖动文件列表和内容区之间的分隔条 |
|
||||
| **显示收藏夹** | 点击顶部 ☰ 按钮 |
|
||||
|
||||
---
|
||||
|
||||
## 🔧 设备调用测试
|
||||
|
||||
### 系统信息
|
||||
|
||||
点击 **刷新系统信息** 获取:
|
||||
|
||||
| 类别 | 显示内容 |
|
||||
|------|----------|
|
||||
| **CPU** | 核心数、型号、使用率 |
|
||||
| **内存** | 总内存、已用、可用、使用率 |
|
||||
| **系统** | 操作系统、架构、主机名、平台 |
|
||||
| **磁盘** | 所有分区和使用情况 |
|
||||
|
||||
### 文件系统操作
|
||||
|
||||
```
|
||||
输入路径 → 列出目录 → 查看文件列表 → 预览内容
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ 设置
|
||||
|
||||
### Tab 配置
|
||||
|
||||
| 功能 | 操作 |
|
||||
|------|------|
|
||||
| **调整顺序** | 拖拽 ⋮⋮ 图标 |
|
||||
| **显示/隐藏** | 勾选/取消勾选(至少保留一个) |
|
||||
| **设置默认** | 点击 ○ 默认 单选按钮 |
|
||||
| **保存** | 点击 **保存配置** 按钮 |
|
||||
| **重置** | 点击 **重置** 恢复上次保存的状态 |
|
||||
|
||||
### 版本更新
|
||||
|
||||
```
|
||||
切换到"版本更新"标签页 → 检查更新 → 下载并安装
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ❓ 常见问题
|
||||
|
||||
### 应用启动慢?
|
||||
|
||||
**原因**:启用了所有模块
|
||||
|
||||
**解决**:设置中取消勾选不用的模块,只保留需要的
|
||||
|
||||
---
|
||||
|
||||
### 数据库连接失败?
|
||||
|
||||
**检查清单**:
|
||||
|
||||
- [ ] 主机、端口、用户名、密码是否正确
|
||||
- [ ] 数据库服务器是否已启动
|
||||
- [ ] 点击 **测试连接** 验证配置
|
||||
|
||||
---
|
||||
|
||||
### 文件预览乱码?
|
||||
|
||||
**原因**:文件编码不是 UTF-8
|
||||
|
||||
**解决**:使用专业编辑器(VS Code、Notepad++)查看
|
||||
|
||||
---
|
||||
|
||||
### 编辑器无法保存?
|
||||
|
||||
**说明**:编辑器当前为只读模式
|
||||
|
||||
**替代**:复制内容到外部编辑器保存
|
||||
|
||||
---
|
||||
|
||||
### 如何重置配置?
|
||||
|
||||
| 系统 | 操作 |
|
||||
|------|------|
|
||||
| **Windows** | 删除 `%LOCALAPPDATA%\u-desk\` 文件夹内容 |
|
||||
| **macOS** | 删除 `~/Library/Application Support/u-desk/` 文件夹 |
|
||||
| **Linux** | 删除 `~/.config/u-desk/` 文件夹 |
|
||||
|
||||
删除后重启应用,自动恢复默认配置
|
||||
|
||||
---
|
||||
|
||||
### ZIP 文件无法修改?
|
||||
|
||||
**说明**:ZIP 浏览模式为只读
|
||||
|
||||
**解决**:使用专业压缩软件(WinRAR、7-Zip)修改
|
||||
|
||||
---
|
||||
|
||||
## 📂 配置文件位置
|
||||
|
||||
| 系统 | 路径 |
|
||||
|------|------|
|
||||
| **Windows** | `%LOCALAPPDATA%\u-desk\` |
|
||||
| **macOS** | `~/Library/Application Support/u-desk/` |
|
||||
| **Linux** | `~/.config/u-desk/` |
|
||||
|
||||
---
|
||||
|
||||
## ⌨️ 快捷键
|
||||
|
||||
### 数据库模块
|
||||
|
||||
| 快捷键 | 功能 |
|
||||
|--------|------|
|
||||
| `F5` | 执行 SQL |
|
||||
| `Ctrl + Enter` | 执行选中的 SQL |
|
||||
|
||||
### 文件管理模块
|
||||
|
||||
| 快捷键 | 功能 |
|
||||
|--------|------|
|
||||
| `Ctrl + N` | 新建文件 |
|
||||
| `Ctrl + Shift + N` | 新建文件夹 |
|
||||
| `F2` | 重命名选中文件 |
|
||||
| `Del` | 删除选中文件 |
|
||||
| `Ctrl + B` | 显示/隐藏收藏夹侧边栏 |
|
||||
| `Ctrl + ←` | 后退到上一个目录 |
|
||||
| `Ctrl + →` | 前进到下一个目录 |
|
||||
| `Ctrl + Shift + C` | 快速打开 C 盘 |
|
||||
| `Ctrl + Shift + D` | 快速打开 D 盘 |
|
||||
| `Ctrl + Shift + E` | 快速打开 E 盘 |
|
||||
| `Enter` | 确认(编辑文件名时) |
|
||||
| `Esc` | 取消(编辑文件名时) |
|
||||
|
||||
### 通用快捷键
|
||||
|
||||
| 快捷键 | 功能 |
|
||||
|--------|------|
|
||||
| `F5` | 刷新当前视图 |
|
||||
|
||||
---
|
||||
|
||||
## 🎯 窗口控制
|
||||
|
||||
| 按钮 | 功能 |
|
||||
|------|------|
|
||||
| `-` | 最小化到任务栏 |
|
||||
| `□` | 最大化/还原 |
|
||||
| `×` | 关闭窗口 |
|
||||
|
||||
**拖动窗口**:按住标题栏 "U-Desk" 文字区域或标签页空白区域
|
||||
|
||||
---
|
||||
|
||||
**版本**:1.0.0 | **更新日期**:2026-01-28
|
||||
Reference in New Issue
Block a user