Knowledge Management Article Review Process


In this article

Follow the steps below (in this order) to review an article.

Testing

Top

Formatting

Top

Images

The image review process can include one or all of the activities listed below. For complete details about the image review process, see the Reviewing Images in the knowledge Base article.

Top

Style

The editor's order of operations

  1. Read the text. Do not edit it. Get a feel for it, where it's going, what it's about and so on.
  2. Apply a fine-toothed comb. Fix typos, punctuation, usage and grammar mistakes. Fix style mistakes. All articles must follow the Knowledge Management Style Guide. Where the Knowledge Management Style Guide has no guidance, default to AP Stylebook. Review technical terms and jargon; any new terms must be brought to the attention of the team for review.
  3. Look at the big picture. Does the structure of the text make sense? Is the information in the right order? Does it flow from one idea smoothly? Is everything clearly explained? Does it have any unanswered questions or missing information? Almost all articles should answer the basic questions: Who, what, when, where, why and how. 
  4. Fact-check everything. Verify all names and titles. Check dates. Check that links work.
  5. Revise. This is done whenever new information is added and can include: removing redundancies, trimming wordy text, making sure that no other editing introduce gaps in the article.

Considerations

When to consult a supervisor or subject matter expert

Adapted from Copy editing protocols by Nick Juliano (links to a downloadable PDF).

Changes in which a consultation is not required:

Changes in which a consultation is recommended:

Changes in which a consultation is required:

Top

SEO

These are the main tasks performed when reviewing SEO for a KB article.

Top