Back to Details

yuque-group-onboarding-guide

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Onboarding Guide — New Member Reading Guide Generator

入职指南——新成员阅读指南生成器

Scan a team's Yuque knowledge bases, identify core documents, and generate a structured onboarding reading guide organized by week and priority.
扫描团队的Yuque知识库，识别核心文档，生成按周和优先级组织的结构化入职阅读指南。

When to Use

适用场景

  • A new group member is joining and needs a reading list
  • User says "帮新人整理入职文档", "create onboarding guide", "新人入职知识包"
  • Team lead wants to create a standard onboarding reading plan
  • 有新团队成员即将加入，需要一份阅读清单
  • 用户说「帮新人整理入职文档」、「create onboarding guide」、「新人入职知识包」
  • 团队负责人想要创建标准的入职阅读计划

Required MCP Tools

所需MCP工具

All tools are from the 
yuque-mcp
server:
  • yuque_list_repos
    — List all knowledge bases in the team
  • yuque_get_toc
    — Get the table of contents for each knowledge base
  • yuque_get_doc
    — (Optional) Read specific docs for summary
  • yuque_group_members
    — Get group member list (for mentor assignment)
  • yuque_create_doc
    — Create the onboarding guide document
所有工具都来自
yuque-mcp
服务器：
  • yuque_list_repos
    — 列出团队内所有知识库
  • yuque_get_toc
    — 获取每个知识库的目录
  • yuque_get_doc
    — （可选）读取特定文档生成摘要
  • yuque_group_members
    — 获取团队成员列表（用于分配导师）
  • yuque_create_doc
    — 创建入职指南文档

Workflow

工作流程

Step 1: Identify the Team and Context

步骤1：确认团队和上下文信息

Gather from the user:
FieldRequiredDescription
团队标识 (Group login)YesThe team's Yuque group login
新人角色 (Role)Noe.g., 前端开发、后端开发、产品经理、设计师
入职日期 (Start date)NoFor timeline planning
特殊关注 (Focus areas)NoAny specific topics to prioritize
If the user doesn't specify a group login, ask: "请告诉我团队的语雀团队标识（group login），我来生成入职阅读指南。"
If the user doesn't specify a role, generate a general-purpose guide.
从用户处收集以下信息：
字段必填描述
团队标识 (Group login)是团队的Yuque团队登录标识
新人角色 (Role)否例如：前端开发、后端开发、产品经理、设计师
入职日期 (Start date)否用于时间线规划
特殊关注 (Focus areas)否需要优先覆盖的特定主题
如果用户未指定团队标识，询问：「请告诉我团队的语雀团队标识（group login），我来生成入职阅读指南。」
如果用户未指定角色，则生成通用版本的指南。

Step 2: Scan Knowledge Bases

步骤2：扫描知识库

2a. List All Repos

2a. 列出所有知识库

Tool: yuque_list_repos
Parameters:
  login: "<group_login>"
  type: "group"
Tool: yuque_list_repos
Parameters:
  login: "<group_login>"
  type: "group"

2b. Get TOC for Each Repo

2b. 获取每个知识库的目录

For each knowledge base returned, get its table of contents:
Tool: yuque_get_toc
Parameters:
  namespace: "<repo_namespace>"
Collect all document titles, slugs, and hierarchy information.
针对返回的每个知识库，获取其目录：
Tool: yuque_get_toc
Parameters:
  namespace: "<repo_namespace>"
收集所有文档标题、slugs和层级信息。

2c. Get Team Members

2c. 获取团队成员列表

Tool: yuque_group_members
Parameters:
  login: "<group_login>"
Use this to suggest a mentor or point of contact for the new member.
Tool: yuque_group_members
Parameters:
  login: "<group_login>"
用该信息为新成员推荐导师或对接人。

Step 3: Categorize and Prioritize Documents

步骤3：对文档进行分类和优先级划分

Classify documents into priority tiers based on title and location:
Tier 1 — 第一周必读 (Week 1: Must Read) Keywords to look for in titles/paths:
  • 入职、新人、指南、规范、流程
  • README, Getting Started, Overview
  • 团队介绍、组织架构、文化
  • 开发环境、环境搭建、Quick Start
  • 代码规范、提交规范、Review 流程
Tier 2 — 第二周推荐 (Week 2: Recommended) Keywords:
  • 架构、设计、技术方案
  • 产品文档、需求文档
  • 部署、发布、运维
  • API 文档、接口文档
Tier 3 — 第三周扩展 (Week 3: Extended) Keywords:
  • 历史决策、技术选型
  • 复盘、总结、经验
  • 进阶、深入、原理
If the user specified a role, boost documents relevant to that role.
根据标题和位置将文档划分为不同优先级层级：
层级1 — 第一周必读 (Week 1: Must Read) 标题/路径中匹配的关键词：
  • 入职、新人、指南、规范、流程
  • README, Getting Started, Overview
  • 团队介绍、组织架构、文化
  • 开发环境、环境搭建、Quick Start
  • 代码规范、提交规范、Review 流程
层级2 — 第二周推荐 (Week 2: Recommended) 关键词：
  • 架构、设计、技术方案
  • 产品文档、需求文档
  • 部署、发布、运维
  • API 文档、接口文档
层级3 — 第三周扩展 (Week 3: Extended) 关键词：
  • 历史决策、技术选型
  • 复盘、总结、经验
  • 进阶、深入、原理
如果用户指定了角色，优先推送与该角色相关的文档。

Step 4: (Optional) Read Key Documents for Summaries

步骤4：（可选）读取核心文档生成摘要

For Tier 1 documents (up to 5), optionally read them to provide brief summaries:
Tool: yuque_get_doc
Parameters:
  namespace: "<book_slug>"
  slug: "<doc_slug>"
Generate a 1-2 sentence summary for each.
针对第一周必读文档（最多5篇），可选择读取内容生成简短摘要：
Tool: yuque_get_doc
Parameters:
  namespace: "<book_slug>"
  slug: "<doc_slug>"
为每篇文档生成1-2句话的摘要。

Step 5: Generate the Onboarding Guide

步骤5：生成入职指南

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

🎯 新人入职阅读指南

🎯 新人入职阅读指南

团队：[团队名称] 适用角色：[角色，如"通用" / "前端开发"] 生成日期：YYYY-MM-DD 预计阅读周期：3 周
团队：[团队名称] 适用角色：[角色，如"通用" / "前端开发"] 生成日期：YYYY-MM-DD 预计阅读周期：3 周

📖 使用说明

📖 使用说明

欢迎加入团队！这份阅读指南是根据团队知识库自动整理的，帮助你快速了解团队的技术栈、工作流程和核心知识。
建议按周计划阅读，遇到问题随时问团队成员。
欢迎加入团队！这份阅读指南是根据团队知识库自动整理的，帮助你快速了解团队的技术栈、工作流程和核心知识。
建议按周计划阅读，遇到问题随时问团队成员。

📅 第一周：快速上手

📅 第一周：快速上手

目标：了解团队基本情况，搭建开发环境，熟悉工作流程
目标：了解团队基本情况，搭建开发环境，熟悉工作流程

必读文档

必读文档

#文档知识库简介预计时间
1文档标题[库名][一句话简介]~X 分钟
2文档标题[库名][一句话简介]~X 分钟
#文档知识库简介预计时间
1文档标题[库名][一句话简介]~X 分钟
2文档标题[库名][一句话简介]~X 分钟

✅ 第一周 Checklist

✅ 第一周 Checklist

  • 阅读团队介绍文档
  • 完成开发环境搭建
  • 了解代码提交规范
  • 熟悉项目目录结构
  • 阅读团队介绍文档
  • 完成开发环境搭建
  • 了解代码提交规范
  • 熟悉项目目录结构

📅 第二周：深入了解

📅 第二周：深入了解

目标：理解系统架构，熟悉核心业务逻辑
目标：理解系统架构，熟悉核心业务逻辑

推荐文档

推荐文档

#文档知识库简介预计时间
1文档标题[库名][一句话简介]~X 分钟
#文档知识库简介预计时间
1文档标题[库名][一句话简介]~X 分钟

✅ 第二周 Checklist

✅ 第二周 Checklist

  • 理解系统整体架构
  • 熟悉核心业务流程
  • 完成第一个小任务
  • 理解系统整体架构
  • 熟悉核心业务流程
  • 完成第一个小任务

📅 第三周：扩展阅读

📅 第三周：扩展阅读

目标：了解技术决策背景，建立全局视野
目标：了解技术决策背景，建立全局视野

扩展文档

扩展文档

#文档知识库简介
1文档标题[库名][一句话简介]
#文档知识库简介
1文档标题[库名][一句话简介]

🗺️ 知识库导航

🗺️ 知识库导航

知识库描述文档数推荐度
库名[描述]X 篇⭐⭐⭐
库名[描述]X 篇⭐⭐
知识库描述文档数推荐度
库名[描述]X 篇⭐⭐⭐
库名[描述]X 篇⭐⭐

💡 Tips

💡 Tips

  • 🔍 善用语雀搜索功能，遇到问题先搜一搜
  • 📝 阅读过程中发现文档过时，欢迎直接更新
  • 💬 有疑问随时在文档下方评论，或找 [mentor 姓名] 交流
  • 📚 这份指南是自动生成的，如有遗漏请反馈
📌 本指南基于团队语雀知识库自动生成，生成时间：YYYY-MM-DD
undefined
  • 🔍 善用语雀搜索功能，遇到问题先搜一搜
  • 📝 阅读过程中发现文档过时，欢迎直接更新
  • 💬 有疑问随时在文档下方评论，或找 [mentor 姓名] 交流
  • 📚 这份指南是自动生成的，如有遗漏请反馈
📌 本指南基于团队语雀知识库自动生成，生成时间：YYYY-MM-DD
undefined

Step 6: Save to Yuque

步骤6：保存到Yuque

Tool: yuque_create_doc
Parameters:
  repo_id: "<namespace>"    # e.g., "mygroup/mybook"
  title: "新人入职阅读指南 - [角色] - YYYY-MM-DD"
  body: "<formatted guide>"
  format: "markdown"
Tool: yuque_create_doc
Parameters:
  repo_id: "<namespace>"    # 例如："mygroup/mybook"
  title: "新人入职阅读指南 - [角色] - YYYY-MM-DD"
  body: "<formatted guide>"
  format: "markdown"

Step 7: Confirm

步骤7：确认通知

markdown
✅ 入职阅读指南已生成！

📄 **[新人入职阅读指南](文档链接)**
📚 已保存到：「知识库名称」
markdown
✅ 入职阅读指南已生成！

📄 **[新人入职阅读指南](文档链接)**
📚 已保存到：「知识库名称」

概览

概览

  • 扫描了 X 个知识库，共 X 篇文档
  • 筛选出 X 篇核心文档
  • 按 3 周计划组织阅读路径
undefined
  • 扫描了 X 个知识库，共 X 篇文档
  • 筛选出 X 篇核心文档
  • 按 3 周计划组织阅读路径
undefined

Guidelines

规则说明

  • Prioritize breadth over depth — the guide should cover all important repos, not just one
  • Estimate reading time: ~5 min for short docs, ~15 min for long ones, ~30 min for complex technical docs
  • If a repo has no clear "getting started" doc, note it as a gap
  • Tailor the checklist items to the specified role
  • Keep the guide actionable — every item should have a clear link
  • Use group member info from 
    yuque_group_members
    to suggest a mentor
  • 优先保证广度而非深度——指南应覆盖所有重要知识库，而非仅聚焦单个库
  • 预估阅读时长：短文档约5分钟，长文档约15分钟，复杂技术文档约30分钟
  • 如果某个知识库没有明确的入门文档，标注为缺失项
  • 根据指定角色定制检查清单项
  • 保证指南可落地——每个条目都应有明确链接
  • 使用
    yuque_group_members
    返回的团队成员信息推荐导师

Error Handling

错误处理

SituationAction
yuque_list_repos
returns empty		Ask user to verify group login and group Token
yuque_get_toc
fails for a repo		Skip that repo, note it in the guide
yuque_group_members
fails		Skip mentor suggestion, still generate the guide
Team has very few docs (<10)Create a simpler guide, suggest the group build more docs
Team has many docs (>100)Be more selective, focus on top 20-30 most important
No docs match the specified roleFall back to general guide, note role-specific docs are missing
Group login not providedAsk user for the team's group login
Team Token not configuredInform user that group features require a team-level Token
场景处理方式
yuque_list_repos
返回空结果		要求用户确认团队标识和团队Token是否正确
某个知识库调用
yuque_get_toc
失败		跳过该知识库，在指南中注明
yuque_group_members
调用失败		跳过导师推荐，仍正常生成指南
团队文档极少（<10篇）生成更简洁的指南，建议团队补充更多文档
团队文档过多（>100篇）提高筛选标准，重点选取前20-30篇最重要的文档
没有匹配指定角色的文档回退到通用指南，注明缺少角色专属文档
未提供团队标识询问用户索要团队的group login
未配置团队Token告知用户团队功能需要团队级Token