NeMo-RL 文档规范
帮助 NeMo-RL 项目按统一规范编写和维护文档。
技能范围限于文档和文档字符串指导，不要求凭据、网络访问、文件删除或外部副作用，且明确列出不适用任务，因此未见红线风险。扣3分：未说明用户确认、变更回滚、数据流或敏感数据处理；来源链接和归属虽有记录，但未提供更细的事实核验流程。
SKILL.md中的触发条件和三项核心规则基本一致，路径和格式要求也较明确。扣3分：没有异常输入、冲突文档结构、索引缺失或无法判断目标章节时的处理和诊断反馈；静态评估不能把BENCHMARK中的结果视为已执行复现，因此不超过10分。
目标受众、适用场景及排除范围在前言和skill-card.md中较清楚，能覆盖新增文档、文档更新和公共接口文档字符串。扣4分：未明确语义触发优先级、输入输出边界、复杂文档结构的非适用范围，也没有中文示例或中文语言支持证据；“Global”仅是部署声明。
具备YAML元数据、Apache-2.0许可证、用途说明、风险提示、所有者、评估日期和一个版本标识，结构易读。扣6分：SKILL.md很短，缺少Instructions和Examples等推荐章节；没有FAQ、故障排查、已知限制、正式变更记录或明确维护更新路径，且仓库许可证元数据为NOASSERTION。
三条正向评测任务的预期输出与技能规则直接对应，核心建议可直接用于文档维护，且负向任务定义了不应触发的场景。扣9分：BENCHMARK仅提供静态报告式指标，未给出本次修订可独立复现的运行产物；没有代表性实际输出或与手工流程的充分比较，复杂项目中的结果完整性证据有限。
提供了SKILL.md、评测任务定义、评估报告和skill-card，关键规则与预期行为之间可追踪。扣7分：评估报告中的百分比和PASS结论没有随附可核验日志、CI工作流或本技能专属测试套件；静态阅读无法独立复现执行结论，因此仅给有限分数。
- 不要把BENCHMARK中的PASS和百分比当作本次修订的独立运行验证；部署前应重新执行覆盖正向、负向和边界触发的评测。
- 补充具体示例、异常处理、已知限制、维护责任和变更记录，并澄清SKILL.md中的许可证声明与仓库NOASSERTION元数据关系。
- 该技能只提供轻量级规范建议；遇到复杂文档导航、Sphinx配置冲突或项目特定规则时仍需人工审查。
这个 Skill 能做什么，适合哪些场景？
该技能面向 NVIDIA NeMo-RL 项目的文档维护工作。它规定新增或重命名 Markdown 文档时同步更新 docs/index.md，并要求类和函数使用可被 Sphinx 解析的 Google 风格 docstring。新增功能时，应在 docs/ 中补充最匹配的文档；Bug 修复和 CI 相关变更不要求更新文档。技能本身标注为 Apache-2.0，所在 NVIDIA/skills 仓库是包含 324 个技能的目录集合。
它指导代理检查 docs/**/*.md 下新增或重命名的 Markdown 文件，更新 docs/index.md 中的适当章节；指导代理为类和函数编写 Google 风格 docstring，并在代码评审中检查 docstring 格式；新增功能时，指导代理查找最匹配的现有文档，必要时在 docs/ 中创建新文档并加入 docs/index.md。
- NeMo-RL 开发者新增 docs/ 下的 Markdown 文档，需要将其加入文档索引。
- 维护者重命名文档文件，需要确认 docs/index.md 中的链接或章节仍然正确。
- 开发者新增类或函数，需要编写可被 Sphinx 解析的 Google 风格 docstring。
- 代码评审者检查 NeMo-RL 变更中的 docstring 和文档组织是否符合项目约定。
- NeMo-RL 新增功能后，贡献者需要决定应更新哪份现有文档或创建哪份新文档。
这个 Skill 有哪些优点和局限？
- 覆盖文档索引、功能文档和 docstring 格式三个明确场景。
- 给出了 Google 风格 docstring 和 Sphinx 解析之间的关系。
- 明确列出不适用的工程任务，便于控制触发范围。
- 适用于遵循标准 SKILL.md 的 Agent Skills 客户端。
- 没有提供具体脚本、自动检查命令或测试套件。
- 没有说明 docs/index.md 的完整章节结构或项目专用示例。
- README 的安装说明针对整个 NVIDIA/skills 集合，技能本身的安装目录和运行时细节未文档化。
- 内容仅覆盖文档约定，不提供 NeMo-RL 训练、调试或性能优化指导。
如何安装这个 Skill？
使用仓库 README 中提供的 skills CLI 命令安装指定技能：
npx skills add nvidia/skills --skill nemo-rl-docs --yes
也可以安装整个 NVIDIA 技能集合：
npx skills add nvidia/skills
README 未说明该技能安装后的具体本地目录。
如何使用这个 Skill？
在已安装该技能的代理中提出涉及 NeMo-RL 文档的任务，例如：“为新增的 NeMo-RL Markdown 文档更新 docs/index.md，并检查类和函数是否使用 Google 风格 docstring。”该技能不适用于 Bug 修复、测试修复、依赖升级、重构、CI/CD、性能调优或不涉及文档编写与更新的任务。