先确定问题,再固定源码版本
明确读者和用途:熟悉一个服务、评审高风险改动,还是寻找请求写入存储的位置。记录仓库地址与提交;工作区有未提交修改时,也要说明这些修改。这样,读者才知道这份解释对应哪一版代码。
Agent 在你的开发环境中读取仓库。OWL Compose 不会因为你粘贴了私有仓库地址就自动导入源码。不要把密钥、环境变量或无关的私有代码放进准备发表的作品。
先追踪一条真实路径
从 HTTP 路由、CLI 命令、队列消费者或定时任务等具体入口出发,追踪与问题相关的调用。保留模块名、文件路径与符号名,并区分源码中确实存在的调用和推断出来的依赖。
标明请求方向、跨边界传递的数据和重要的异步步骤。包的导入关系不等于运行顺序。如果行为受配置或功能开关影响,说明图中采用的配置。
选择读者能顺着看下去的架构视图
一条请求用小型流程;需要探索多个服务或层级时,使用分组关系图。把函数细节放在所属模块附近,并用调用、入队、读取、写入或返回等动词说明连线含义,不要连接所有可能的依赖。
让 Agent 使用已安装的作者技能编写 OWX。关系图支持分组与交互探索,也能搭配说明和表格。把源码线索保留在解释中,让读者能从图回到实现。
同时验收解释与实际画面
编译后检查桌面与手机视口。从入口走到可观察的结果,核对箭头与源码是否一致,并展开回答问题所需的分组。编译成功只证明结构合法,不能证明架构结论正确。
分享前先在作者视图中查看发表后的作品。作品默认私密,需要其他人阅读时再创建读者链接。后续改动应保留本地 OWX 和作品身份,在原作品发表新版本,同时更新源码版本记录。
常见问题
常见问题
OWL Compose 会上传整个仓库吗?
本地 Agent 读取源码;发表上传的是编译后的文档和包内引用的资源。分享前应检查产物是否包含不应公开的内容。
代码改了之后能更新架构图吗?
可以。修改同一份本地 OWX,核对受影响的路径,再为现有作品发表新版本。仓库同步不是自动进行的。
使用真实工作流
把 Agent 创作的作品发表出来。
安装 CLI,用 OWX 创作并在本地校验,然后发表一份默认私密的作品;准备分享时再显式创建读者链接。