SuperAPI AI 工具集

navara-add-docs-example

写作与研究

查看项目

更新于 10-15 20:09

技能介绍

用途:为 Navara 文档站点(docs/)新增或更新代码示例时提供规范。写作前先读 .claude/skills/navara-usage/SKILL.md 及对应主题参考,并阅读仓库内的权威流程文档:docs/AGENTS.md(入口与关键原则)、docs/guide/WRITING_RULES.md(文案规则、术语与链接规则)、docs/guide/NAVARA_THREE_INSTRUCTIONS.md(更新流程、包与章节映射、WASM .d.ts 处理)、docs/guide/NAVARA_THREE_UPDATE_CHECKLIST.md(场景清单)、docs/guide/TRANSLATION_GUIDE.md(涉及 ja/ 时)。

主要能力与原则:代码即事实来源,片段中的类型、参数名、返回值与默认值必须与 TypeScript 源码一致,需查实际导出与 JSDoc,不可猜测;Material/WASM 类型按标准化形态(NormalizeWASMClass 的普通可选属性)书写,而非带 free()/getter 的原始 WASM 类。英文为根语言与事实来源,先写英文再镜像到 ja/,技术术语与 API 名在各语言中保持英文。示例必须完整可运行,含导入与必要初始化(如 addLayer 前需 await view.init()),不得是粘贴即报错的片段。片段须遵守 API 不变量,例如不在 init() 之后使用 addPlugin、不写 camera.raw.fov、Layer.update() 传完整配置。

文档位置映射:web/navara_three/→three/,web/navara_three_api/→three/API/,web/navara_three_default_descs/→three_default_descs/,web/navara_three_default_plugin/→three_default_plugin/,web/navara_three_plugins/→three_plugins/,web/wasm/→engine/(冲突时以 NAVARA_THREE_INSTRUCTIONS.md 为准)。

易错规则:渲染出的东西称“objects”,类/配置称“Descriptor”(不翻译),addLayer() 添加的资源层保持“layer”/「レイヤー」;ja/ 中 API 与功能名不音译为片假名;链接须小写、空格转连字符、不用 %20;页面链接用相对路径,图片用 @assets/,组件用 @components/;每个代码块声明语言,frontmatter 需 title、description、sidebar.order;新示例与既有内容并存,不删除或重构。完成前核对签名与源码、示例可从头运行、先更新英文并镜像 ja/、链接小写无误且保留原结构。