SuperAPI AI 工具集

review-doc-style

写作与研究

查看项目

更新于 10-16 02:34

技能介绍

用途:审查 NeMo Relay 的文档、示例或公开文本,检查其是否符合 NVIDIA 技术写作风格、术语规范以及仓库内容准确性。该技能强调事实准确性优先于文字润色,在报告风格问题前需先对照当前仓库确认命令、包名、API、路径、支持的绑定和公开行为。

主要能力:识别变更的文档、示例或公开字符串及其对应入口(如 README.md、docs/index.yml 或包 README);读取 references/nvidia-style-guide.md 获取快速检查清单和严重性模型;按需打开聚焦参考文件,包括技术文档结构、语言机制、品牌术语等;验证 MDX 文件是否使用 JSX 分隔符处理文件顶部的 SPDX 注释。

使用方式:按严重性顺序报告发现,包含文件与行号、读者影响以及具体改写建议或方向。除非用户要求深度文案编辑,否则省略仅属偏好的发现。若未发现问题,应说明并指出未执行的命令或示例。

适用场景:适用于 NeMo Relay 仓库中文档、示例和公开文本的风格与准确性审查。

限制:不适用于普通文案编辑;具体命令、安装方式及更多细节暂未提供。