技术写作¶

Subject: Question about [具体问题]

Hi [Name],

[一句话背景].

Could you take a look at [具体内容] when you have a moment?
[可选: 为什么需要帮助 / 截止时间]

Thanks!
[Your Name]

Subject: Re: [原标题]

Hi [Name],

Got it, thanks. I'll [下一步动作] by [时间].

[Your Name]

Subject: Re: [原标题]

Hi [Name],

Just following up on this — any thoughts?
No rush if you're busy.

Thanks!
[Your Name]

Subject: Thanks for [具体事]

Hi [Name],

Thanks for [具体帮助] — [简短说明为什么有帮助].

[Your Name]

Subject: [FYI] [简短描述]

Hi team,

Just a heads up: [变更内容].

[可选: 影响范围 / 链接]

No action needed.
[Your Name]

## What

[做了什么，一句话]

## Why

[为什么这样做，1-2 句]

## How

[怎么做的，可选：关键改动点]

- [改动 1]
- [改动 2]

## Test

[怎么测试的]

- [ ] Unit tests passed
- [ ] Tested locally with [场景]

## What

Add retry logic to the payment service for transient network errors.

## Why

The payment gateway occasionally returns 503 errors during peak hours.
Retrying once with exponential backoff reduces the failure rate from 0.5% to < 0.01%.

## How

- Added `RetryableRestTemplate` with max 3 retries and exponential backoff
- Made retry behavior configurable via `application.yml`
- Added metrics for retry attempts and success rate

## Test

- [x] Unit tests for retry logic
- [x] Integration test with WireMock simulating 503 → 200
- [x] Tested locally with 1000 concurrent requests

# [Title]: [一句话描述]

**Author**: [Name]
**Date**: [YYYY-MM-DD]
**Status**: Draft | In Review | Approved | Implemented

## Problem

[当前存在的问题，用数据说话]

## Goals & Non-Goals

**Goals:**
- [目标 1]
- [目标 2]

**Non-Goals:**
- [不做什么，划定范围]

## Proposed Solution

[方案描述，配图/伪代码]

## Alternatives Considered

| 方案 | Pros | Cons | 结论 |
|------|------|------|------|
| [方案 A] | ... | ... | ❌ [原因] |
| [方案 B] | ... | ... | ✅ Chosen |

## Trade-offs

[选择这个方案要付出的代价]

## Migration Plan

[如何从旧方案迁移到新方案]

## Open Questions

- [待解决的问题]

/**
 * Retries a failed HTTP request with exponential backoff.
 *
 * Used for idempotent GET requests to tolerate transient network errors
 * without overwhelming the downstream service.
 *
 * @param request  the HTTP request to retry
 * @param maxRetries  maximum number of retry attempts (default: 3)
 * @return the response, or throws the last exception if all retries fail
 */
public Response retryWithBackoff(Request request, int maxRetries) { ... }