Body
New Article Checklist | Article Review Checklist
Use these checklists when creating a new knowledge base article or performing major edits on an article.
New Article Checklist
- Make sure you are not duplicating an existing article. Before creating a new knowledge base article, check if there is an existing article on the same topic. If so, update the existing article; do not create a duplicate.
- Confirm that the article is in the appropriate category. Should the article be in an internal category?
- Check the article for ADA accessibility.
- Confirm image accessibility, ensuring that all images have appropriate alt tags.
- Use links appropriately.
- Link accessibility
- Link accuracy
Check all links from the published article to confirm that the link was inserted into the article correctly and goes to the appropriate page and the appropriate information.
- Links to relevant articles should be used as well as creating related articles.
- Links to external pages should open in a new tab or window.
- Confirm that headings are used appropriately and follow accessibility guidelines.
- Confirm that lists are used appropriately and follow accessibility guidelines.
- Lists are created using HTML.
- The appropriate list type (bullets or numbers) is used.
- Check for acronyms, abbreviations, and unusual words that may need a glossary link or to be added to the glossary.
- Confirm that appropriate tags have been associated with the article. (TDX: Working with Tags)
- Make sure the Summary is an appropriate description of the article.
- Make sure the article order in the category is appropriate; the most important information should come first. Articles should be ordered with gaps in the numbering so that new articles can easily be inserted into the list in the correct order.
- Does the article need a table of contents?
- Would the article clarity increase with the use of screenshots or other images?
- Confirm that the appropriate Audience has been clarified.
- A general proofread should be completed for clarity, typos, misinformation, spelling and grammatical errors, standards, styles, and consistency. Make sure any prerequisites are explained before process instructions.
- Is there a Related Service for this article?
- If so, make sure to relate it to the article, and make the request button available on the article.
- Check the service description to make sure the information is consistent with the information in the article. The service description might also need to be updated.
- Are there Related Articles for this article?
- Does the article need to be sent to the responsible SME for review?
- Does the article have a Review Date set so that a reminder for review will be sent to the article owner?
Article Review Checklist
- Does the article contain outdated information?
- Is there new information available that should be added to the article?
- Does the article need more detailed information added?
- Rewrite confusing content
- Check all the links in the article at every review. Linked pages might be gone or the information changed to no longer be relevant.
- Send the article to SME (Subject Matter Expert) for review if necessary.
- Remember to set a new review date.