01
脚本目录
至少要有可执行主入口,以及能让平台判断用途的最小目录结构。
Onboarding Checklist
重点说明接入前需要准备的信息,方便客户、售前和实施一起对齐。
进入真实场景接入前,最好先把 脚本目录、README、样例文件、运行依赖、结果形式和风险边界 准备清楚。这样后续无论走客户交付、文件处理还是 CLI / 本地桥接,都会顺很多。
01
至少要有可执行主入口,以及能让平台判断用途的最小目录结构。
02
告诉平台脚本做什么、输入什么、输出什么、需要什么前置条件。
03
如果脚本依赖输入文件或会生成结果文件,最好给出样例输入和样例输出。
04
最好先说清是否允许 AI 调用、是否允许手动执行、是否需要人工确认。
Checklist Table
| 准备项 | 是否建议先给 | 为什么重要 | 建议说明 |
|---|---|---|---|
| 脚本目录 | 必须 | 没有执行内容就谈不上接入 | 至少明确主入口和最小目录结构。 |
| README.md | 必须 | 帮助平台审核、命名和后续维护 | 建议写明作用、输入、输出、前置条件、结果形式。 |
| 样例输入 | 强烈建议 | 帮助快速验证接入效果 | 如果涉及文件处理,最好给示例文件。 |
| 样例输出 | 强烈建议 | 帮助确认结果是否符合预期 | 可以是样例结果文件、截图或结果字段说明。 |
| 运行依赖 | 强烈建议 | 决定部署与接入方式 | 例如 Python 版本、第三方依赖、系统工具、外部服务。 |
| 是否允许 AI 调用 | 建议先给 | 决定智能大脑是否可推荐该能力 | 不是所有脚本都默认进入 AI 推荐范围。 |
| 是否允许手动执行 | 建议先给 | 决定页面是否开放手动入口 | 可与 AI 调用分开控制。 |
| 是否需要人工确认 | 建议先给 | 控制高风险动作的确认环节 | 适用于改写数据、发送消息、调用外部动作等场景。 |
| 结果形式 | 建议先给 | 决定结果展示与结果下载入口 | 可以是文本、表格、Excel、压缩包或其他产物。 |
| 执行时长预期 | 建议先给 | 决定前端体验和结果返回方式 | 短任务和长任务的用户体验设计通常不同。 |
| 数据安全边界 | 建议先给 | 决定是云端执行还是本地桥接 | 涉及内网或私有资源时,通常需要补充 CLI / Agent 路线。 |
If Not Ready Yet
What This Avoids
Path Matching
| 当前状态 | 适合查看 | 为什么 | 说明 |
|---|---|---|---|
| 只是第一次了解平台 | 快速开始 | 先判断平台定位和真实入口 | 不必一开始就准备完整交付清单。 |
| 已经准备接客户或真实项目 | 客户流程 / 交付 | 先理解正式交付和热更新流程 | 适合售前、实施和客户沟通一起看。 |
| 任务依赖输入文件和结果文件 | 文件上传 / 结果下载 | 先把文件链路讲清楚 | 尤其适合报表、导出和批量数据处理场景。 |
| 脚本依赖本地环境或内网资源 | CLI 指引 | 更可能需要本地桥接 | 这类场景通常不是单靠浏览器页面解决。 |
Next Read
进入真实接入阶段后,更有效的做法通常不是继续停留在抽象愿景,而是把交付流程、文件链路和本地桥接边界一次对齐。