本技能旨在帮助开发者快速了解一个新项目。当你刚加入一个团队、接手一个陌生代码库，
或者需要快速评估一个项目的技术栈、架构和开发流程时，本技能提供一套系统化的探索方法。
通过遵循本指南，你将能够：
如果你是第一次使用本技能，可以按以下步骤快速开始：
```bash
python scripts/analyze_project.py
```
首先，确定项目是什么类型（Web 应用、移动应用、后端服务、库等）以及如何启动它。
# 查看根目录下的文件
ls -la
# 寻找常见的项目入口文件
find . -maxdepth 2 -name "*.json" -o -name "*.yml" -o -name "*.yaml" -o -name "*.xml" -o -name "*.gradle" -o -name "*.toml" | head -20
# 检查是否有 Docker 相关文件
ls -la | grep -E "(Dockerfile|docker-compose|.dockerignore)"
通过配置文件识别项目使用的技术：
# 检查 Node.js 项目
if [ -f "package.json" ]; then
cat package.json | grep -E "(name|version|dependencies|devDependencies|scripts)"
fi
# 检查 Python 项目
if [ -f "requirements.txt" ]; then
head -20 requirements.txt
fi
if [ -f "pyproject.toml" ]; then
cat pyproject.toml | head -50
fi
# 检查 Java 项目
if [ -f "pom.xml" ]; then
cat pom.xml | grep -E "(groupId|artifactId|version|dependencies)" | head -20
fi
if [ -f "build.gradle" ]; then
cat build.gradle | head -50
fi
# 检查 Go 项目
if [ -f "go.mod" ]; then
cat go.mod
fi
理解项目的代码组织方式：
# 查看主要目录
find . -type d -maxdepth 2 | sort
# 查看源代码目录（通常为 src/, app/, lib/, 等）
ls -la src/ 2>/dev/null || ls -la app/ 2>/dev/null || ls -la lib/ 2>/dev/null
# 查看测试目录
find . -type d -name "*test*" -o -name "*spec*" | head -10
配置文件往往包含项目运行所需的关键信息：
# 环境配置文件
find . -name ".env*" -o -name "config*" -o -name "settings*" | head -10
# 数据库配置
grep -r "DATABASE_URL\|DB_HOST\|DB_PASSWORD" . --include="*.yml" --include="*.yaml" --include="*.json" --include="*.properties" 2>/dev/null | head -5
# API 密钥和敏感配置（注意安全）
find . -name "*.key" -o -name "*.pem" -o -name "*secret*" | head -5
项目如何构建、测试和运行：
# 查看构建脚本
cat package.json 2>/dev/null | grep -A5 -B5 "scripts"
cat Makefile 2>/dev/null | head -30
# 尝试运行测试
if [ -f "package.json" ]; then
npm test -- --dry-run 2>/dev/null || echo "查看 package.json 中的 test 脚本"
fi
# 检查 CI/CD 配置
find . -name ".github" -type d -o -name ".gitlab" -type d -o -name ".circleci" -type d | head -5
项目如何部署到生产环境：
# 查找部署配置
find . -name "Dockerfile" -o -name "docker-compose*.yml" -o -name "*.sh" | grep -i deploy | head -10
# 检查云服务配置
find . -name "serverless*.yml" -o -name "terraform*.tf" -o -name "k8s*.yaml" -o -name "helm" -type d | head -10
# 查看 .github/workflows 或 .gitlab-ci.yml
ls -la .github/workflows/ 2>/dev/null || cat .gitlab-ci.yml 2>/dev/null | head -30
项目文档是了解项目的最佳资源：
# 查找 README 文件
find . -name "README*" -o -name "CONTRIBUTING*" | head -5
# 查看 docs/ 目录
ls -la docs/ 2>/dev/null
# 查找代码注释中的设计文档
grep -r "TODO\|FIXME\|HACK\|NOTE" . --include="*.js" --include="*.py" --include="*.java" --include="*.go" 2>/dev/null | head -10
使用以下检查清单确保你覆盖了所有重要方面：
本技能提供以下脚本帮助你自动分析项目：
一个 Python 脚本，自动收集项目信息并生成报告。
使用方法：
python scripts/analyze_project.py
功能：
一个 Shell 脚本，快速检测项目使用的技术。
使用方法：
bash scripts/tech_stack_detector.sh
从 README.md 开始，然后运行项目分析脚本。如果 README 缺失或过时，按照本指南的步骤逐一探索。
尝试运行项目的测试套件。如果测试通过，说明项目基本健康。然后尝试在开发模式下启动项目。
查看示例配置文件（如 .env.example, config.sample.yml），或询问团队成员。不要猜测生产环境配置。
根据你的探索结果，选择以下行动之一：
grep 或 IDE 的搜索功能查找特定代码本技能旨在加速你的项目上手过程，但无法替代与团队成员的沟通和代码的深入阅读。
如果你发现本技能缺少某些特定技术的指导，请考虑扩展它以适应你的需求。
共 1 个版本