SuperAPI AI 工具集

onboarding-docs

写作与研究

查看项目

更新于 10-16 04:04

技能介绍

用途

Onboarding Documentation Skill 用于创建全面的开发者入职文档,帮助新成员加速达到生产力。它适用于以下场景:处理开发者入职文档与学习路径相关任务;需要入职文档方法指导的规划或设计工作;希望遵循既有模式与标准的最佳实践。

该技能强调「文档优先」方法:在创建入职文档之前,需先调用 docs-management 技能获取入职模式,通过 MCP 服务器(perplexity)验证开发者体验最佳实践,并基于行业入职标准提供指导。

主要能力

该技能提供两大模板与一套最佳实践。

入职文档框架

按时间维度分为四层:

  • Day 1:环境搭建——开发环境安装、访问权限与凭据配置、工具配置。
  • Week 1:核心概念——架构概览、代码库导览、开发工作流。
  • Month 1:深入学习——领域知识、系统内部原理、高级工作流。
  • Ongoing:参考资料——API 文档、运行手册与流程、最佳实践与标准。

入职指南模板

模板包含以下章节:快速链接(代码库、文档、问题跟踪、CI/CD、监控、聊天工具)、Day 1 检查清单(访问设置、开发环境、第一步)、环境搭建(前置工具版本表、分步安装命令、环境变量配置、启动开发环境、验证设置)、架构概览(系统上下文、高层架构图、关键组件表)、代码库导览(仓库结构、关键文件、代码约定)、开发工作流(Git 工作流、分支命名、提交信息规范、代码审查流程、测试要求)、常见任务(新增 API 端点、运行数据库迁移、调试)、学习路径(Week 1 基础、Week 2-4 能力建设、Month 2-3 独立)、求助渠道(入职伙伴、团队频道、升级路径)、FAQ 和反馈。

模板中的环境搭建示例使用 .NET SDK 10.0+、Node.js 22 LTS、Docker Desktop、Git 2.40+、VS Code / Rider,并给出 Windows(winget)与 macOS(Homebrew)的安装命令,以及克隆仓库、配置环境变量、启动 Docker Compose、运行数据库迁移、启动应用和验证设置的步骤。

学习路径模板

按三个层级组织:Level 1 基础(第 1 周)、Level 2 中级(第 2-3 周)、Level 3 高级(第 4 周及以后)。每层包含目标、资源表(类型、资源、时间)、练习或项目、检查点。

使用方式

该技能以模板和指导形式提供,用户可将其中的入职指南模板与学习路径模板作为起点,根据自身项目替换占位内容(如 [Project/Team Name]、[GitHub Repo]、[Name] 等)。模板中的代码示例(如 C# 的 GetUser 端点、dotnet ef 迁移命令、日志记录代码)可直接参考。

适用场景

适用于需要为新成员编写入职文档、规划分阶段学习路径、建立团队入职标准与检查清单的团队。也适用于希望系统化整理环境搭建步骤、代码库导览和开发工作流的工程团队。

限制

资料未提供该技能的具体安装命令、收费方式、支持平台或实际运行效果。模板中的技术栈(.NET、Blazor、PostgreSQL 等)为示例内容,并非该技能的强制要求。资料未说明该技能是否支持自定义模板或与其他工具的集成方式。