Accessibility and Language QA
Use this checklist when reviewing documentation content before publishing it to users.
1. Language Quality
| Check | Standard |
|---|
| Business tone | Use clear customer-admin language, not technical implementation language. |
| Consistent terms | Use the same terms for risk, issue, finding, exception, assessment, and evidence. |
| Short sentences | Prefer direct instructions and simple explanations. |
| Action-focused text | Explain what the user should do and why. |
| No internal references | Do not mention internal implementation or hosting details. |
2. Arabic Quality
| Check | Standard |
|---|
| Clean Arabic | No mojibake or corrupted characters. |
| Consistent terminology | Use consistent translations for status, approval, evidence, owner, and workflow. |
| Natural admin tone | Use practical Arabic suitable for business administrators. |
| Direction | Confirm Arabic pages render right-to-left correctly. |
| Tables | Confirm tables remain readable on smaller screens. |
3. Screenshot Quality
| Check | Standard |
|---|
| Correct screenshots | The documentation site must show only screenshots that match the portal being used. |
| Current layout | Screenshots should match the current product layout. |
| No sensitive data | Screenshots should not expose real user, client, or confidential data. |
| Useful context | Screenshots should support the task being explained. |
| Alt text | Each screenshot should have descriptive alternative text. |
4. Accessibility Checks
| Check | Standard |
|---|
| Headings | Use clear heading order so users can scan the page. |
| Links | Link text should explain the destination. |
| Tables | Tables should have clear headers. |
| Images | Images should include useful alt text. |
| Mobile | Long tables should still be usable on small screens. |
5. Release QA Checklist
Before publishing documentation:
- Scan for corrupted Arabic characters.
- Build the documentation site for each customer portal.
- Confirm no unrelated names or screenshots appear.
- Open the English and Arabic home pages.
- Open the main Admin Guides section.
- Open screenshots and confirm they load.
- Review task index links.
- Review release notes for customer-facing accuracy.
- Confirm no internal technical content appears in customer pages.