Analyzing Projects
When to Load
- Trigger: Onboarding to a new project, "how does this work" questions, codebase exploration, understanding unfamiliar code
- Skip: Already familiar with the project structure and patterns
Project Analysis Workflow
Copy this checklist and track progress:
Project Analysis Progress:
- [ ] Step 1: Quick overview (README, root files)
- [ ] Step 2: Detect tech stack
- [ ] Step 3: Map project structure
- [ ] Step 4: Identify key patterns
- [ ] Step 5: Find development workflow
- [ ] Step 6: Generate summary report
Step 1: Quick Overview
# Check for common project markers
ls -la
cat README.md 2>/dev/null | head -50
Step 2: Tech Stack Detection
Package Managers & Dependencies
package.json → Node.js/JavaScript/TypeScript
requirements.txt / pyproject.toml / setup.py → Python
go.mod → Go
Cargo.toml → Rust
pom.xml / build.gradle → Java
Gemfile → Ruby
Frameworks (from dependencies)
- React, Vue, Angular, Next.js, Nuxt
- Express, FastAPI, Django, Flask, Rails
- Spring Boot, Gin, Echo
Infrastructure
Dockerfile, docker-compose.yml → Containerized
kubernetes/, k8s/ → Kubernetes
terraform/, .tf files → IaC
serverless.yml → Serverless Framework
.github/workflows/ → GitHub Actions
Step 3: Project Structure Analysis
Present as a tree with annotations:
project/
├── src/ # Source code
│ ├── components/ # UI components (React/Vue)
│ ├── services/ # Business logic
│ ├── models/ # Data models
│ └── utils/ # Shared utilities
├── tests/ # Test files
├── docs/ # Documentation
└── config/ # Configuration
Step 4: Key Patterns Identification
Look for and report:
- Architecture: Monolith, Microservices, Serverless, Monorepo
- API Style: REST, GraphQL, gRPC, tRPC
- State Management: Redux, Zustand, MobX, Context
- Database: SQL, NoSQL, ORM used
- Authentication: JWT, OAuth, Sessions
- Testing: Jest, Pytest, Go test, etc.
Step 5: Development Workflow
Check for:
.eslintrc, .prettierrc → Linting/Formatting
.husky/ → Git hooks
Makefile → Build commands
scripts/ in package.json → NPM scripts
Step 6: Output Format
Generate a summary using this template:
# Project: [Name]
## Overview
[1-2 sentence description]
## Tech Stack
| Category | Technology |
| --------- | ---------- |
| Language | TypeScript |
| Framework | Next.js 14 |
| Database | PostgreSQL |
| ... | ... |
## Architecture
[Description with simple ASCII diagram if helpful]
## Key Directories
- `src/` - [purpose]
- `lib/` - [purpose]
## Entry Points
- Main: `src/index.ts`
- API: `src/api/`
- Tests: `npm test`
## Conventions
- [Naming conventions]
- [File organization patterns]
- [Code style preferences]
## Quick Commands
| Action | Command |
| ------- | --------------- |
| Install | `npm install` |
| Dev | `npm run dev` |
| Test | `npm test` |
| Build | `npm run build` |
Analysis Validation
After completing analysis, verify:
Analysis Validation:
- [ ] All major directories explained
- [ ] Tech stack accurately identified
- [ ] Entry points documented
- [ ] Development commands verified working
- [ ] No assumptions made without evidence
If any items cannot be verified, note them as "needs clarification" in the report.
1---2name: analyzing-projects3description: Analyzes codebases to understand structure, tech stack, patterns, and conventions. Use when onboarding to a new project, exploring unfamiliar code, or when asked "how does this work?" or "what's the architecture?"4metadata:5 source: https://skillmd.com/skills/cloudai-x/analyzing-projects6---78# Analyzing Projects910### When to Load1112- **Trigger**: Onboarding to a new project, "how does this work" questions, codebase exploration, understanding unfamiliar code13- **Skip**: Already familiar with the project structure and patterns1415## Project Analysis Workflow1617Copy this checklist and track progress:1819```20Project Analysis Progress:21- [ ] Step 1: Quick overview (README, root files)22- [ ] Step 2: Detect tech stack23- [ ] Step 3: Map project structure24- [ ] Step 4: Identify key patterns25- [ ] Step 5: Find development workflow26- [ ] Step 6: Generate summary report27```2829## Step 1: Quick Overview3031```bash32# Check for common project markers33ls -la34cat README.md 2>/dev/null | head -5035```3637## Step 2: Tech Stack Detection3839### Package Managers & Dependencies4041- `package.json` → Node.js/JavaScript/TypeScript42- `requirements.txt` / `pyproject.toml` / `setup.py` → Python43- `go.mod` → Go44- `Cargo.toml` → Rust45- `pom.xml` / `build.gradle` → Java46- `Gemfile` → Ruby4748### Frameworks (from dependencies)4950- React, Vue, Angular, Next.js, Nuxt51- Express, FastAPI, Django, Flask, Rails52- Spring Boot, Gin, Echo5354### Infrastructure5556- `Dockerfile`, `docker-compose.yml` → Containerized57- `kubernetes/`, `k8s/` → Kubernetes58- `terraform/`, `.tf` files → IaC59- `serverless.yml` → Serverless Framework60- `.github/workflows/` → GitHub Actions6162## Step 3: Project Structure Analysis6364Present as a tree with annotations:6566```67project/68├── src/ # Source code69│ ├── components/ # UI components (React/Vue)70│ ├── services/ # Business logic71│ ├── models/ # Data models72│ └── utils/ # Shared utilities73├── tests/ # Test files74├── docs/ # Documentation75└── config/ # Configuration76```7778## Step 4: Key Patterns Identification7980Look for and report:8182- **Architecture**: Monolith, Microservices, Serverless, Monorepo83- **API Style**: REST, GraphQL, gRPC, tRPC84- **State Management**: Redux, Zustand, MobX, Context85- **Database**: SQL, NoSQL, ORM used86- **Authentication**: JWT, OAuth, Sessions87- **Testing**: Jest, Pytest, Go test, etc.8889## Step 5: Development Workflow9091Check for:9293- `.eslintrc`, `.prettierrc` → Linting/Formatting94- `.husky/` → Git hooks95- `Makefile` → Build commands96- `scripts/` in package.json → NPM scripts9798## Step 6: Output Format99100Generate a summary using this template:101102```markdown103# Project: [Name]104105## Overview106107[1-2 sentence description]108109## Tech Stack110111| Category | Technology |112| --------- | ---------- |113| Language | TypeScript |114| Framework | Next.js 14 |115| Database | PostgreSQL |116| ... | ... |117118## Architecture119120[Description with simple ASCII diagram if helpful]121122## Key Directories123124- `src/` - [purpose]125- `lib/` - [purpose]126127## Entry Points128129- Main: `src/index.ts`130- API: `src/api/`131- Tests: `npm test`132133## Conventions134135- [Naming conventions]136- [File organization patterns]137- [Code style preferences]138139## Quick Commands140141| Action | Command |142| ------- | --------------- |143| Install | `npm install` |144| Dev | `npm run dev` |145| Test | `npm test` |146| Build | `npm run build` |147```148149## Analysis Validation150151After completing analysis, verify:152153```154Analysis Validation:155- [ ] All major directories explained156- [ ] Tech stack accurately identified157- [ ] Entry points documented158- [ ] Development commands verified working159- [ ] No assumptions made without evidence160```161162If any items cannot be verified, note them as "needs clarification" in the report.163