编程教学案例优化提示词模板¶

模板概述¶

本模板用于指导AI优化编程教学案例，确保案例结构清晰、目标明确、代码可读。

核心提示词结构¶

基础模板¶

请按照以下要求优化编程教学案例：

【案例内容】
[在此处粘贴原始案例内容]

【优化要求】
1. 保持简洁和重点突出
2. 按照以下结构组织：
   - 场景描述：明确应用场景
   - 前置引导：展示待处理数据，说明任务要求
   - 预期结果：在代码示例前展示完整的目标输出
   - 解决方案：提供具体的实现代码
   - 方法说明：总结技术要点和适用场景
3. 不同的实现方法要分成独立的代码块
4. 代码要能够前后对照，便于理解
5. 确保待处理的数据与结果预期前置

详细模板¶

请优化以下编程教学案例，使其更适合初学者学习：

【原始案例】
[案例标题]
[案例描述]
[现有代码]

【优化目标】
- 教学结构：场景描述 → 前置引导 → 预期结果 → 解决方案 → 方法说明
- 代码组织：不同方法分别展示，避免信息过载
- 学习引导：提供明确的目标和验证标准
- 实践导向：学生可以对照预期结果验证代码

【具体要求】
1. 在解决方案前添加"预期结果"部分，展示完整的输出示例
2. 将待处理的数据放在"前置引导"中
3. 如果案例包含多种实现方法，请分别用独立的代码块展示
4. 在代码块后添加简短的方法说明
5. 保持语言简洁，重点突出核心概念

特殊场景扩展¶

针对初学者友好性¶

【特殊要求】
- 如果案例使用了高级数据结构（如字典），请提供不使用该结构的替代方案
- 确保代码示例可以从简单到复杂渐进学习
- 为每个关键步骤添加注释说明

针对代码重构¶

【重构重点】
- 修复任务描述与解决方案不一致的问题
- 确保示例代码能够实际运行并产生预期结果
- 添加必要的错误处理和边界情况说明

使用示例¶

示例1：优化字符串处理案例¶

请按照编程教学案例优化模板，改进以下字符串处理案例：

【原始案例】
## 案例：命令行帮助文档格式化

### 场景描述
为Python工具创建命令行帮助文档。

### 任务
创建格式化的帮助信息...

【优化要求】
1. 添加前置引导展示原始数据
2. 在代码前添加预期结果
3. 将不同的实现方法分开展示
4. 保持简洁重点突出

示例2：优化数据处理案例¶

请优化以下数据处理教学案例：

【案例内容】
[粘贴案例4的用户数据清洗内容]

【特殊要求】
- 提供不使用字典的替代方案
- 确保代码可以从简单到复杂渐进学习
- 添加清晰的预期结果展示

最佳实践提示¶

明确边界：清晰说明需要优化的具体案例范围
提供上下文：如果可能，提供相关案例作为参考风格
指定格式：明确要求使用Markdown格式和代码块
迭代优化：可以要求AI先分析问题，再提出改进方案
验证要求：要求AI确保优化后的代码能够正常运行

质量检查清单¶

[ ] 案例结构是否符合模板要求
[ ] 预期结果是否清晰明确
[ ] 代码是否分成独立的逻辑块
[ ] 方法说明是否简洁有用
[ ] 整体是否保持简洁重点突出