Verify documentation accuracy
documentation-accuracy-reviewersubagentsetup L1★393
alibaba/TorchEasyRec ↗What it does
Verify code documentation accuracy against implementation
Best for
Ensuring user docs match implementation when multi-layered documentation must stay in sync
Inputs
- · Python source files with docstrings
- · Protobuf config definitions
- · Docs directory
- · README and examples
Outputs
- · Documentation accuracy audit report
- · Issues categorized by type
- · File/location references with fixes
- · Severity prioritization
Requires
- · Glob
- · Grep
- · File reads
Preconditions
Python codebase with Google-style docstrings; docs directory present; README with model table
Failure modes
Misses indirect documentation via comments; false positives on deprecated APIs; proto enum gaps; user-facing docs lag behind code changes
Trust signals
- · Google-style docstring validation
- · Cross-references README model table with implementation
- · OSS bucket URL validation
- · Flags when code updated but docs lag