yuque-group-knowledge-report

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Knowledge Report — Team Knowledge Management Monthly Report

知识报告——团队知识管理月报

Collect comprehensive team data from Yuque (group stats, member contributions, knowledge base metrics, document activity) and generate a detailed monthly knowledge management report.
从语雀采集全面的团队数据(团队统计、成员贡献、知识库指标、文档活动)并生成详细的月度知识管理报告。

When to Use

适用场景

  • User wants a monthly knowledge management report
  • User says "生成知识月报", "knowledge report", "团队知识管理月报"
  • Monthly review of team documentation health and activity
  • 用户需要月度知识管理报告
  • 用户说 "生成知识月报", "knowledge report", "团队知识管理月报"
  • 月度复盘团队文档健康度与活跃情况

Required MCP Tools

所需MCP工具

All tools are from the
yuque-mcp
server:
  • yuque_group_stats
    — Get overall group statistics
  • yuque_group_member_stats
    — Get per-member contribution data
  • yuque_group_book_stats
    — Get per-knowledge-base statistics
  • yuque_group_doc_stats
    — Get document activity statistics
  • yuque_create_doc
    — Create the monthly report document
所有工具均来自
yuque-mcp
服务端:
  • yuque_group_stats
    — 获取团队整体统计数据
  • yuque_group_member_stats
    — 获取各成员贡献数据
  • yuque_group_book_stats
    — 获取各知识库统计数据
  • yuque_group_doc_stats
    — 获取文档活动统计数据
  • yuque_create_doc
    — 创建月度报告文档

Workflow

工作流程

Step 1: Identify the Team and Period

步骤1:确定团队与统计周期

Gather from the user:
  • Group login (required)
  • Report month (default: previous month)
If the user doesn't specify: "请告诉我团队的语雀团队标识(group login),我来生成知识月报。"
从用户处收集以下信息:
  • 团队标识(group login)(必填)
  • 报告月份(默认值:上个月)
如果用户未指定:"请告诉我团队的语雀团队标识(group login),我来生成知识月报。"

Step 2: Collect All Data

步骤2:采集全部数据

Make these API calls:
调用以下API:

2a. Overall Group Stats

2a. 团队整体统计

Tool: yuque_group_stats
Parameters:
  login: "<group_login>"
Returns: total members, total docs, total repos, overall activity metrics.
Tool: yuque_group_stats
Parameters:
  login: "<group_login>"
返回:总成员数、总文档数、总知识库数、整体活跃指标。

2b. Member Contribution Stats

2b. 成员贡献统计

Tool: yuque_group_member_stats
Parameters:
  login: "<group_login>"
Returns: per-member doc count, word count, activity breakdown.
Tool: yuque_group_member_stats
Parameters:
  login: "<group_login>"
返回:各成员文档数、字数、活跃度明细。

2c. Knowledge Base Stats

2c. 知识库统计

Tool: yuque_group_book_stats
Parameters:
  login: "<group_login>"
Returns: per-repo doc count, update frequency, growth metrics.
Tool: yuque_group_book_stats
Parameters:
  login: "<group_login>"
返回:各知识库文档数、更新频率、增长指标。

2d. Document Activity Stats

2d. 文档活动统计

Tool: yuque_group_doc_stats
Parameters:
  login: "<group_login>"
Returns: new docs, updated docs, views, popular documents.
Tool: yuque_group_doc_stats
Parameters:
  login: "<group_login>"
返回:新建文档数、更新文档数、浏览量、热门文档。

Step 3: Analyze the Data

步骤3:数据分析

Compute the following insights:
Overall Health
  • Total documents and month-over-month growth
  • Active contributor ratio (active members / total members)
  • Documentation velocity (docs per week)
Member Analysis
  • Top contributors (by docs created, words written)
  • Contribution distribution (is it concentrated or spread out?)
  • Inactive members (0 contributions this month)
Knowledge Base Analysis
  • Most active repos
  • Stale repos (no updates this month)
  • Repo growth rates
Trends
  • Week-by-week activity within the month
  • Comparison with previous month (if data available)
计算以下洞察:
整体健康度
  • 总文档数及环比增长
  • 活跃贡献者占比(活跃成员 / 总成员)
  • 文档产出速度(每周文档数)
成员分析
  • Top贡献者(按新建文档数、撰写字数排序)
  • 贡献分布(是集中还是分散?)
  • 不活跃成员(本月贡献为0)
知识库分析
  • 最活跃的知识库
  • 停滞知识库(本月无更新)
  • 知识库增长率
趋势
  • 本月内每周活跃度
  • 与上月数据对比(如果有数据的话)

Step 4: Generate the Report

步骤4:生成报告

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

📊 团队知识管理月报

📊 团队知识管理月报

团队:[团队名称] 报告周期:YYYY 年 MM 月 生成时间:YYYY-MM-DD HH:MM

团队:[团队名称] 报告周期:YYYY 年 MM 月 生成时间:YYYY-MM-DD HH:MM

📈 月度概览

📈 月度概览

指标本月上月环比变化
总文档数XXX 篇--
新建文档XX 篇--
更新文档XX 篇--
总浏览量X,XXX 次--
活跃成员XX / XX 人--
知识库数XX 个--
指标本月上月环比变化
总文档数XXX 篇--
新建文档XX 篇--
更新文档XX 篇--
总浏览量X,XXX 次--
活跃成员XX / XX 人--
知识库数XX 个--

健康度评分

健康度评分

维度评分说明
📝 文档产出⭐⭐⭐⭐[简评]
👥 参与度⭐⭐⭐[简评]
📚 覆盖度⭐⭐⭐⭐[简评]
🔄 更新频率⭐⭐⭐[简评]

维度评分说明
📝 文档产出⭐⭐⭐⭐[简评]
👥 参与度⭐⭐⭐[简评]
📚 覆盖度⭐⭐⭐⭐[简评]
🔄 更新频率⭐⭐⭐[简评]

👥 成员贡献

👥 成员贡献

Top 贡献者

Top 贡献者

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

贡献分布

贡献分布

  • 高活跃(≥5 篇文档):X 人
  • 中活跃(1-4 篇文档):X 人
  • 低活跃(仅更新):X 人
  • 未活跃(0 贡献):X 人

  • 高活跃(≥5 篇文档):X 人
  • 中活跃(1-4 篇文档):X 人
  • 低活跃(仅更新):X 人
  • 未活跃(0 贡献):X 人

📚 知识库分析

📚 知识库分析

活跃知识库

活跃知识库

知识库新建更新总文档活跃度
[库名]X 篇X 篇XX 篇🟢 高
[库名]X 篇X 篇XX 篇🟡 中
知识库新建更新总文档活跃度
[库名]X 篇X 篇XX 篇🟢 高
[库名]X 篇X 篇XX 篇🟡 中

需要关注的知识库

需要关注的知识库

知识库总文档上次更新建议
[库名]XX 篇XX 天前[建议]

知识库总文档上次更新建议
[库名]XX 篇XX 天前[建议]

📊 趋势分析

📊 趋势分析

周度活动趋势

周度活动趋势

周次新建文档更新文档活跃人数
第 1 周XXX
第 2 周XXX
第 3 周XXX
第 4 周XXX
周次新建文档更新文档活跃人数
第 1 周XXX
第 2 周XXX
第 3 周XXX
第 4 周XXX

关键发现

关键发现

  1. [趋势发现 1]
  2. [趋势发现 2]
  3. [趋势发现 3]

  1. [趋势发现 1]
  2. [趋势发现 2]
  3. [趋势发现 3]

💡 建议

💡 建议

短期建议(本月可执行)

短期建议(本月可执行)

  1. [建议标题]
    • 现状:[描述]
    • 建议:[具体行动]
    • 预期效果:[效果]
  2. [建议标题]
    • 现状:[描述]
    • 建议:[具体行动]
  1. [建议标题]
    • 现状:[描述]
    • 建议:[具体行动]
    • 预期效果:[效果]
  2. [建议标题]
    • 现状:[描述]
    • 建议:[具体行动]

长期建议(持续改进)

长期建议(持续改进)

  1. [建议标题]:[描述]
  2. [建议标题]:[描述]

  1. [建议标题]:[描述]
  2. [建议标题]:[描述]

📎 附录

📎 附录

数据说明

数据说明

  • 数据来源:语雀团队 API
  • 统计周期:YYYY-MM-DD 至 YYYY-MM-DD
  • 活跃定义:当月有创建或更新文档的行为

📌 本报告基于语雀团队活动数据自动生成。如有疑问请联系团队管理员。
undefined
  • 数据来源:语雀团队 API
  • 统计周期:YYYY-MM-DD 至 YYYY-MM-DD
  • 活跃定义:当月有创建或更新文档的行为

📌 本报告基于语雀团队活动数据自动生成。如有疑问请联系团队管理员。
undefined

Step 5: Save to Yuque

步骤5:保存到语雀

Tool: yuque_create_doc
Parameters:
  repo_id: "<namespace>"    # e.g., "mygroup/mybook"
  title: "团队知识管理月报 - YYYY年MM月"
  body: "<formatted report>"
  format: "markdown"
Tool: yuque_create_doc
Parameters:
  repo_id: "<namespace>"    # e.g., "mygroup/mybook"
  title: "团队知识管理月报 - YYYY年MM月"
  body: "<formatted report>"
  format: "markdown"

Step 6: Confirm

步骤6:结果确认

markdown
✅ 知识月报已生成!

📄 **[团队知识管理月报 - YYYY年MM月](文档链接)**
📚 已归档到:「知识库名称」
markdown
✅ 知识月报已生成!

📄 **[团队知识管理月报 - YYYY年MM月](文档链接)**
📚 已归档到:「知识库名称」

本月亮点

本月亮点

  • 共产出 X 篇新文档,X 篇更新
  • 活跃成员 X 人,占比 X%
  • 最活跃知识库:[库名]
  • 最大贡献者:[姓名]
undefined
  • 共产出 X 篇新文档,X 篇更新
  • 活跃成员 X 人,占比 X%
  • 最活跃知识库:[库名]
  • 最大贡献者:[姓名]
undefined

Guidelines

使用规范

  • Health scores (⭐) are subjective assessments based on the data — be honest but constructive
  • For contribution distribution, highlight if knowledge creation is too concentrated (bus factor risk)
  • Suggestions should be specific and actionable, not generic platitudes
  • If month-over-month data is unavailable, omit comparison columns — don't fabricate
  • Keep the tone professional but encouraging — celebrate achievements, frame gaps as opportunities
  • Default language is Chinese
  • 健康度评分(⭐)是基于数据的主观评估——要客观且具有建设性
  • 对于贡献分布,如果知识产出过于集中要特别指出(存在bus factor风险)
  • 建议要具体可执行,不要泛泛而谈
  • 如果没有上月环比数据,省略对比列,不要虚构数据
  • 保持专业且鼓励的语气——肯定成果,将不足表述为改进机会
  • 默认使用中文输出

Error Handling

错误处理

SituationAction
yuque_group_stats
fails
Inform user, check group login and team Token
Any stats API returns partial dataGenerate report with available data, note gaps
Group has very low activityStill generate report, focus suggestions on how to improve
User doesn't know group loginHelp them find it via
yuque_list_repos
Multiple groupsAsk user which group to report on
Team Token missing statistic:readInform user the Token needs
statistic:read
permission
场景处理方式
yuque_group_stats
调用失败
告知用户,检查group login和团队Token
任意统计API返回部分数据使用可用数据生成报告,注明数据缺失
团队活跃度极低仍然生成报告,建议聚焦于如何提升活跃度
用户不知道group login通过
yuque_list_repos
工具帮助用户查找
存在多个团队询问用户需要生成哪个团队的报告
团队Token缺少statistic:read权限告知用户Token需要拥有
statistic:read
权限