☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
mulerun小白友好型术语解释文档可通过五种方法生成：一、内置术语表导出；二、yaml配置注入中文解释字段；三、调用rest api动态获取简化定义；四、ast扫描源码注释提取@term标签；五、cli插件加载社区审核术语包。
如果您在使用mulerun时遇到技术术语难以理解的情况，导致文档阅读或操作受阻，则可能是由于缺乏面向初学者的术语释义支持。以下是为mulerun生成小白友好型技术术语解释文档的多种方法：
一、利用MuleRun内置术语表导出功能
该方法依赖MuleRun运行时环境自带的术语元数据模块，可直接提取已注册术语及其简明定义，适配基础用户认知水平。
1、启动MuleRun CLI工具，执行命令：mulerun term --list --format=markdown。
2、将输出重定向保存为文件：mulerun term --list --format=markdown > terms_beginner.md。
3、打开生成的Markdown文件，确认每条术语后均附有不超过25字的白话说明，如“Flow：一个可执行的数据处理单元”。
二、通过YAML配置模板注入解释性字段
该方法允许用户在自定义组件或连接器的YAML声明中显式添加description_zh字段，使术语解释随配置同步生成。
1、在项目根目录创建glossary-template.yaml，包含字段：name: HTTP Listener, description_zh: 接收外部HTTP请求的入口组件。
2、运行生成命令：mulerun docgen --source=glossary-template.yaml --output=terms_zh.html。
3、检查输出HTML中每个术语标题下方是否紧邻一行绿色加粗的中文解释短句。
三、调用MuleRun REST API动态获取术语详情
该方法适用于集成到外部文档系统，通过HTTP请求实时拉取经语义简化后的术语数据，避免静态文档过期。
1、向MuleRun管理端点发起GET请求：curl -X GET "http://localhost:8080/api/v1/terminology?level=beginner"。
2、响应体中确认每个术语对象含simple_definition键，值为无技术缩写、无被动语态的主动句式。
3、将响应JSON解析后，按字母顺序渲染为带锚点的HTML列表，每个术语名链接至其解释段落。
四、基于AST扫描源码注释自动生成术语条目
该方法从MuleRun应用代码的Javadoc或KDoc注释中提取@term标签内容，确保解释与实际使用上下文一致。
1、在Java类方法前添加注释：/** @term DataWeave Expression：用于转换消息载荷的轻量脚本语言 */。
2、执行扫描命令：mulerun ast --scan=src/main/java --tag=term --export=csv。
3、验证CSV首行字段为term_name,definition,context_usage，且第三列示例值为在Transform Message组件中编写。
五、使用CLI插件加载社区维护的术语映射包
该方法引入第三方审核过的术语对照库，覆盖MuleSoft官方未详述但用户高频提问的复合概念。
1、安装插件：mulerun plugin install mule-terms-beginner-pack。
2、启用插件并指定目标术语集：mulerun term --plugin=beginner-pack --include="error-handling,flow-ref,object-store"。
3、确认输出中“error-handling”条目下解释为当流程出错时跳转到特定步骤，而不是中断整个运行，不含“异常传播机制”等进阶表述。
