SuperAPI AI 工具集

yuque-group-onboarding-guide

办公与效率

查看项目

更新于 10-16 04:39

技能介绍

用途

该技能面向团队使用,扫描团队在语雀中的知识库,识别核心文档,并生成按周和优先级组织的结构化新人入职阅读指南。当有新成员加入需要阅读清单、用户提出“帮新人整理入职文档”“create onboarding guide”“新人入职知识包”,或团队负责人希望创建标准入职阅读计划时使用。

主要能力

  • 列出团队全部知识库(yuque_list_repos)
  • 获取每个知识库的目录结构(yuque_get_toc)
  • 可选读取具体文档以生成摘要(yuque_get_doc)
  • 获取团队成员列表,用于建议导师或联系人(yuque_group_members)
  • 创建入职指南文档(yuque_create_doc)
  • 按标题和路径关键词将文档分为三个优先级:第一周必读(入职、新人、指南、规范、流程、README、Getting Started、团队介绍、开发环境、代码规范等)、第二周推荐(架构、设计、技术方案、产品文档、需求文档、部署、发布、运维、API 文档等)、第三周扩展(历史决策、技术选型、复盘、总结、经验、进阶、深入、原理等)
  • 若用户指定角色,则提升与该角色相关文档的优先级
  • 生成包含使用说明、三周阅读计划、知识库导航和 Tips 的 Markdown 指南

使用方式

  1. 收集用户信息:团队标识(group login,必填)、新人角色(可选)、入职日期(可选)、特殊关注(可选)。若未提供团队标识,需询问用户。
  2. 扫描知识库:调用 yuque_list_repos 列出所有知识库,再对每个知识库调用 yuque_get_toc 收集文档标题、slug 和层级信息,并调用 yuque_group_members 获取成员列表。
  3. 分类与优先级排序:根据标题和位置将文档归入三个优先级层级,若指定角色则提升相关文档。
  4. 可选读取第一周文档(最多 5 篇)生成 1-2 句摘要。
  5. 按模板生成指南,包含团队信息、使用说明、三周阅读计划(含文档表格和 Checklist)、知识库导航和 Tips。
  6. 调用 yuque_create_doc 将指南保存到语雀,参数包括 repo_id(如 mygroup/mybook)、标题、正文和 markdown 格式。
  7. 确认生成结果,展示文档链接、保存位置和概览(扫描知识库数、文档数、筛选核心文档数)。

适用场景

  • 新成员入职需要阅读清单
  • 团队负责人制定标准入职阅读计划
  • 需要按角色(如前端开发、后端开发、产品经理、设计师)定制阅读路径

限制

  • 依赖 yuque-mcp 服务器提供的工具,需配置团队级 Token 才能使用团队功能
  • 若 yuque_list_repos 返回空,需用户验证团队标识和 Token
  • 若某个知识库的 yuque_get_toc 失败,将跳过该库并在指南中注明
  • 若 yuque_group_members 失败,将跳过导师建议但仍生成指南
  • 团队文档少于 10 篇时生成简化指南并建议补充文档;多于 100 篇时聚焦最重要的 20-30 篇
  • 若无匹配指定角色的文档,回退到通用指南并注明缺少角色专属文档
  • 阅读时间估算:短文档约 5 分钟,长文档约 15 分钟,复杂技术文档约 30 分钟
  • 若知识库没有明确的“入门”文档,会将其标记为缺口
  • 指南中每个条目都应包含明确链接,保持可操作性