Review Process

Introduction

1. Content Review - Review by the architect for the guide content
2. Peer Review - Review by a member in the team
3. SME Review - Review by SME for technical accuracy and feedback
4. User Review - Review and walkthrough by a non-SME (e.g. new user, less experienced person) to ensure the guide works, and that the structure makes sense and is usable
5. Information Development Review - Review and editing for language
6. Pre-publishing Test Review - Review the final version of the guide before publishing, make sure code and guide work perfectly fine
7. Post-publishing Test Review - Review the published guide, make sure everything displays properly

Peer

Review(s) by team member(s):

• Working instruction and sample
• Quality of code and project setup
• Consistency of /start and /finish
• Quality and presentation of guide
• Consistency of guide with template and other guides

Content

Review of the content and structure of the guide by a senior member of the team e.g. the architect or a developer experience lead to ensure the direction, flow and quality of the guide meets requirements and expectations.

SME

Review of the guide by a SME for technical accuracy and content.

User

Allow a person with a fresh mind to read the guide and execute the steps described in the guide, test whether each step is clear enough to understand, and no logic errors.

.Review and walkthrough by a non-SME or a new user with a critical and fresh pair of eyes:

• Follow the guide and walk through from start to finish
• Learn and implement as instructed by the guide
• Identify anything that doesn't work or doesn't make sense or confusing ...
• Feedback for each guide on its effectiveness to lead a new user through the topic to achieve basic understanding/working knowledge and any suggestion for improvements

ID

Review and edit of the text of the guide by a member of the ID team. May involve multiple rounds of editing.

Pre-publishing tests

• Check appearance on the test site for the guide. Verify that all text (contents, headings, paragraphs, codes, outputs) are displayed properly.
• Start from fresh, clone the repo and run "mvn install" on the finish directory.
• Follow the steps to test the guide to make sure it's working (from /start to finish).

Post-publishing tests

• Check appearance on the test site https://openliberty.io/guides for the guide. Verify that all text (contents, headings, paragraphs, codes, outputs) are displayed properly.
• Start from fresh, clone the repo and run "mvn install" on the finish directory