SuperAPI AI 工具集

review-doc-style

写作与研究

查看项目

更新于 10-16 02:34

技能介绍

用途:审查仅涉及文档的改动、示例较多的改动,或任何需要对照 NVIDIA 风格指南与 NeMo Fabric 仓库约定检查的面向公众文本。建议配合 karpathy-guidelines 使用,保持改动范围收敛、明确假设并在编辑前定义验证方式。

主要能力:优先保证事实准确性而非文字润色,先标记过时命令、包名、API、绑定、仓库路径或支持声明,再处理风格问题;检查入口文档(README.md、docs/index.yml、包或 crate README、适配器与集成 README)是否同步更新;扫描标题、链接、代码格式、术语、步骤和可读性问题,并按严重程度给出文件引用与具体改写。

必要用法:docs/reference/api/ 下文件为生成产物,不得直接修改。Python API 参考需改 sdk/python/nemo-fabric-runtime/src/nemo_fabric/ 下的源 docstring 或 scripts/generate_api_docs.sh;Rust API 参考需改 crates/fabric-core/ 下的文档注释或 scripts/docs/generate_rust_library_reference.py;改完源或生成器后运行 just docs 重新生成并校验。docs/ 内文件间链接使用相对源文件的路径并带目标 .mdx 扩展名,不使用 Fern 站点根路径。产品全名为 NVIDIA NeMo Fabric,首次使用(通常在标题和 H1)用全名,之后可用 NeMo Fabric;单独使用 fabric 仅指 CLI 工具且须加反引号。

适用场景:文档评审、示例评审、公开文本更新检查。

限制:资料未提供具体收费、平台支持范围或效果数据;评审结论依赖当前仓库状态,未实际执行的命令或示例存在残余风险。