Pre-Work Research

前置研究

Overview

概述

Research before coding. Understand the landscape before changing it.

Core principle: Measure twice, cut once.

Announce at start: "I'm researching the codebase and documentation before implementing."

编码前先做研究。在修改现有系统前先了解其全貌。

核心原则：三思而后行。

开始时告知：“我正在研究代码库和文档，之后再进行实现。”

When to Research

何时需要研究

Research is appropriate when:

Situation	Research Needed
Unfamiliar area of codebase	Yes
New library or API	Yes
Complex integration	Yes
Performance-sensitive code	Yes
Security-sensitive code	Yes
Simple, isolated change	Minimal

以下场景需要进行研究：

场景	是否需要研究
不熟悉的代码区域	是
新的库或API	是
复杂集成	是
性能敏感型代码	是
安全敏感型代码	是
简单、独立的修改	少量即可

The Research Protocol

研究流程

Step 1: Understand Requirements

步骤1：理解需求

Before researching implementation:

Read the full issue description
Review all acceptance criteria
Note any constraints mentioned
Identify unknowns

在研究实现方案前：

完整阅读问题描述
查看所有验收标准
记录提到的约束条件
识别未知点

Step 2: Research Repository Documentation

步骤2：研究仓库文档

bash

undefined

bash

undefined

Project overview

项目概述

cat README.md

Architecture/design docs

架构/设计文档

ls -la docs/ find . -name ".md" -path "./docs/"

Contributing guidelines

贡献指南

cat CONTRIBUTING.md

API documentation

API文档

cat docs/api*.md cat docs/architecture*.md


**Look for:**
- Architecture decisions
- Design patterns used
- Coding conventions
- Testing requirements
- Deployment considerations

cat docs/api*.md cat docs/architecture*.md


**重点关注：**
- 架构决策
- 使用的设计模式
- 编码规范
- 测试要求
- 部署注意事项

Step 3: Research Existing Codebase

步骤3：研究现有代码库

Find Similar Implementations

查找类似实现

bash

undefined

bash

undefined

Find similar features

查找类似功能

grep -r "similar keyword" src/

Find related tests

查找相关测试

grep -r "similar keyword" **/.test.

Find imports of relevant modules

查找相关模块的导入

grep -r "import.*ModuleName" src/

undefined

grep -r "import.*ModuleName" src/

undefined

Understand Patterns

理解现有模式

bash

undefined

bash

undefined

How are similar things done?

类似功能是如何实现的？

Look at 2-3 examples of similar functionality

查看2-3个类似功能的示例

Example: If adding an API endpoint

示例：如果添加API端点

grep -r "router." src/routes/ cat src/routes/[existing-endpoint].ts

Example: If adding a service

示例：如果添加服务

ls -la src/services/ cat src/services/[existing-service].ts

undefined

ls -la src/services/ cat src/services/[existing-service].ts

undefined

Check for Utilities

检查可用工具类

bash

undefined

bash

undefined

What utilities exist?

有哪些工具类可用？

ls -la src/utils/ cat src/utils/[relevant-util].ts

Are there shared helpers?

是否有共享的辅助函数？

grep -r "export function" src/utils/

undefined

grep -r "export function" src/utils/

undefined

Step 4: Research External Resources

步骤4：研究外部资源

When using external APIs or libraries:

当使用外部API或库时：

Official Documentation

官方文档

bash

undefined

bash

undefined

Read the docs for dependencies

查看依赖包的信息

pnpm info [package-name]

Then visit documentation URL

然后访问文档URL

undefined

Search: "[library-name] documentation" Search: "[library-name] getting started" Search: "[library-name] [specific feature]"

undefined

undefined

搜索："[library-name] documentation" 搜索："[library-name] getting started" 搜索："[library-name] [specific feature]"

undefined

API References

API参考

For external APIs:

Authentication requirements
Rate limits
Error handling
Response formats
Versioning

对于外部API：

认证要求
请求限制
错误处理
响应格式
版本控制

Community Resources

社区资源

GitHub issues for common problems
Stack Overflow for patterns
Blog posts for best practices

GitHub上的常见问题
Stack Overflow上的实现模式
关于最佳实践的博客文章

Step 5: Document Findings

步骤5：记录研究结果

Create a research summary:

markdown

undefined

创建研究总结：

markdown

undefined