analyzing-projects

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Analyzing Projects

项目分析

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

复制以下检查清单并跟踪进度：

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

步骤1：快速概览

bash

undefined

bash

undefined

Check for common project markers

ls -la cat README.md 2>/dev/null | head -50

undefined

ls -la cat README.md 2>/dev/null | head -50

undefined

Step 2: Tech Stack Detection

步骤2：技术栈检测

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

```
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

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

```
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

步骤3：项目结构分析

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

以带注释的树形结构呈现：

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

步骤4：关键模式识别

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.

查找并报告以下内容：

架构：Monolith, Microservices, Serverless, Monorepo
API风格：REST, GraphQL, gRPC, tRPC
状态管理：Redux, Zustand, MobX, Context
数据库：SQL, NoSQL, ORM used
认证方式：JWT, OAuth, Sessions
测试框架：Jest, Pytest, Go test, etc.

Step 5: Development Workflow

步骤5：开发流程

Check for:

```
.eslintrc
```
,
```
.prettierrc
```
→ Linting/Formatting
```
.husky/
```
→ Git hooks
```
Makefile
```
→ Build commands
```
scripts/
```
in package.json → NPM scripts

检查以下内容：

```
.eslintrc
```
,
```
.prettierrc
```
→ Linting/Formatting
```
.husky/
```
→ Git hooks
```
Makefile
```
→ 构建命令
```
scripts/
```
in package.json → NPM脚本

Step 6: Output Format

步骤6：输出格式

Generate a summary using this template:

markdown

undefined

使用以下模板生成摘要：

markdown

undefined

Project: [Name]

Overview

[1-2 sentence description]

Tech Stack

Category	Technology
Language	TypeScript
Framework	Next.js 14
Database	PostgreSQL
...	...

Category	Technology
Language	TypeScript
Framework	Next.js 14
Database	PostgreSQL
...	...

Architecture

[Description with simple ASCII diagram if helpful]

Key Directories

```
src/
```
- [purpose]
```
lib/
```
- [purpose]

```
src/
```
- [purpose]
```
lib/
```
- [purpose]

Entry Points

Main:
```
src/index.ts
```
API:
```
src/api/
```
Tests:
```
npm test
```

Main:
```
src/index.ts
```
API:
```
src/api/
```
Tests:
```
npm test
```

Conventions

[Naming conventions]
[File organization patterns]
[Code style preferences]

[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`

undefined

Action	Command
Install	`npm install`
Dev	`npm run dev`
Test	`npm test`
Build	`npm run build`

undefined

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.

完成分析后，验证以下内容：

Analysis Validation:
- [ ] All major directories explained
- [ ] Tech stack accurately identified
- [ ] Entry points documented
- [ ] Development commands verified working
- [ ] No assumptions made without evidence

如果有任何项无法验证，请在报告中注明“needs clarification”。