---

name: readme-polish description: 提高README的清晰度和完整性。在初级开发者需要指导如何记录设置和用法时使用。

README优化

目的

提高README的清晰度和完整性。

请求输入

• 当前README内容。
• 设置先决条件和运行时版本。
• 常见故障模式或常见问题。

工作流程

1. 确保安装、运行和测试步骤存在且有序。
2. 添加必需的环境变量和配置说明。
3. 澄清预期输出和常见故障排除提示。

输出

• 修订后的README部分建议。
• 缺失项目清单。

质量基准

• 保持说明简洁且可复制粘贴。
• 尽早呈现最常见的陷阱。