用途:为 ComfyUI 节点撰写原创、面向初学者的文档。每个节点存为独立 JSON 文件,嵌入文档仅作参考,必须重写内容,不得复制粘贴。
文件结构:节点数据按 section 与 category 拆分,位于 src/data/nodes/ 下,包括 _metadata.json(元数据与 schema_version)、comfy_nodes/<category>/<NodeName>.json(核心节点)、partner_nodes/(API/合作节点)、subgraph_blueprints/(子图蓝图)、extensions/(扩展节点)。顶层目录对应树面板分区,category 路径由节点 category 字段的空格替换为连字符得到。关键文件还包括导出数据 exports/comfyui_nodes_2026-03-14_0-17-0.json(结构来源)、嵌入文档 embedded-docs/comfyui_embedded_docs/docs/<NodeName>/en.md(仅参考)、更新计划 exports/NODE_UPDATE_PLAN.md。
主要能力:为每个节点撰写 description(50–200 字符)、beginner_description(100–400 字符)、tips(general_tips 2–5 条、beginner_tips 2–4 条、advanced_tips 1–4 条,简单节点可跳过)、use_cases(2–4 条,含 scenario 与 context)、common_errors(1–4 条,含 symptom 与 solution)、complexity_level(beginner/intermediate/advanced),全部填写后将 documentation_complete 设为 true。
使用方式:用 find src/data/nodes -name 'KSampler.json' 定位节点文件;用 rg '"documentation_complete": false' src/data/nodes/ -l 搜索待补全节点。批量文档化时先按类别分组,逐个读取节点 JSON、嵌入文档与导出条目,撰写字段后原地写回,并更新进度文件。改进现有文档时先识别弱内容(未完成、beginner_description 为空、提示过于笼统、use_cases 或 common_errors 为空、description 少于 50 字符),保留已写好的内容。质量检查可用 rg 统计未完成节点,或用 python3 脚本检测 beginner_description 与 description 重复、缺失 tips 的节点。
写作标准:面向学习 ComfyUI 的用户而非研究者,使用主动语态,解释原因而非仅描述功能,复杂概念用类比。提示须具体可操作,包含具体数值、设置、节点名或工作流。
分类特定指引:API 节点须说明需要 API 密钥、云端处理、可能产生费用及提供商与媒体类型;数据集节点说明其在训练数据管线中的位置与格式;采样节点解释采样器/调度器作用并给出推荐起始值;潜空间节点须提示连接 VAE Decode 查看图像;音频节点说明格式、采样率与声道限制。
限制:嵌入文档仅作参考,不得照抄段落、表格或结构,需删除“AI 生成”免责声明。大批量(50+ 节点)可按类别使用并行子代理,各子代理写入不同节点文件以避免冲突,由协调代理统一更新计划文件。资料未提供具体价格、平台支持范围等信息。