Skip to content

Onboarding Checklist

客户接入准备清单

Before Delivery真正拖慢接入速度的,往往不是功能不够,而是脚本、说明、样例和边界信息给得不完整。

重点说明接入前需要准备的信息,方便客户、售前和实施一起对齐。

进入真实场景接入前,最好先把 脚本目录、README、样例文件、运行依赖、结果形式和风险边界 准备清楚。这样后续无论走客户交付、文件处理还是 CLI / 本地桥接,都会顺很多。

脚本目录README样例文件风险边界
EXECGOV // ONBOARDING CHECKLISTDOC 11
const requiredPack = ['script_folder', 'readme', 'sample_file', 'runtime_dep']const boundaryInfo = ['ai_allowed', 'manual_confirm', 'result_format']const onboardingGoal = 'delivery_ready_handoff'
BETTER INPUTS MAKE ONBOARDING FASTER

01

脚本目录

至少要有可执行主入口,以及能让平台判断用途的最小目录结构。

02

README 说明

告诉平台脚本做什么、输入什么、输出什么、需要什么前置条件。

03

样例文件

如果脚本依赖输入文件或会生成结果文件,最好给出样例输入和样例输出。

04

风险边界

最好先说清是否允许 AI 调用、是否允许手动执行、是否需要人工确认。

Checklist Table

建议至少一次给齐这些信息

准备项是否建议先给为什么重要建议说明
脚本目录必须没有执行内容就谈不上接入至少明确主入口和最小目录结构。
README.md必须帮助平台审核、命名和后续维护建议写明作用、输入、输出、前置条件、结果形式。
样例输入强烈建议帮助快速验证接入效果如果涉及文件处理,最好给示例文件。
样例输出强烈建议帮助确认结果是否符合预期可以是样例结果文件、截图或结果字段说明。
运行依赖强烈建议决定部署与接入方式例如 Python 版本、第三方依赖、系统工具、外部服务。
是否允许 AI 调用建议先给决定智能大脑是否可推荐该能力不是所有脚本都默认进入 AI 推荐范围。
是否允许手动执行建议先给决定页面是否开放手动入口可与 AI 调用分开控制。
是否需要人工确认建议先给控制高风险动作的确认环节适用于改写数据、发送消息、调用外部动作等场景。
结果形式建议先给决定结果展示与结果下载入口可以是文本、表格、Excel、压缩包或其他产物。
执行时长预期建议先给决定前端体验和结果返回方式短任务和长任务的用户体验设计通常不同。
数据安全边界建议先给决定是云端执行还是本地桥接涉及内网或私有资源时,通常需要补充 CLI / Agent 路线。

If Not Ready Yet

资料暂未齐备时,可先从这几项开始

  • 可以先用公开体验入口感受平台链路。
  • 可以先只带一份最小脚本目录和 README 来沟通。
  • 仍在判断平台定位时,优先查看产品概览和常见问题。
  • 已确定要接文件场景时,补充样例文件和结果预期会更高效。

What This Avoids

为什么这份清单值得提前看

  • 避免只说“我有个脚本”,但谁也说不清怎么接。
  • 避免结果形式没说清,后面临时返工文件下载或结果页。
  • 避免高风险动作没提前说明,后面再补安全边界。
  • 避免本该走本地桥接的场景,前期误当成纯网页能力来谈。

Path Matching

根据当前状态,下一步更适合看哪页

当前状态适合查看为什么说明
只是第一次了解平台快速开始先判断平台定位和真实入口不必一开始就准备完整交付清单。
已经准备接客户或真实项目客户流程 / 交付先理解正式交付和热更新流程适合售前、实施和客户沟通一起看。
任务依赖输入文件和结果文件文件上传 / 结果下载先把文件链路讲清楚尤其适合报表、导出和批量数据处理场景。
脚本依赖本地环境或内网资源CLI 指引更可能需要本地桥接这类场景通常不是单靠浏览器页面解决。

Next Read

把准备清单、交付流程和文件链路连起来看

进入真实接入阶段后,更有效的做法通常不是继续停留在抽象愿景,而是把交付流程、文件链路和本地桥接边界一次对齐。

让每次自动化,都可靠且可控。