Back to Details

weekly-report

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

周报生成

Weekly Report Generation

何时使用

When to Use

  • 用户说"帮我写周报""这周做了啥";
  • 周五下班前或汇报前,需要整理本周工作;
  • 有 git 历史可用,想快速把提交变成周报素材。
  • When users say "Help me write a weekly report" or "What did I do this week";
  • Before leaving work on Friday or before a report, need to organize this week's work;
  • When git history is available and you want to quickly turn commits into weekly report materials.

使用步骤

Usage Steps

第 1 步:确认时间段与范围

Step 1: Confirm Time Period and Scope

  • 默认本周一至今;也可按汇报要求指定起止日期;
  • 涉及多个仓库时,一次列出全部路径;
  • 确认周报给谁看(自己、组长、客户),语气和颗粒度不同。
  • Default is from this Monday to now; you can also specify start and end dates according to report requirements;
  • When multiple repositories are involved, list all paths at once;
  • Confirm who the weekly report is for (yourself, team leader, client), as the tone and granularity will differ.

第 2 步:收集事实

Step 2: Collect Facts

跑脚本收集提交素材,命令见下面的辅助脚本。脚本只收集和分组事实:提交、作者、类型、文件数;琐碎提交(merge/typo/格式化)单独列出,不混进正文。
Run the script to collect commit materials, see the Auxiliary Script below. The script only collects and groups facts: commits, authors, types, number of files; trivial commits (merge/typo/formatting) are listed separately and not included in the main text.

第 3 步:补充提交之外的工作

Step 3: Supplement Work Beyond Commits

git 提交覆盖不到的,问用户或从对话里找:
  • 开会、评审、沟通、协调;
  • 进行中的事项和进度;
  • 风险、阻塞、需要别人配合的;
  • 下周计划。
For content not covered by git commits, ask the user or find it in the conversation:
  • Meetings, reviews, communication, coordination;
  • In-progress items and their progress;
  • Risks, blockers, needs for others' cooperation;
  • Next week's plan.

第 4 步:写成周报

Step 4: Compose the Weekly Report

按下面的结构组织,事实以脚本输出为准,不编造:
markdown
undefined
Organize according to the following structure, with facts based on the script output, no fabrication:
markdown
undefined

周报:2026-08-24 ~ 2026-08-30

Weekly Report: 2026-08-24 ~ 2026-08-30

本周完成

Completed This Week

  • 按类型或项目分组,每条一句"做了什么",可带提交号
  • Group by type or project, each item is a sentence of "what was done", which can include commit IDs

进行中

In Progress

  • 事项 + 当前进度
  • Item + current progress

风险与阻塞

Risks & Blockers

  • 有问题直说,给出需要的支持
  • State problems directly and specify the support needed

下一步计划

Next Steps

  • 可执行、有优先级

原则:

- 结论比数量重要:写"上线了 X 功能",而不是"提交了 20 次";
- 提交号放括号里作证据,不占正文;
- 琐碎提交不写进正文。
  • Executable and prioritized

Principles:

- Conclusions are more important than quantity: Write "Launched feature X" instead of "Made 20 commits";
- Put commit IDs in parentheses as evidence, do not occupy the main text;
- Trivial commits are not included in the main text.

第 5 步:确认后交付

Step 5: Deliver After Confirmation

  • 让用户过目,确认没有夸大、没有漏掉关键工作;
  • 要存档或发群,按用户要求输出文件或直接给文本。
  • Let the user review to ensure no exaggeration or omission of key work;
  • If archiving or sending to a group, output files or provide text directly as required by the user.

输入与输出

Input and Output

  • 输入:git 仓库路径(可选多个)+ 时间范围 + 用户补充的工作事项;
  • 输出:结构化中文周报。
  • Input: git repository paths (multiple optional) + time range + work items supplemented by users;
  • Output: Structured Chinese weekly report.

示例

Examples

用户输入: "帮我写这周周报。"
脚本输出(节选):
text
- 提交总数:45(不含 merge),涉及文件:182
User Input: "Help me write this week's weekly report."
Script Output (Excerpt):
text
- Total commits: 45 (excluding merge), files involved: 182

feat (6)

feat (6)

  • [1ef9857] feat: API 测试技能新增契约转测试骨架生成脚本(Laffey-82)

**周报节选:**

```markdown
  • [1ef9857] feat: API testing skill adds contract-to-test skeleton generation script (Laffey-82)

**Weekly Report Excerpt:**

```markdown

本周完成

Completed This Week

  • API 测试技能新增契约转测试骨架生成脚本,契约校验失败会直接拒绝(1ef9857)
  • 任务拆解、技术文档技能新增检查脚本,产出可机器自查(45efbeb、651ea4b)
  • API testing skill adds contract-to-test skeleton generation script, which directly rejects failed contract validation (1ef9857)
  • Task breakdown and technical documentation skills add check scripts, enabling machine self-inspection of outputs (45efbeb, 651ea4b)

进行中

In Progress

  • 新技能周报生成,骨架已完成,正在补实测
  • New skill weekly report generation, skeleton completed, currently supplementing actual tests

风险与阻塞

Risks & Blockers

  • 无
  • None

下一步计划

Next Steps

  • 跑完新技能实测后发 v0.8.0
undefined
  • Release v0.8.0 after completing actual tests for the new skill
undefined

辅助脚本

Auxiliary Script

scripts/collect_worklog.py 从 git 历史收集指定时间段的提交,按类型分组,统计文件数,琐碎提交单独列出:
bash
undefined
scripts/collect_worklog.py collects commits from git history within the specified time period, groups them by type, counts the number of files, and lists trivial commits separately:
bash
undefined

本周一至今,当前目录仓库

This Monday to now, current directory repository

python skills/weekly-report/scripts/collect_worklog.py
python skills/weekly-report/scripts/collect_worklog.py

指定时间段 + 多仓库,输出到文件

Specify time period + multiple repositories, output to file

python skills/weekly-report/scripts/collect_worklog.py --since 2026-08-24 --until 2026-08-30 --repos <路径1> <路径2> -o 草稿.md

脚本只做收集和分组,周报结论由人写。
python skills/weekly-report/scripts/collect_worklog.py --since 2026-08-24 --until 2026-08-30 --repos <path1> <path2> -o draft.md

The script only collects and groups; the conclusions of the weekly report are written by humans.

注意事项

Notes

  • 不编造:脚本没收集到的、用户没确认的,不要写;
  • 区分事实和结论:提交是事实,"做了什么"是结论,结论由人确认;
  • 给领导看的周报少写技术细节,给同组看的可以写实现细节;
  • 多仓库汇总时,按仓库或项目分组,别混成一锅。
  • No fabrication: Do not write content not collected by the script or confirmed by the user;
  • Distinguish facts and conclusions: Commits are facts, "what was done" is a conclusion, which needs to be confirmed by humans;
  • Write fewer technical details in weekly reports for leaders, while more implementation details can be included for team members;
  • When summarizing multiple repositories, group by repository or project, do not mix them together.

不适用场景

Unsuitable Scenarios

  • 没有 git 历史也没有工作记录,要凭空写周报;
  • 用户要的是日报(把时间范围调成一天即可);
  • 纯个人流水账,不需要结构。
  • No git history or work records, need to write a weekly report out of thin air;
  • Users need a daily report (just adjust the time range to one day);
  • Pure personal log without the need for structure.

验证方式

Verification Methods

  1. 触发:"帮我写周报";
  2. 跑脚本:collect_worklog.py 输出与 git log 抽查结果一致;
  3. 走查:周报里每条"完成"都能对应到提交或用户确认过的事项;
  4. 确认:用户过目后无异议。
  1. Trigger: "Help me write a weekly report";
  2. Run the script: The output of collect_worklog.py is consistent with the spot check results of git log;
  3. Review: Each "Completed" item in the weekly report can correspond to a commit or a user-confirmed item;
  4. Confirmation: No objections from the user after review.