Project Onboarding Skill

一个帮助开发者快速了解新项目的 Claude Code 技能，自动生成详细的项目入职指南文档。

功能特性

• 🔍 项目扫描 - 自动分析项目结构、技术栈、配置文件
• 📋 文档生成 - 生成完整的 Markdown 入职指南
• 🎨 HTML 可视化 - 可选的精美 HTML 页面输出
• 🚀 多语言支持 - 支持后端项目的多种技术栈

生成的文档包含

1. 项目概述 - 项目介绍、核心功能
2. 技术栈 - 语言、框架、依赖库
3. 项目架构 - 架构图、模块划分
4. 目录结构 - 完整目录树、重要文件说明
5. 环境配置 - 环境要求、搭建步骤
6. 开发指南 - 如何开发新模块（含代码示例）
7. 常用命令 - 构建、测试、启动命令
8. 部署指南 - Docker、CI/CD 部署流程
9. 访问方式 - 端口、连接示例
10. 常见问题 - FAQ 及解决方案

安装方法

方法一：直接复制

将 project-onboarding 目录复制到你的 Claude Code skills 目录：

cp -r project-onboarding ~/.claude/skills/

方法二：使用 .skill 文件

# 打包技能
python -m scripts.package_skill project-onboarding

# 然后在 Claude Code 中安装 .skill 文件

使用方法

在 Claude Code 中，使用以下提示词触发技能：

帮我了解这个项目
这个项目怎么跑起来
项目架构是什么
怎么开发一个新模块
项目怎么部署
帮我快速上手这个项目

示例输出

生成的文档示例：

• Markdown: ONBOARDING.md
• HTML: onboarding.html

目录结构

project-onboarding/
├── SKILL.md              # 技能主文件
└── assets/
    └── template.html     # HTML 可视化模板

技术要求

• Claude Code CLI
• 支持 Go、Java、Python、Node.js 等后端项目

License

MIT License

贡献

欢迎提交 Issue 和 Pull Request！