用途:本技能面向 NeMo-RL 项目的文档编写与维护,提供文档约定,帮助在新增特性或文档时保持文档结构一致、可被 Sphinx 解析。
主要能力与要求:
- 保持 docs/index.md 最新:在 docs/**/*.md 下新增 markdown 文档或重命名 markdown 文件时,需同步更新 @docs/index.md,并将文档放入最合适的章节。
- docstring 格式:类与函数使用 Google 风格 docstring,确保可被 Sphinx 解析。对于可能在本文件之外使用的接口,优先使用 docstring 而非注释;注释应保留给函数内部代码或仅限本文件使用的接口。
- 记录新特性:新增特性时,在 docs/ 目录下更新或创建与该特性最匹配的文档;先查看现有文档找到最合适的位置,若不存在则新建文档并加入 @docs/index.md。
适用场景:NeMo-RL 项目中撰写或调整文档、补充新功能说明、统一 docstring 风格时使用。
限制:文档修改不适用于缺陷修复或 CI 相关变更;该技能明确不用于 bug 修复、测试修复、依赖升级与重构。关于是否有配套命令、安装方式、适用平台与收费信息,资料中暂未提供。