Body
Overview
The following checklist should be followed anytime a new knowledge article is Submitted for review, and anytime an existing article is updated and Saved as Draft.
In this article:
General Review
- Article is unique
- Article has been reviewed by both KB Contributor, and Service Owner
- Article is technically accurate, up-to-date, complete, and is in line with agreed service offering
Style
Article Title
- Summarizes article contents
- Is in Title Case
- Is the title concise
Content
- The first paragraph is a description, or problem statement that provides context to the article
- Sentences are concise and easy to read, paragraphs are short
- Information is well ordered; topics and subtopics are in logical sequence
- Refer to "users" as "customers"
- Information is technically accurate, up-to-date, complete, and is in line with agreed service offering
- Application interface terms are referenced as they appear on the interface
- Application interface references refer to current supported versions of application, unless the article is being written for a specific version
Format
- Topics, and subtopics are formatted as headers, starting as H2
- Use ordered lists for steps, and unordered lists for lists
- Application interface terms are in italics
- Link text clearly references the target content
- In-page links remain in same window
- Links to other University of Alaska resources remain in the same browser window
- Links to places external to the University of Alaska open in a new browser tab, or window
- Long articles use a table of contents (see Create in Article Anchor Links)
- Table(s) have a header row, column, or both
Media
- Images are uploaded to the Knowledge Base
- Images are appropriately sized
- Images are clear
- Images have effective alternative text
- Images are associated with the step they describe
- Animated GIFs work
- Embeded video work
Article Settings
- Article is in the appropriate primary Category
- The Owner is set to the service owner group
- The Tags include any appropriate terms, technologies, or services
- The Notify Owner on Feedback is checked