Back to Details

yuque-group-weekly-report

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Weekly Report — Team Documentation Activity Report

周报 —— 团队文档活动报告

Collect group activity data from Yuque (document stats, member contributions) and generate a structured weekly report, then save it to Yuque.
从语雀收集团队活动数据（文档统计、成员贡献），生成结构化的周报，然后保存到语雀。

When to Use

适用场景

  • User asks for a group weekly report based on Yuque activity
  • User says "生成团队周报", "group weekly report", "本周团队文档活动总结"
  • End of week group documentation activity review
  • 用户需要基于语雀活动生成团队周报
  • 用户说出「生成团队周报」、「group weekly report」、「本周团队文档活动总结」
  • 周终团队文档活动复盘

Required MCP Tools

所需MCP工具

All tools are from the 
yuque-mcp
server:
  • yuque_group_doc_stats
    — Get document activity stats for a group
  • yuque_group_member_stats
    — Get member contribution stats for a group
  • yuque_list_repos
    — List repos in the group (for context)
  • yuque_create_doc
    — Create the weekly report document
所有工具均来自
yuque-mcp
服务：
  • yuque_group_doc_stats
    — 获取团队的文档活动统计数据
  • yuque_group_member_stats
    — 获取团队的成员贡献统计数据
  • yuque_list_repos
    — 列出团队下的知识库（用于补充上下文）
  • yuque_create_doc
    — 创建周报文档

Workflow

工作流程

Step 1: Identify the Team/Group

步骤1：确认团队信息

Ask the user or determine from context:
  • Group login (e.g., 
    my-team
    ) — required for API calls
  • Report period — default to the current week (Monday to Sunday)
If the user doesn't specify a group, ask: "请告诉我团队的语雀团队标识（group login），我来生成团队周报。"
询问用户或从上下文判断：
  • 团队标识（group login）（例如
    my-team
    ）—— API调用的必填参数
  • 报告周期 —— 默认为当前周（周一至周日）
如果用户没有指定团队，询问：「请告诉我团队的语雀团队标识（group login），我来生成团队周报。」

Step 2: Collect Data

步骤2：收集数据

Make these API calls in sequence:
按顺序调用以下API：

2a. Document Activity Stats

2a. 文档活动统计

Tool: yuque_group_doc_stats
Parameters:
  login: "<group_login>"
This returns: new docs created, docs updated, total views, etc.
Tool: yuque_group_doc_stats
Parameters:
  login: "<group_login>"
返回结果包含：新建文档数、更新文档数、总浏览量等数据。

2b. Member Contribution Stats

2b. 成员贡献统计

Tool: yuque_group_member_stats
Parameters:
  login: "<group_login>"
This returns: per-member doc count, word count, activity metrics.
Tool: yuque_group_member_stats
Parameters:
  login: "<group_login>"
返回结果包含：每位成员的文档数、字数、活动指标等数据。

2c. Repository List (for context)

2c. 知识库列表（补充上下文）

Tool: yuque_list_repos
Parameters:
  login: "<group_login>"
  type: "group"
This provides repo names for richer context in the report.
Tool: yuque_list_repos
Parameters:
  login: "<group_login>"
  type: "group"
返回知识库名称，用于丰富报告的上下文信息。

Step 3: Analyze the Data

步骤3：数据分析

Calculate and identify:
  • Total new documents this week
  • Total updates this week
  • Most active members (top 3-5 by contribution)
  • Most active repos (if data available)
  • Week-over-week trends (if previous data available)
  • Notable highlights (any unusually high activity, new repos, etc.)
计算并确认以下信息：
  • 本周新建文档总数
  • 本周更新文档总数
  • 最活跃成员（按贡献排名前3-5位）
  • 最活跃知识库（如果有对应数据）
  • 周环比趋势（如果有上周历史数据）
  • 重点亮点（任何异常高的活动数据、新建知识库等）

Step 4: Generate the Report

步骤4：生成报告

Use this template:
markdown
undefined
使用以下模板：
markdown
undefined

📊 团队知识周报

📊 团队知识周报

团队：[团队名称] 周期：YYYY-MM-DD（周一）至 YYYY-MM-DD（周日） 生成时间：YYYY-MM-DD HH:MM
团队：[团队名称] 周期：YYYY-MM-DD（周一）至 YYYY-MM-DD（周日） 生成时间：YYYY-MM-DD HH:MM

📈 本周概览

📈 本周概览

指标本周上周变化
新建文档XX 篇--
更新文档XX 篇--
总浏览量XX 次--
活跃成员XX 人--
指标本周上周变化
新建文档XX 篇--
更新文档XX 篇--
总浏览量XX 次--
活跃成员XX 人--

📝 文档动态

📝 文档动态

新建文档

新建文档

#文档标题作者知识库创建时间
1[标题][作者][库名]MM-DD
2[标题][作者][库名]MM-DD
#文档标题作者知识库创建时间
1[标题][作者][库名]MM-DD
2[标题][作者][库名]MM-DD

热门更新

热门更新

#文档标题更新者更新次数
1[标题][作者]X 次
#文档标题更新者更新次数
1[标题][作者]X 次

👥 成员贡献

👥 成员贡献

排名成员新建文档更新文档字数贡献
🥇[姓名]X 篇X 篇~X 字
🥈[姓名]X 篇X 篇~X 字
🥉[姓名]X 篇X 篇~X 字
排名成员新建文档更新文档字数贡献
🥇[姓名]X 篇X 篇~X 字
🥈[姓名]X 篇X 篇~X 字
🥉[姓名]X 篇X 篇~X 字

📊 趋势分析

📊 趋势分析

  • [对本周数据的简要分析，2-3 句话]
  • [与上周对比的变化趋势]
  • [值得关注的亮点或问题]
  • [对本周数据的简要分析，2-3 句话]
  • [与上周对比的变化趋势]
  • [值得关注的亮点或问题]

💡 建议

💡 建议

  1. [建议 1]：[具体建议内容]
  2. [建议 2]：[具体建议内容]
📌 本报告基于语雀团队活动数据自动生成，数据截至 YYYY-MM-DD。
undefined
  1. [建议 1]：[具体建议内容]
  2. [建议 2]：[具体建议内容]
📌 本报告基于语雀团队活动数据自动生成，数据截至 YYYY-MM-DD。
undefined

Step 5: Save to Yuque

步骤5：保存到语雀

Ask the user which repo to save to, or suggest a "周报" / "团队管理" repo if one exists.
Tool: yuque_create_doc
Parameters:
  repo_id: "<namespace>"    # e.g., "mygroup/mybook"
  title: "团队知识周报 YYYY-MM-DD ~ YYYY-MM-DD"
  body: "<formatted report>"
  format: "markdown"
询问用户要保存到哪个知识库，如果存在「周报」/「团队管理」类知识库也可以主动推荐。
Tool: yuque_create_doc
Parameters:
  repo_id: "<namespace>"    # 例如 "mygroup/mybook"
  title: "团队知识周报 YYYY-MM-DD ~ YYYY-MM-DD"
  body: "<formatted report>"
  format: "markdown"

Step 6: Confirm

步骤6：结果确认

markdown
✅ 团队周报已生成并保存！

📄 **[团队知识周报 日期范围](文档链接)**
📚 已归档到：「知识库名称」
markdown
✅ 团队周报已生成并保存！

📄 **[团队知识周报 日期范围](文档链接)**
📚 已归档到：「知识库名称」

本周亮点

本周亮点

  • 共新建 X 篇文档，更新 X 篇
  • 最活跃成员：[姓名]（X 篇文档）
  • [其他亮点]
undefined
  • 共新建 X 篇文档，更新 X 篇
  • 最活跃成员：[姓名]（X 篇文档）
  • [其他亮点]
undefined

Guidelines

使用规范

  • If week-over-week comparison data is not available, omit the "上周" and "变化" columns — don't fabricate numbers
  • Keep suggestions constructive and specific (e.g., "建议 XX 知识库补充 API 文档" rather than generic "多写文档")
  • If a group has many members, show top 5 in the main table and mention total count
  • Use emoji in headers for visual scanning but keep the tone professional
  • Default report language is Chinese
  • For personal weekly reports, use the 
    weekly-report
    skill in the 
    yuque-personal
    plugin
  • 如果没有周环比对比数据，省略「上周」和「变化」列，不要捏造数据
  • 建议内容要务实具体（例如「建议XX知识库补充API文档」，而不是笼统的「多写文档」）
  • 如果团队成员较多，主表只展示前5名，同时备注总活跃成员数
  • 标题可使用emoji提升可读性，但整体保持专业风格
  • 报告默认使用中文生成
  • 如果是个人周报，使用
    yuque-personal
    插件的
    weekly-report
    技能

Error Handling

错误处理

SituationAction
yuque_group_doc_stats
fails		Inform user, check if group login is correct and group Token is configured
yuque_group_member_stats
fails		Generate report without member breakdown, note the gap
Group has no activity this weekCreate a brief report noting zero activity, suggest reasons
User doesn't know group loginUse 
yuque_list_repos
with their personal login to find groups
API returns partial dataGenerate report with available data, note what's missing
Team Token missing statistic:readInform user the Token needs 
statistic:read
permission
场景处理方式
yuque_group_doc_stats
调用失败		告知用户，检查团队标识是否正确、团队Token是否已配置
yuque_group_member_stats
调用失败		生成不带成员明细的报告，备注该部分数据缺失
团队本周无任何活动生成极简报告说明无活动，可提示可能的原因
用户不知道团队标识用用户个人标识调用
yuque_list_repos
查找所属团队
API返回部分数据用可用数据生成报告，备注缺失的内容
团队Token缺少
statistic:read
权限		告知用户需要为Token配置
statistic:read
权限