Content review instructions
Here are important guidelines for reviewing knowledgebase content (including FAQ pages) at the Rutgers Information Technology website. The key purpose is to ensure the materials have been migrated properly, key elements are not missing, and the content is free of major issues or problems. If there are problems, you should fix them, as outlined here — that is, the goal is to fix any problems with the content rather than just note what is incorrect.
You will be provided a spreadsheet that looks like this. For subsites that have not launched yet please make sure the url is a live url and not a wordpress preview url which contains “&preview=true” at the end of the url. If the link is a preview url (and the subsite has not launched yet), please publish the page and note it in the Notes column with your initials.
The login page for the core site can be found at https://it.rutgers.edu/wp-admin/. After logging in, dashboards for the various subsites can be found under the drop down menu, “My Sites.”
The following may look like a lot to do, but the big-picture goal is really just to make sure the page looks OK and does not have major errors or problems.
Here is what to review and correct:
Formatting
- Scan the page to ensure there are no major, glaring issues with formatting or appearance (i.e., blank images, awkward numbering or bullets, etc.).
- If the page is a list of steps, any numbers should be aligned to the left so that the images and numbers match up.
- If there are problems with formatting that you need to correct, use Heading 4 for major headers and use bold and Paragraph style for subheads.
Links
- Test all links in the website pages to make sure they work.
- Links to the legacy website being decommissioned such as https://oit-nb.rutgers.edu/: The Rutgers OIT- New Brunswick website will be decommissioned when this site goes live. Please check all links and remove and replace any links that go to the OIT website.
Title of KB articles and FAQs
- Convert titles to what is known as “down style,” if this hasn’t already been done. Down style means that only the first word and proper nouns are capitalized. For example: Using WordPress to migrate knowledgebase article for website. (“Up” style would be: Using WordPress to Migrate Knowledgebase Article for Website.) Also, as an FYI: The title is the main header for the WordPress page; it is what appears in the one-line text field below “Edit KB Article” or “Edit FAQ Page” in the WordPress editor.
- Make sure all titles contain the name of the subsite. For example, if you’re working on the RAMS subsite and you see a title which says “How to request a new list,” you would update the title to “How to request a new RAMS list.” Please note this action on the spreadsheet.
Published date
- At the bottom of the page, look for the “published” date. If it’s a recent date, change the “Published on” date for the article listed in the WordPress editing sidebar. To do this, use the date from the “Last updated (legacy website)” column in the migration spreadsheet (that’s the actual date when the article was last updated).
Images
- On some pages, images (typically screenshots) may look fine, but they are actually just linking to the legacy website (that is, the one that’s being decommissioned). For pages with screenshots or other images, check to make sure photos are stored at the Rutgers Information Technology website, NOT at the legacy website.
- To check and correct this, you can right-click or control-click on the image, choose “Copy Image Address,” and then paste that link into a new browser tab, where you’ll be able to see if the image is stored at the legacy website; if the image is stored at the legacy website, then download the image, delete the previous image, and upload the same image.
- Note that you can usually just check one image per page, as that will typically indicate whether the images on that page were migrated properly or improperly.
- Please check image to ensure they all have “alt tags.” A recommended alt tag is a brief description of the image that is 125 characters or less. To add an alt tag, click on an image from the editor view of the page, click the edit button (it looks like a pencil), and then insert the brief description in the “Alternative Text” field. Important: Do not enter anything in the Caption field.
Spelling, grammar, and other errors
- If you encounter obvious errors in grammar, spelling, etc., please correct. You don’t need to read through the whole article, but scan the title and subheads.
Notes
- In some cases, existing issues will be noted in the Notes column of the spreadsheet. Try to fix these issues, if possible.
Tracking your work
Be sure to track your work as follows:
- Use the spreadsheet sent to you by email.
- You can see what you have been assigned to review via the “Review assigned to” column (not the “Assigned to” column).
- Once you have reviewed, enter either “Complete” or “Additional” in the Review column.
- If additional work is needed, put that in the notes section with your initials.
