Self Review Checklist

Open Liberty guide self-review checklist

Technical review

• Is the code technically accurate?
• Is the code following the best coding practices?
• Is the code following the correct structure in the Guidelines for Structure and Styles?
• Is the code formatted with 88-character line limit?
• Can you clone the repository without any errors?
• Can you run the finish directory with no error?
• After you follow the guide instructions and complete the code, can you run the start directory with no error?
• Does the start directory contain only the starting point of the guide with the base code?
• Does the finish directory contain the finished application?

Instructional review

• Is the guide content accurate?
• Is there enough content for the guide's length?
• Does the guide explain major technologies appear in the code?
• Is the guide consistent with the template in the drafts-guides-template and other guides?
• Can the guide build/render properly to HTML format as intended? (contents, headings, paragraphs, code snippets, outputs)
• Are the guide page properties defined correctly? e.g. page-duration, page-releasedate, page-description, page-related-guides
• Did you add your guide's project id to the desired subcategory in guide_categories.json?
• Did you add your guide's project id to the desired tags in guide_tags.json?

Language review

• Is the guide free of typos and grammar errors?
• Does the title inform the user of subject of the guide?
• Does the abstract provide more information about the purpose of the guide and what the user can gain by completing it?
• Is the abstract not simply a restatement of the title?
• Are sentences primarily written in the present tense?
• Are sentences primarily written in active voice instead of passive voice?
• Are potentially new or unfamiliar terms and names properly defined? Do words in code phrases include descriptive words after them, such as "the server.xml file" instead of just "the server.xml"?