76 lines
2.3 KiB
Markdown
76 lines
2.3 KiB
Markdown
# work-weekly-report
|
|
|
|
工作计划管理工具。用于管理个人工作周报，包括制定本周工作计划、记录日常工作、更新工作进度、查询历史周报等。
|
|
|
|
## 目录结构
|
|
|
|
```
|
|
work-weekly-report/
|
|
├── SKILL.md # Skill 定义文件
|
|
├── README.md # 本文件
|
|
├── scripts/ # 脚本目录
|
|
│ └── work-weekly-report.js
|
|
└── data/ # 数据存储目录
|
|
└── weekly-reports.json
|
|
```
|
|
|
|
## 功能概述
|
|
|
|
- **制定本周工作计划**: 为当前工作周制定或更新工作计划
|
|
- **更新工作记录**: 记录指定日期的实际工作情况
|
|
- **输出本周未完成工作**: 汇总当前工作周中未完成的任务
|
|
- **查询指定周周报**: 查看指定工作周的工作计划与实际记录
|
|
- **更新计划项状态**: 将某个计划项标记为完成或其他状态
|
|
- **设置周报总结**: 为某周添加总结文字
|
|
|
|
## 工作周定义
|
|
|
|
- **工作周**: 周一至周五（法定工作日）
|
|
- **周编号**: ISO 8601 标准，格式 `YYYY-Www`（如 `2026-W15` 表示 2026 年第 15 周）
|
|
- **周起始**: 周一为该周的第一天，周五为最后一天
|
|
|
|
## 使用方式
|
|
|
|
### 触发命令
|
|
|
|
- `/work-weekly-report`
|
|
- "制定本周工作计划"
|
|
- "更新今天的工作记录"
|
|
- "查看本周未完成的工作"
|
|
- "查询 2026-W15 的周报"
|
|
|
|
### CLI 命令
|
|
|
|
```bash
|
|
# 制定本周计划
|
|
node scripts/work-weekly-report.js plan --tasks "任务1" "任务2"
|
|
|
|
# 更新今天的工作记录
|
|
node scripts/work-weekly-report.js record --content "完成了XX任务" --status completed
|
|
|
|
# 查看本周未完成
|
|
node scripts/work-weekly-report.js pending
|
|
|
|
# 查询指定周
|
|
node scripts/work-weekly-report.js query --week "2026-W15"
|
|
|
|
# 设置周报总结
|
|
node scripts/work-weekly-report.js summary --week "2026-W15" --content "本周主要完成了..."
|
|
```
|
|
|
|
## 数据存储
|
|
|
|
数据存储在 `data/weekly-reports.json` 文件中，采用 JSON 格式，包含以下结构：
|
|
|
|
- `meta`: 版本信息
|
|
- `weeklyReports`: 按周编号索引的工作周报数据
|
|
- `plan`: 计划任务列表
|
|
- `records`: 每日工作记录
|
|
- `summary`: 周报总结
|
|
|
|
## 注意事项
|
|
|
|
1. 数据文件会自动创建，首次使用时会初始化
|
|
2. 所有日期需为有效的法定工作日（周一至周五）
|
|
3. 建议每次完成工作后及时记录，便于周末生成周报
|