用途:该技能用于检查和配置项目的代码文档标准与文档生成器,适合在搭建 docstring 规范、配置文档生成器、审计文档覆盖率或向 CI/CD 添加文档强制规则时使用。不适用于撰写函数或模块的实际文档内容、部署文档到 GitHub Pages、单独配置 pre-commit 钩子,或编辑非文档类 lint 规则。
主要能力:自动识别项目语言(TypeScript、JavaScript、Python、Rust)并检查现有配置,输出合规报告;按语言配置文档标准;配置文档测试;搭建文档生成器;在已存在 .pre-commit-config.yaml 时添加文档钩子;更新 .project-standards.yaml 跟踪信息。
参数:--check-only 仅报告不修改;--fix 自动修复;--level <minimal|standard|strict> 设置强制级别,默认 standard;--type 覆盖语言检测;--generator <typedoc|sphinx|mkdocs|rustdoc> 覆盖生成器检测。强制级别:minimal 仅语法校验,standard 要求公共 API 文档,strict 要求所有条目含私有项均有文档。
生成器默认匹配:TypeScript/JavaScript 用 TypeDoc,Python 用 MkDocs 或 Sphinx,Rust 用 rustdoc,多语言或其他用 MkDocs。
典型执行步骤:检测语言,分析当前文档配置状态,生成合规报告;在 --fix 或确认后按语言写入配置(如创建 tsdoc.json、安装 typedoc、配置 pyproject.toml 的 pydocstyle、设置 Cargo.toml 的 missing_docs lint),配置文档测试和生成器,若存在 pre-commit 配置则添加钩子,最后更新标准跟踪文件。
常用命令示例:/configure:docs --check-only、/configure:docs --fix、typedoc --emit none、ruff check --select D --output-format=github、cargo doc --no-deps、mkdocs build --strict。
限制:具体模板细节需查看 REFERENCE.md;不负责文档内容撰写与 GitHub Pages 部署;对未明确支持的语言、具体价格或平台支持情况暂未提供。