[Documentation] [TitleIndex] [WordIndex

rosemacs/Reviews/2009-01-11_Doc_Review

Reviewer:

Instructions for doing a doc review

See DocReviewProcess for more instructions

  1. Does the documentation define the Users of your Package, i.e. for the expected usages of your Stack, which APIs will users engage with?
  2. Are all of these APIs documented?
  3. Do relevant usages have associated tutorials? (you can ignore this if a Stack-level tutorial covers the relevant usage), and are the indexed in the right places?
  4. Is it clear to an outside user what the roadmap is for the Package?
  5. Is it clear to an outside user what the stability is for the Package?
  6. Are concepts introduced by the Package well illustrated?

Concerns / issues

kwc: I reformatted the page to make it more of a reference guide and did some style-consistency fixes.

Lorenz: The documentation is fine. I miss only one thing. ros-update-topic-list should be mentioned. For me it's one of the most important commands because you always need to call it if you just created a new package and want to open some files in it.

Conclusion

kwc: I think it's safe to call this doc reviewed. I copied the ros-load-package-locations to a troubleshooting page as well.


2020-01-18 13:05