[Documentation] [TitleIndex] [WordIndex

wge100_camera/Reviews/2010_01_21_Doc_Review

Reviewer:

Instructions for doing a doc review

See DocReviewProcess for more instructions

  1. Introduction scopes users well and points to other good starting points
  2. All APIs seems to be documented, except as noted below
  3. Tutorials exist. Tutorials on external triggering are light on explanation, but since these come pre-configured, this may be enough.
  4. Hardware dependencies are documented.
  5. Is it clear to an outside user what the roadmap is for the Package?
  6. Is it clear to an outside user what the stability is for the Package?
  7. Are concepts introduced by the Package well illustrated? The timing could be confusing to a new user. Other than that, it seems good.
  8. Is the research related to the Package referenced properly? i.e. can users easily get to relevant papers? N/A
  9. Are any mathematical formulas in the Package not covered by papers properly documented? N/A

For each launch file in a Package

  1. Is it clear how to run that launch file?
  2. Does the launch file start up with no errors when run correctly?
  3. Do the Nodes in that launch file correctly use ROS_ERROR/ROS_WARN/ROS_INFO logging levels?

Concerns / issues

Eric

Tutorials

Rob

Main page

Advanced commands

Tutorials

Conclusion

Eric

Rob


2022-05-28 13:08