laser_pipeline/Reviews/2009-9-29_Doc_Review

Reviewer:

Instructions for doing a doc review

See DocReviewProcess for more instructions

1. Does the documentation define the Users of the Stack, i.e. for the expected usages of the Stack, which APIs will users engage with?
2. Are all of these APIs documented?
3. Do relevant usages have associated tutorials?

4. Have all Packages in the Stack been API reviewed?

5. Does the Stack conform to the StackDocumentation guidelines?

6. Are there Packages in the Stack that don't belong

Concerns / issues

Josh

Looks good to me

Wim

Well documented, very clear. The only page that is still blank in the troubleshooting page. Since the individual packages also don't have a troubleshooting page, maybe the stack page could contain:

• General debugging strategies to solve problems with a laser pipeline
• Explanation of error messages the laser pipeline produces

Conclusion

• The Troubleshooting page will get populated on an as-needed basis as problems are raised with the stack. Ideally some of the use-case experiences will give us some problems to seed here.