Onboarding Guide — 新人阅读指南生成器
用途
扫描团队语雀知识库,识别核心文档,生成按周次和优先级组织的结构化入职阅读指南。
适用场景
- 新成员加入团队,需要一份阅读清单
- 用户提出“帮新人整理入职文档”“create onboarding guide”“新人入职知识包”等需求
- 团队负责人希望制定标准化的入职阅读计划
所需 MCP 工具
均来自 yuque-mcp 服务:
- yuque_list_books — 列出团队所有知识库
- yuque_get_toc — 获取每个知识库的目录
- yuque_get_doc — (可选)阅读特定文档以生成摘要
- yuque_group_members — 获取团队成员列表(用于指定导师)
- yuque_create_doc — 创建入职指南文档
工作流程
第一步:确定团队与背景
从用户处收集:
- 团队标识(group login):必填,团队的语雀 group login
- 新人角色:可选,如前端开发、后端开发、产品经理、设计师
- 入职日期:可选,用于时间线规划
- 特殊关注:可选,需优先关注的议题
若用户未指定团队标识,询问:“请告诉我团队的语雀团队标识(group login),我来生成入职阅读指南。”若未指定角色,则生成通用指南。
第二步:扫描知识库
- 调用 yuque_list_books,参数 login 为团队标识,type 为 group。
- 对返回的每个知识库调用 yuque_get_toc,参数 namespace 为知识库命名空间,收集所有文档标题、slug 和层级信息。
- 调用 yuque_group_members,参数 login 为团队标识,用于推荐导师或联系人。
第三步:分类与排序
按标题和位置将文档分为优先级层级:
第一周必读(Tier 1)——标题或路径中出现:入职、新人、指南、规范、流程;README、Getting Started、Overview;团队介绍、组织架构、文化;开发环境、环境搭建、Quick Start;代码规范、提交规范、Review 流程。
第二周推荐(Tier 2)——关键词:架构、设计、技术方案;产品文档、需求文档;部署、发布、运维;API 文档、接口文档。
第三周扩展(Tier 3)——关键词:历史决策、技术选型;复盘、总结、经验;进阶、深入、原理。
若指定了角色,则提升与该角色相关文档的优先级。
第四步:(可选)阅读关键文档生成摘要
对第一周文档(最多 5 篇),可选调用 yuque_get_doc,参数 namespace 为知识库 slug,slug 为文档 slug,为每篇生成 1-2 句摘要。
第五步:生成入职指南
使用模板,包含:标题、团队、适用角色、生成日期、预计阅读周期(3 周);使用说明;第一周快速上手(含必读文档表格与 Checklist);第二周深入了解(含推荐文档表格与 Checklist);第三周扩展阅读;知识库导航表格;Tips;以及自动生成说明。
第六步:保存到语雀
调用 yuque_create_doc,参数:repo_id 为命名空间(如 mygroup/mybook),title 为“新人入职阅读指南 - [角色] - YYYY-MM-DD”,body 为格式化后的指南,format 为 markdown。
第七步:确认
输出生成成功信息,包含文档链接、保存位置,以及概览:扫描了 X 个知识库、共 X 篇文档,筛选出 X 篇核心文档,按 3 周计划组织阅读路径。
使用准则
- 广度优先于深度,覆盖所有重要知识库,而非单一知识库
- 阅读时间估算:短文档约 5 分钟,长文档约 15 分钟,复杂技术文档约 30 分钟
- 若某知识库缺少明确的“入门”文档,标注为缺口
- 根据指定角色调整 Checklist 项
- 保持指南可执行,每项都应有明确链接
- 使用 yuque_group_members 信息推荐导师
错误处理
- yuque_list_books 返回空:请用户核实团队标识与团队 Token
- 某知识库 yuque_get_toc 失败:跳过该知识库并在指南中注明
- yuque_group_members 失败:跳过导师推荐,仍生成指南
- 团队文档极少(<10):生成简化版指南,建议团队补充文档
- 团队文档极多(>100):更有选择性,聚焦最重要的 20-30 篇
- 无匹配指定角色的文档:回退为通用指南,并注明缺少角色相关文档
- 未提供团队标识:向用户询问 group login
- 未配置团队 Token:告知用户团队功能需团队级 Token
限制
资料未提供具体收费、价格、平台版本或效果保证信息。