# 脚本使用说明与测试方法

## 使用场景

当你不仅要交付脚本本身，还希望让使用者知道如何运行、参数怎么填、如何测试、遇到错误怎么排查时，应要求脚本生成结果附带完整说明材料。

## 操作步骤

1. 在生成脚本任务时，明确要求同时输出：

   - 使用说明
   - 参数说明
   - 调用示例
   - 测试方法

2. 如有关键代码段，也要求系统解释这些部分的作用。
3. 如果你想直接描述完整需求，可以使用类似任务：`请在生成脚本后，同时补充一份使用说明，包含参数说明、调用示例、正常路径测试方法和错误路径测试方法。`
4. 如需面向团队交付，再要求整理成适合分享的配套文档。
5. 生成完成后，先按说明中的调用示例实际执行一次，再按测试方法验证脚本的主要路径和错误处理路径。

## 你会看到的提示与反馈

- 最终交付不只是一份脚本文件，还会附带说明材料。
- 说明中通常会覆盖：

  - 参数用途
  - 典型调用方式
  - 测试步骤
  - 常见错误和处理方式

- 如果你要求交付文档，系统通常会把这些内容整理得更适合阅读和共享。

## 注意事项

- 这是脚本生成专家的配套输出要求，不是单独独立的 CLI 命令。
- 规则明确要求不能只交付脚本而不交付说明。
- 如果脚本后续会给别人使用，这部分文档尤其重要。
- 测试方法应覆盖正常路径和错误路径，避免只证明“脚本能跑”，却没有验证异常处理。
- 如果脚本需要外部依赖、配置文件或权限，最好也要求系统把这些前提写进说明材料。
