Universal review principles
These three principles override all other style rules.
UI Fidelity
Requirement: Match system UI exactly for all UI element references.
Applies to: Capitalisation, spelling, punctuation, formatting.
Example: If UI shows 'Invoicing and Payments' → use 'Invoicing and Payments', even if violates sentence case.
UK English standard
Requirement: Use UK English spelling, grammar, dates, punctuation.
Spelling: colour, authorise, optimise, centre, licence (noun).
Dates: 14 February 2025 (no ordinals).
Exception: UI Fidelity takes precedence for UI elements.
Accessibility Over Brevity
Include all necessary information for clarity.
Never skip steps or assume knowledge.
Complete instructions over shorter instructions.
Explain jargon even if it makes content longer.
Individual review criteria
Category 1: Context and searchability
1. Title is problem-focussed
Points: 2.
✅ Pass: Focuses on user goal.
❌ Fail: Describes internal processes.
2. Title avoids 'How-to', 'To', or '-ing'
Points: 4.
✅ Pass: "Create a new user".
❌ Fail: "How to create a new user" | "Creating a new user".
3. Title is one line
Points: 1.
✅ Pass: Fits single line.
❌ Fail: Wraps to multiple lines.
4. Title uses sentence case
Points: 2.
✅ Pass: "Create a new user" | "Invoicing and Payments overview" (UI match).
❌ Fail: "Create a New User".
5. Customer-focussed description
Points: 2.
✅ Pass: Focuses on user goal.
❌ Fail: Describes internal processes | Repeats the title exactly.
6. Description adds context and doesn't repeat the title exactly
Points: 2.
✅ Pass: Expands on title with new context.
❌ Fail: Identical or nearly identical to title.
7. Description uses correct punctuation and sentence case
Points: 4.
✅ Pass: Correct grammar, ends with full stop, uses sentence case throughout. Only first word and proper nouns capitalised.
❌ Fail: Missing punctuation, incorrect capitalization such as Title Case, grammar errors.
8. Article placed in the correct collection
Points: 4.
✅ Pass: Article in appropriate collection.
❌ Fail: Wrong collection, hard to find.
Category 2: Tone of voice and clarity
9. Confident tone
Points: 4.
✅ Pass: Certain language like "Click Save to update".
❌ Fail: Uncertain phrases such as "should be able to", "probably can", "might work".
10. Plain, concise language
Points: 4.
✅ Pass: Jargon explained immediately.
❌ Fail: Unexplained technical terms, unnecessarily wordy.
Example: "Dangerous Good Note (DGN)" ✅ | "DGN" alone ❌.
11. Active tone of voice
Points: 1.
✅ Pass: "You can open the file".
❌ Fail: "The file can be opened".
Exception: OK for UI quotes.
12. No unnecessary repetition
Points: 1.
✅ Pass: No tautology present.
❌ Fail: "Re-enter again", "repeat again", "return back".
13. Acronyms introduced correctly
Points: 2.
✅ Pass: "Statutory Maternity Pay (SMP)".
❌ Fail: Uses "SMP" without defining.
14. Complete, grammatically correct sentences
Points: 2.
✅ Pass: No missing words, correct tense, plural agreement.
❌ Fail: "You can print report" (missing "the").
Category 3: Structure and navigation
15. Clear introduction explaining the purpose of the article
Points: 4.
✅ Pass: Clear context for what user will achieve.
❌ Fail: No introduction, jumps straight to steps.
16. Conditions and permissions stated where needed
Points: 2.
✅ Pass: "You'll need Administrator permissions".
❌ Fail: Vague ("appropriate access").
17. Introduction avoids 'In this article' and similar phrasing
Points: 1.
✅ Pass: Direct language.
❌ Fail: Meta-commentary openings.
18. Correct navigation verbs
Points: 2.
**Click**: buttons, commands (PC/hybrid).
**Tap**: touch apps (mobile/tablet).
**Select**: checkboxes, radio buttons, list items.
**Clear**: clearing checkboxes.
**Open/Close**: apps, files, folders.
**Go to**: websites.
**Turn on/off**: toggles.
❌ Fail: "Tick" (use Select) | "Untick" (use Clear).
19. Avoids 'Access' or 'Navigate to' verbs
Points: 1.
✅ Pass: "Click Settings, then click Personal"
❌ Fail: "Access Settings" | "Navigate to Personal"
20. Correct header size used
Points: 1.
✅ Pass: Logical hierarchy (H1→H2→H3), sentence case.
❌ Fail: Skipped levels (H1→H4) | Title Case headers.
21. Dividers used correctly
Points: 1.
✅ Pass: Dividers after H1 sections only | Dividers have a line break before and after.
❌ Fail: Dividers after H2/H3/H4 | Double dividers | Dividers without line breaks.
Category 4: Formatting and visuals
22. Correct Access Button format
Points: 4.
✅ Pass: "Click **Access Button** [image]".
❌ Fail: Not bold | Wrong caps | Uses "the".
23. Correct use of bold
Points: 4.
✅ Pass: Bold only for UI elements in steps.
❌ Fail: Bold for emphasis | Bold outside steps.
Exceptions: Access Button, callout intros, options in bullets.
24. Correct use of numbered and bullet lists
Points: 2.
✅ Pass: Capital first letter, ends with full stop, proper list markup and formatting with correct indentation.
❌ Fail: No capitals, no full stops, bullets used for sequential steps, numbers used for non-sequential steps.
25. Tables include headers
Points: 1.
✅ Pass: Headers use H3, grey highlighting.
❌ Fail: No headers, wrong formatting.
26. Correct callout type used
Points: 4.
📌 **Note**: Nice to have info.
🤓 **Tip**: Extra helpful guidance.
⚠️ **Important**: Essential info (issues if missing).
⚠️ **Warning**: Serious consequences if unknown.
27. Callouts formatted correctly
Points: 4.
📌 Note: - Blue callout box.
🤓 Tip: - Blue callout box.
⚠️ Important: - Yellow callout box.
⚠️ Warning: - Red callout box.
❌ Fail: Missing colon | Not capitalised | Wrong emoji. | Wrong colour.
28. Multiple callouts are combined appropriately
Points: 3.
✅ Pass: Same type consecutive callouts = single box with bullets.
❌ Fail: Same type consecutive callouts = multiple callout boxes.
29. Images add value and contain no sensitive data
Points: 4.
✅ Pass: Help understanding/navigation, no sensitive data.
❌ Fail: Decorative only, contain sensitive data.
30. Images use wrap text
Points: 1.
✅ Pass: Text flows around embedded images
❌ Fail: Text breaks the sentence over multiple lines.
31. Videos are placed logically
Points: 2.
✅ Pass: After intro, followed by written steps.
❌ Fail: No intro, no steps, mid-sentence.
32. Videos play correctly and match the article content
Points: 4.
✅ Pass: Plays correctly, matches description.
❌ Fail: Broken, wrong content.
33. Hyperlinks are clear, concise, and descriptive
Points: 2.
✅ Pass: "[user guide]" | "[more information]" (under 4 words, descriptive).
❌ Fail: "[click here]" | "[guide].".
34. Product names are written in full
Points: 3.
✅ Pass: "Access Care Rostering" (full name).
❌ Fail: "ACR" | "Collins" (missing "Access").
35. No whitespace at the end of the article
Points: 1.
✅ Pass: Clean ending.
❌ Fail: Multiple blank lines at end.
Category 5: Language and punctuation standards
36. Correct punctuation throughout
Points: 3.
✅ Pass: All sentences end with punctuation | Appropriate use of commas etc.
❌ Fail: Sentences end without punctuation, missing commas etc.
Exceptions: Headings, sentences ending with emoji, file extensions
37. No brackets or slashes for alternatives or plurals
Points: 2.
✅ Pass: "Click Edit or Add" | "Use Statutory Maternity Pay (SMP)" (acronym OK). | "Add and Edit menus" | "Add or Edit".
❌ Fail: "Click Edit (or Add)" | "employee(s)". | "Add/Edit" | "and/or".
38. Correct spelling used throughout
Points: 2.
✅ Pass: "A separate section" | "Organise your workflow".
❌ Fail: "A seperate section" | "Organize your workflow"
Exceptions: UI labels or code strings that use different spelling.
39. No dashes used in place of correct punctuation
Points: 1.
✅ Pass: "You'll need three things: patience, time, focus".
❌ Fail: "You'll need three things - patience, time, focus".
40. Correct number formatting
Points: 2.
Spell out 0-9, numerals 10+.
✅ Pass: "nine new features" | "5 options and 15 checkboxes".
❌ Fail: "9 new features" | "five options and 15 checkboxes".
Exception: Numerals for product features regardless of value.
41. Correct date formatting
Points: 2.
✅ Pass: "14 February 2025" | "14/02/2025" (in UI examples).
❌ Fail: "14th February" | "Feb" | "February 14, 2025".
42. Single quotes used only for system messages
Points: 2.
✅ Pass: "You'll see 'User undefined' message".
❌ Fail: "The 'correct' way" (emphasis) | "User undefined" (no quotes).
Scoring bands
90-100: Excellent - Fully compliant or minor polish only.
85-89: Great - Meets standards with small improvements needed.
75-84: Fair - Several improvements needed.
65-74: Needs improvement - Noticeable gaps, revision of guidelines needed.
<64: Not meeting standards - Significant issues, rewrite required.
