# 周报助手

**Repository Path**: wyy92_admin/WeeklyReport

## Basic Information

- **Project Name**: 周报助手
- **Description**: 一款基于 WPF 的桌面工具，自动读取多个 Git 仓库的提交记录与代码变更，调用 DeepSeek 大模型将 diff 智能总结为周报文本，并一键提交到飞书群。

- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-10
- **Last Updated**: 2026-03-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 周报助手 (WeeklyReport)

一款基于 WPF 的周报自动生成工具，支持 Git 提交记录读取、文件夹变更扫描、手动工作事项录入，可选接入 DeepSeek AI 智能总结，一键发送至飞书群。

---

## 环境要求

- Windows 10 / 11
- .NET 8 运行时
- Git（如需扫描 Git 仓库）

---

## 快速开始

1. 启动应用，进入 **?? 项目配置** 页签
2. 添加需要扫描的项目目录
3. 切换到 **?? 生成周报** 页签，选择日期范围，点击 **?? 生成周报**
4. 复制到剪贴板或发送到飞书

---

## 功能说明

### ?? 项目配置

配置需要纳入周报的项目目录，支持两种模式：

#### Git 仓库模式

勾选 **Git仓库模式**，自动读取指定时间段内的 Git 提交记录和代码 diff。

| 字段 | 说明 |
|------|------|
| 项目名称 | 在周报中显示的名称 |
| 目录路径 | Git 仓库根目录（包含 `.git` 文件夹） |
| 提交者 | 按提交者筛选，留空读取所有人 |
| 分支 | 指定分支，留空使用当前分支 |

#### 文件夹扫描模式

取消勾选 **Git仓库模式**，扫描目录中指定时间段内新增或修改的文件，适用于图纸、文档等非代码文件。

| 字段 | 说明 |
|------|------|
| 文件过滤 | 逗号分隔的扩展名，如 `.docx,.xlsx,.dwg`，留空扫描所有文件 |

支持的文件类型包括：Office 文档、CAD 图纸（dwg/dxf）、SolidWorks/UG/Inventor/CATIA 模型、电路设计文件等。

操作按钮：
- **? 添加项目** — 将表单内容添加为新项目
- **?? 更新选中** — 用表单内容更新列表中选中的项目
- **??? 删除选中** — 删除选中项目
- **?? 保存配置** — 保存所有项目配置到本地

---

### ?? 工作记录

手动录入工作事项，适用于无法通过 Git 或文件扫描获取的工作内容。

| 字段 | 说明 |
|------|------|
| 日期 | 工作日期，默认今天 |
| 类别 | 从预设列表选择或自行输入（设计、调试、装配、会议等） |
| 内容 | 工作内容描述 |
| 备注 | 补充说明（可选） |

操作按钮：
- **?? 填充本周日期** — 自动为周一到周五各创建一条空记录，方便逐条填写
- **? 添加事项** — 添加一条工作记录
- **??? 删除选中** — 删除选中记录
- **?? 清空本周** — 仅清空本周的记录，其他日期不受影响
- **?? 保存** — 保存工作记录（空描述的记录会被自动移除）

> 界面仅显示最近 30 天的记录。超过 60 天的旧记录在保存时自动归档至 `archive` 目录。

---

### ?? 生成周报

1. 选择 **开始日期** 和 **结束日期**，或点击 **?? 本周 / ?? 上周** 快速设定
2. 点击 **?? 生成周报**
3. 工具会依次读取所有项目的提交记录/文件变更，合并手动工作事项，生成周报文本
4. 生成后可在预览区域直接编辑内容
5. 点击 **?? 复制到剪贴板** 或 **?? 发送到飞书**

**两种生成模式：**

| 模式 | 条件 | 效果 |
|------|------|------|
| 基础模式 | 未配置 DeepSeek API Key | 按日期列出提交记录和文件变更明细 |
| AI 模式 | 已配置 DeepSeek API Key | 调用 AI 将代码变更和工作事项总结为业务语言 |

---

### ?? 设置

#### DeepSeek AI 配置（可选）

| 字段 | 说明 |
|------|------|
| API Key | DeepSeek 平台申请的 API Key |
| API 地址 | 默认 `https://api.deepseek.com/v1/chat/completions`，可替换为兼容接口 |
| 模型名称 | 默认 `deepseek-chat` |

#### 飞书配置（可选）

| 字段 | 说明 |
|------|------|
| Webhook 地址 | 飞书群机器人的 Webhook URL |
| App ID / App Secret | 预留字段，当前未使用 |

配置完成后可点击 **?? 发送测试消息到飞书** 验证连通性。

#### 通用配置

| 字段 | 说明 |
|------|------|
| 默认Git提交者 | 全局默认的提交者筛选，项目级配置优先 |

---

## 数据存储

所有配置和数据保存在：

```
%APPDATA%\WeeklyReport\
├── config.json    # 配置文件（项目、设置、工作记录）
└── archive\ # 自动归档的过期工作记录
    └── workitems_2025-01.json
```

---

## 常见问题

**Q: 提示"不是一个Git仓库"？**
A: 确认目录路径指向包含 `.git` 文件夹的根目录。

**Q: 生成周报时没有提交记录？**
A: 检查日期范围、提交者名称和分支是否正确。提交者需与 `git log --author` 的值一致。

**Q: AI 模式响应很慢？**
A: DeepSeek API 调用超时设置为 3 分钟，大量代码变更时需要较长处理时间。

**Q: 不配置 DeepSeek 能用吗？**
A: 可以。基础模式会直接列出提交记录和文件变更明细，不经过 AI 总结。