宜搭应用开发指南
在执行宜搭应用/页面/审批流等任务前先确认环境与登录态,再根据用户需求和已解析的 app/page/form/process 等上下文资源,分析任务属于完整搭建、已有资源补齐还是单点任务,并加载对应子技能执行。
步骤模版(进行时展示给用户看的步骤)
完整应用搭建时,直接使用对应模式的步骤名称。
Plan 模式
- 需求识别与分析
- 设计功能和页面
- 生成PRD方案&确认
- 创建应用
- 搭建表单与审批流
- 准备示例数据
- 搭建业务页面
- 发布页面与配置导航
- 检查功能并交付
Fast 模式
- 需求识别与分析
- 设计功能和页面
- 创建应用
- 搭建表单与审批流
- 准备示例数据
- 搭建业务页面
- 发布页面与配置导航
- 检查功能并交付
已有应用时,直接省略“创建应用”,不另列“复用现有应用”待办,后续步骤重新编号;无需示例数据时跳过对应步骤。步骤状态按真实进度更新,有独立输入的工作可同时进行。
禁区:待办标题、说明和进度不出现技能名、命令、文件路径、登录账号、内部资源 ID;这些留在工具调用里。用户明确询问技术细节时再解释。
执行步骤
Step 1:环境与登录态确认
先执行 openyida agent-capabilities --summary-json,确认 OpenYida、Node/npm、登录态和工作目录可用。openyida agent-capabilities --json 是完整能力信息,只在命令契约排障、manifest 差异诊断或深度调试时使用;不要把完整能力信息放进常规完整搭建链路。workdir 对应完整能力信息里的 active.projectRoot。
如果快照显示 builder_path.interactive_login.mode=caller_open_url,说明 CLI 已把浏览器归属交给 Agent。执行 openyida login --no-browser 后,Agent 必须优先调用当前宿主的沙箱浏览器 / 内置 Browser 打开 CLI 输出的授权 URL 一次;只有没有浏览器工具或工具调用失败时,才让用户手动打开链接。
未完成环境与登录态确认前,不创建应用、页面、表单,不发布页面。环境异常、登录失败、env token 注入和 openyida copy 初始化见 环境准备与登录检测。
核心判断:
| 快照结果 | 动作 |
|---|---|
openyida 不可用 |
先安装或更新 openyida,不创建资源 |
| 工作目录不存在 | 先执行 openyida copy 初始化工作目录 |
| 登录态可用 | 进入 Step 2 |
| 登录态缺失 | 按快照提示补登录态;未恢复前停止资源写操作 |
Step 2:解析资源上下文
任何写操作前先解析目标 app/page/form/process。按本轮显式资源、外部绑定资源、workspace cache/config、会话历史的顺序选择目标;同级冲突或目标不明才询问用户。
执行 Step 2 时必须读取 资源上下文与补齐判定,并按其中规则解析目标资源。已有 app 默认复用,不执行 yida-create-app;已有 app 但没有任何页面时,进入完整应用补齐;PRD 不需要页面时,不强制创建自定义页面。
核心判断:
| 已解析到 | 动作 |
|---|---|
| 目标 app | 复用该 app,在其中修改、补齐或发布 |
| 目标 app 但没有任何页面 | 进入完整应用补齐;PRD 不需要页面时不强制创建自定义页面 |
| 目标页面 / 表单 / 流程 | 修改已有资源,不创建同类新资源 |
| 目标缺失且用户明确允许创建 | 进入对应创建技能 |
| 多个同级候选或上下文冲突 | 先询问用户 |
Step 3:意图识别
| 判定 | 用户诉求信号 | 下一步 |
|---|---|---|
| 完整搭建 / 补齐 | 创建/搭建/做一个 + 应用/系统/管理系统;已有 app 没有任何页面;或已有 app/page 需要补成完整系统 | 加载 yida-app |
| 单一 / 增量任务 | 对已有应用/表单/页面做单点操作:加字段、查改数据、配公式、建报表、改权限、发布、美化等 | 从下方技能路由表选 1 个子技能 |
意图识别只决定入口,不展开执行细节。完整搭建 / 补齐加载 yida-app 后按其 workflow 执行;单点任务只选 1 个主技能,不升级成完整搭建。
Step 4:加载子技能并执行
如果当前 AI 工具提供 use_skill / search_skills,必须用 use_skill("<技能名>", "<本阶段目的>") 加载技能,不用 Read / read_file / cat 直接读取 SKILL.md 路径。如果当前工具没有 use_skill / search_skills,按 skills/<技能名>/SKILL.md 定位当前阶段要执行的子技能文档。
单点任务按意图选 1 个主技能;完整应用由 yida-app workflow 分阶段推进,每一步加载当前步骤对应的子技能。skills-index.json 只给能读取索引的工具辅助匹配,不作为运行前置。执行边界见下方核心规则。
技能路由表
这张表给人工 fallback 和人审使用:先按用户任务命中一个大类目录,再在该目录内选定 1 个最匹配的子技能。机器索引和精排方法见 路由补充说明。
大类目录
| 大类目录 | 第一层意图信号 | 子技能 |
|---|---|---|
yida-skills/context |
登录、退出、切换组织、组织版本/容量、Schema、fieldId、执行前检查 | yida-login、yida-logout、yida-basic-info、yida-get-schema、yida-corp-efficiency |
yida-skills/app |
从零搭应用、完整系统、应用启停、应用导航、多语言 | yida-app、yida-create-app、yida-app-lifecycle、yida-nav-group、yida-i18n |
yida-skills/design |
完整应用需求分析、PRD、视觉设计、单页 UI 改造、应用主题色、全局换肤 | yida-requirement-analysis、yida-prd、yida-design |
yida-skills/form |
表单字段、公式、校验、业务关联规则、批量录入、数据记录 | yida-create-form-page、yida-formula、yida-formula-evaluate、yida-business-rule、yida-canvas-table-form、yida-table-form、yida-data-management |
yida-skills/process |
审批、流程表单、流程规则、节点/分支/字段权限、流程代理 | yida-create-process、yida-process-rule、yida-agent-center |
yida-skills/page |
自定义展示页、页面源码开发、平台 JSX 组件页面维护、页面发布、页面内导航、PPT 页面 | yida-create-page、yida-canvas-custom-page、yida-custom-page、yida-canvas-data-binding、yida-canvas-upgrade、yida-publish-page、yida-openyida-publish-guard、yida-density、yida-nav-shell、yida-ppt-slider |
yida-skills/analytics |
聚合表、虚拟视图、报表、统计、图表、Recharts、ECharts、看板、驾驶舱、大屏 | yida-aggregate-table、yida-report、yida-rechart、yida-chart、yida-dashboard |
yida-skills/integration |
连接器、钉钉开放平台、外部 API、执行动作、设计器数据源、集成自动化、逻辑流 | yida-integration、yida-dingtalk-openapi、yida-connector、yida-connector-safe-actions、yida-data-source-connectors |
yida-skills/access |
平台/应用/表单/页面权限、公开访问、分享 | yida-corp-manager、yida-app-permission、yida-form-permission、yida-page-config |
yida-skills/ops |
Sequence、主键冲突、VOC 反馈 | yida-db-seq-fix、yida-voc |
yida-skills/agent |
导出对话、读取钉钉文档/听记、会议纪要/闪记转 PRD | yida-export-conversation、yida-document-markdown、yida-tingji、yida-flash-note-to-prd |
高频分歧
| 用户意图 | 选哪个 |
|---|---|
| 从零搭一个完整应用/系统 | yida-app;先分析需求并完成首次搭建确认,再规划与搭建 |
| 已有 app 但没有任何页面,需要补成完整系统 | yida-app;属于首次搭建,同样先询问搭建方式,复用已有 appType 补齐资源 |
| 读取钉钉在线文档正文 | yida-document-markdown,使用登录态接口获取 Markdown |
| 按 taskUuid 读取钉钉听记 | yida-tingji,将听记任务 ID 原样传入命令 |
| 将钉钉开放平台官方 API 接入宜搭或 Canvas | yida-dingtalk-openapi;密钥不进聊天,账号由用户在宜搭或本机 TTY 配置 |
| 钉钉事件订阅、Stream 或 HTTP 回调 | OpenYida 不支持;直接说明能力边界并停止,不生成连接器动作 |
| 用户给 taskUuid 并要求转 PRD | 先用 yida-tingji 读取听记内容,再把已有内容交给 yida-flash-note-to-prd 生成 PRD |
| 已有会议纪要/闪记内容转 PRD | yida-flash-note-to-prd,只处理已有内容,不负责按 taskUuid 拉取听记 |
| 只创建应用壳并拿 appType | yida-create-app;若随后继续完整搭建,已经确认的 requirement-brief.json、prd.md 与 design.md 保持不变,真实 appType 只写入 schema 或当前任务资源上下文 |
| 启用/上线或停用/下线已有应用 | yida-app-lifecycle;只有用户明确要求时执行,app-offline 执行前需再次确认目标应用 |
| 创建自定义展示页资源 | yida-create-page,之后交给 yida-canvas-custom-page 编写页面源码,再交给 yida-publish-page 发布 |
| 开发表单字段结构 / 增删改字段 | 使用 yida-create-form-page 落地字段结构 |
| 创建带审批的流程表单 | yida-create-process |
| 修改已有流程节点/分支/字段权限 | yida-process-rule |
| 查字段 ID / 保存 Schema 证据 | yida-get-schema;凡涉及 fieldId 的数据、流程、公式、页面代码先取证 |
| 改表单数据记录 | yida-data-management,不是 yida-create-form-page |
| 配字段默认值、计算、校验 | yida-formula;静态检查用 yida-formula-evaluate |
| 提交后跨表写入/更新/删除 | 默认 yida-integration;用户明确要业务关联规则/高级函数时用 yida-business-rule |
| 集成自动化从上游节点子表取数或新增一行 | yida-integration 的 --spec 新建路径;不要用 integration update 或现网 --replace |
| 自定义页面开发 | yida-canvas-custom-page,新建和默认页面源码开发入口,源码使用 .canvas.jsx;Canvas 发布层会自动注入 window.__OPENYIDA_YIDA_API__ 和 window.__OPENYIDA_UTILS__ |
| JSX 自定义页面开发 | yida-custom-page,仅用于已检测到的 .oyd.jsx / .oyb.jsx / renderJsx / 平台 Jsx 组件页面维护 |
.canvas.jsx 页面使用成员/部门/上传等宜搭运行态组件 |
yida-canvas-custom-page,读取 native-components-bridge.md |
.canvas.jsx 页面接真实数据、表单 API、流程 API 或根级工具 |
yida-canvas-data-binding,默认消费发布层注入的 yida/utils window 桥 |
已有 .oyd.jsx / renderJsx 迁到 YidaCodeCanvas 组件实现 |
yida-canvas-upgrade |
| 高级图表、可视化、看板图表 | 默认 yida-rechart |
| 明确 ECharts、维护旧 ECharts 页面、复杂 option 超出 Recharts 能力 | yida-chart |
| 产品化经营看板/驾驶舱交付 | yida-dashboard |
| 批量录入、表格填写、多行编辑 | 默认 yida-canvas-table-form;已检测到平台 JSX 组件页面、native 页面或存量源码使用 this.utils.yida.saveFormData 时用 yida-table-form |
| 页面视觉方向、页面美化、去 AI 味 | yida-design 只产出或更新 prd/<项目名>/design.md;若业务/页面契约也变化,由 yida-prd 更新 prd.md;实现阶段默认交给 yida-canvas-custom-page |
| 应用级主题、品牌色、全局换肤 | yida-design |
| 平台左侧导航树分组/排序 | yida-nav-group |
| 应用导航隐藏后自绘导航壳 | yida-nav-shell |
| 普通报表/统计 | yida-report |
| 聚合表 / 虚拟视图的读取、预览、草稿保存或发布 | yida-aggregate-table;save 验证 stash revision,publish 验证 live revision |
| PPT 页面 | yida-ppt-slider |
| 公开访问/组织内分享 | yida-page-config |
| 评测指定技能质量并给出评分建议 | yida-skill-evaluator |
索引精排方法和无独立子技能的 CLI 见 路由补充说明。
核心规则
以下规则都是执行 OpenYida 任务时必须遵守的全局边界;具体子技能可以补充更细规则,但不能覆盖这些规则。
- OpenYida CLI 统一执行:所有宜搭资源操作通过
openyidaCLI 执行;创建、修改、发布、查询都以 CLI 返回的 JSON、URL、formUuid/appType作为证据。 - 技能加载唯一入口:执行子技能前必须加载对应技能;单点任务按意图选 1 个主技能,完整应用由
yida-appworkflow 分阶段加载当前步骤对应的子技能。 - 真实资源先确认:写操作前解析本轮显式资源、已绑定资源上下文、workspace 配置/缓存和历史上下文;已有目标资源时默认修改、补齐或发布,只有目标缺失且意图允许创建时才加载 create 类技能。
- corpId 一致性检查:创建或发布页面前对比 PRD/resource context 与当前 auth snapshot 的
corpId;不一致时先让用户选择重新登录或确认继续。 - 页面源码修改必须发布闭环:只要本轮 Write/Edit/Create 了页面源码
project/pages/src/*.{canvas.jsx,canvas.tsx,oyd.jsx,jsx,tsx},final 前必须看到成功的openyida publish <source> <appType> <displayPageFormUuid>;没有证据只能说“源码已修改,尚未发布”,禁止说“页面已更新 / 已重新发布 / 已上线”。 - 发布前本地校验:平台 JSX 组件页面的
check-page/compile归yida-custom-page执行;使用YidaCodeCanvas组件实现的自定义页面按本地快检或发布阶段校验;JSON 配置写盘后先解析校验,再调用平台命令。 - 生成产物严禁 emoji:页面源码、
.canvas.jsx源码、表单 Schema、发布 Schema、产物文件名和路径中严禁使用 emoji;图标语义使用平台组件、图标库或已验证资源表达。 - 输入文件用结构化写入:JSON/YAML/CSV/config/script 文件使用当前 agent 的文件写入能力创建,再把路径传给命令;严禁用 shell heredoc、
cat/echo/printf/tee或重定向生成业务文件。 - OpenYida CLI 不吞诊断:不要给
openyida命令加2>/dev/null;失败时保留 stdout/stderr;遇到 DENIED 或同一命令重复失败,先换策略、改输入或重做环境确认。 - 读取与复核用合适工具:读取或定位 workspace 文件优先用当前工具的 Read / Glob / Grep 或
rg;OpenYida CLI 已返回成功 JSON、URL、appType、formUuid或fieldId时,以 CLI 结果作为证据。 - 资源 ID 必须精确:
appType、formUuid、fieldId等应用、表单、字段 ID 必须来自 CLI/API/cache 证据并一字不差传入命令和源码;不得凭名称、截图、相似前缀或记忆补写、改写、截断。 - 字段和 Schema 以证据为准:字段级表单操作优先交给
create-form update/add-option/bind-datasource/validation/rule的 schema-aware 解析;页面代码、数据、流程、公式等需要字段映射时,每表单一次性执行openyida get-schema --field-map-json并缓存字段摘要。 - 产品与视觉分工固定:完整应用先分析需求;首次搭建按 yida-requirement-analysis/workflow/prepare-brief.md 确认未决事项,再进入已选 Fast / Plan。两种模式共享需求分析与 PRD 契约,以下并行生成规则用于 Fast;Plan 确认当前版本后交接派生文件,直接进入 Step 3。只有 Plan 的 build-plan.html 用于方案展示,其余设计文件保持内部使用。完整应用先由
yida-requirement-analysis整理用户需求,再由yida-prd与yida-design同时输出prd/<项目名>/prd.md与prd/<项目名>/design.md,最后由yida-app做一致性校验;页面目标、区块、数据和交互以 PRD 为准,布局、主题、材质和状态视觉以 design.md 为准。 - 配置优先于页面代码:字段、公式、联动、报表、审批和集成交给对应技能;自定义页面负责展示数据、放置业务入口,并串联表单、流程、报表和导航入口。
- Canvas 运行桥统一口径:
.canvas.jsx/.canvas.tsx发布为YidaCodeCanvas时,外层页面didMount默认注入window.__OPENYIDA_YIDA_API__和window.__OPENYIDA_UTILS__。Canvas 组件内部不得直接写this.utils.yida.*;表单/流程/表单设计 API 走window.__OPENYIDA_YIDA_API__,toast/dialog/openPage/router.push/isMobile等根级工具走window.__OPENYIDA_UTILS__,且window.__OPENYIDA_UTILS__.yida指向同一个 yida API 桥。 - 分页查询默认 pageSize 50:生成表单、流程、任务、成员等分页查询代码时,一般显式写
pageSize: 50或pageSize: '50'。除非用户明确要求小页或大页,不写20、100等其他值;平台上限仍是 100。 - 数据性能优先:统计聚合用
yida-report服务端聚合,不在前端拉全量后自行聚合。 - 避免无效重试:失败先查登录态、组织、参数和字段 ID;无修改不连续重试超 1 次。
- 存储路径固定:PRD、视觉契约、Schema ID 和临时文件按存储约定写入:
类型 路径 业务语义 prd/<项目名>/prd.md视觉契约 prd/<项目名>/design.mdSchema ID .cache/<项目名>-schema.json临时配置/导入数据/脚本 <projectRoot>/.cache/openyida/<项目名或任务名>/
prd.md只记录业务语义,不记录字段 ID。- Schema ID 映射不是远端真相;CLI 返回字段不存在、重名或歧义时重新取证。
- 从 workspace 根执行命令时路径加
project/前缀;在 OpenYida project 工作目录内执行时使用.cache/...。 - 不把 OpenYida 业务中间文件写到仓库根目录或系统临时目录。
- 报表和可视化先分流:标准统计与原生报表用
yida-report;定制图表页面默认用yida-rechart;只有明确 ECharts、维护旧 ECharts 页面或复杂 option 超出 Recharts 能力时用yida-chart。 - 应用主题只有一份:涉及应用蓝图、页面视觉、应用主题色、品牌色、全局换肤或
--color-brand1-*时先读yida-design。app-theme.css只在应用级统一配置,由平台作用于应用壳、原生表单、详情页和自定义页面外层。严禁在页面级重复写入、同步或向上层注入主题样式;YidaCodeCanvas源码只在YidaComp内消费现有主题 token。 - 默认完成即停止:完整应用默认以资源发布成功、轻量导航排序完成、示例数据就绪并输出一组有明确名称的应用入口与业务交付总结为 doneWhen;截图、精细导航整理和额外深读属于 optionalAfterDone,除非用户明确要求。
- 输出业务化:对话、任务列表、步骤标题、进度和提问面向非技术用户,用“需求识别与分析”“设计页面”“搭建应用”等简短动作描述;文件名、路径、技能名和调用方式留在内部执行。PRD 业务说明、HTML 和消息使用功能与体验描述;接口参数、配置键值及内部 ID 留在 Agent 实施交接,遵循用户可见表达契约。最终回复先写 2-3 句业务交付总结,再给一组“应用访问入口”。不得把需求信息文件、PRD、视觉设计、build manifest、资源清单、Schema 或每个表单/流程/报表分别登记成用户可见交付物;完整应用始终给工作台入口,主页面经 PRD 标记为
standalone且导航配置回读通过时增加独立业务入口,非云端 Agent 再增加开发后台入口。 - 任务复盘沉淀:用户多次纠正、平台接口假成功、页面骨架共性质量问题、线上回读验收方法、一次性脚本可产品化等情况,完成前判断是否需要沉淀到 CLI、测试或 skill。
常见问题见 常见问题解决方案。
参考文件
| 文档 | 覆盖范围 | 何时阅读 |
|---|---|---|
| 资源上下文与补齐判定 | 资源优先级、绑定上下文、create-or-update、已有 app 无页面 | Step 2 必读 |
| 路由补充说明 | 索引精排方法、无独立子技能 CLI | Step 3 排障或索引匹配不准时 |
| 常见问题解决方案 | 常见问题处理路径 | 遇到发布、字段、表单更新或 corpId 问题时 |
| 环境准备与登录检测 | 环境依赖、env 解读、多环境 token 登录、project 初始化 | 环境异常或登录问题时 |
| 宜搭 API | 宜搭 API 完整参数 | 调用 API 前 |
| 公式函数库 | 公式函数速查 | 编写公式前 |
| 官方示例 Schema 范式 | 脱敏 schema 承载范式 | 蒸馏官方示例时 |
| 任务复盘与沉淀规范 | 任务收尾沉淀、CLI/skill/页面骨架反哺、视觉参考和主题经验 | 任务完成前、用户要求总结经验或多次纠正同类问题时 |
| 查询条件构造 | 数据查询条件写法 | 数据查询/筛选时 |
| 报表字段配置 | 报表字段配置规范 | 配置报表时 |
| 版本功能差异 | 各版本能力差异 | 版本能力查询时 |
| 模型 API | 宜搭模型接口 | 调用宜搭模型能力时 |