Doc review

Proposer: Wim Meeussen

Present at review:

  • List reviewers

Question / concerns / comments

Enter your thoughts on the Doc and any questions / concerns you have here. Please sign your name. Anything you want to address in the Doc review should be marked down here before the start of the meeting.

Vijay

  • "Define the Users of your Package, i.e. for the expected usages of your Stack, which APIs will users engage with?"
    • Not very clear. I would add something like this:
      (In the Node section). "The preferred way to run the robot_state_publisher is as a node. You need two things:..."

  • "Do relevant usages have associated tutorials?"
    • Not available. Instead of a tutorial, a copy/paste-able example usage code block might be sufficient
  • Anything resembling like a roadmap is nowhere to be found
  • Stability is not explained anywhere

Meeting agenda

To be filled out by proposer based on comments gathered during Doc review period

Conclusion

Package status change mark change manifest)

  • /!\ Action items that need to be taken.

  • {X} Major issues that need to be resolved


Wiki: robot_state_publisher/Reviews/2009-09-25_Doc_Review (last edited 2009-09-24 20:13:32 by VijayPradeep)