ask-readme-gardener

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

<critical_constraints> ✅ MUST maintain existing README style and headers ✅ MUST identify correct section (API Reference, Usage, Features) ✅ MUST document: method, URL, parameters, response for endpoints </critical_constraints>

<workflow> 1. **Analyze**: Understand new feature, API, or change 2. **Locate**: Find relevant section in README.md 3. **Draft**: Write update matching existing style 4. **Update**: Edit README.md directly </workflow>

<api_template>

markdown

undefined

<critical_constraints> ✅ 必须保持现有README的风格和标题 ✅ 必须确定正确的章节（API参考、使用方法、功能特性） ✅ 必须记录：端点的方法、URL、参数、响应 </critical_constraints>

<workflow> 1. **分析**：理解新功能、API或变更内容 2. **定位**：在README.md中找到相关章节 3. **撰写**：按照现有风格编写更新内容 4. **更新**：直接编辑README.md </workflow>

<api_template>

markdown

undefined

GET /status

Returns the current system status.

Response

json

{ "status": "ok", "uptime": 1234 }

</api_template>

<patterns>
- New endpoint → add to API Reference with method, URL, params, response
- Modified feature → update existing description
- New feature → add bullet or section describing usage
</patterns>

返回当前系统状态。

响应

json

{ "status": "ok", "uptime": 1234 }

</api_template>

<patterns>
- 新端点 → 添加至API参考章节，包含方法、URL、参数、响应
- 已修改功能 → 更新现有描述
- 新功能 → 添加项目符号或章节描述使用方法
</patterns>