Overview
Document the quality standard used for this help center.
Main purposeDocument the quality standard used for this help center.
Important areasEnd-user language, route accuracy, workflow coverage, fields, best practice, troubleshooting, FAQ, permissions, no technical noise.
Business valueA clear rubric keeps future help pages consistent, useful, and supportable.
Where To Find It
Common Path: Help Center > Quality Rubric
Exact access can depend on your QCRM role. If the menu item is not visible, ask an administrator to review your permissions.
How It Works
- Each guide should be understandable by customers and end users without developer knowledge.
- Each guide should name where the user finds the feature and what business work it supports.
- Each guide should include workflow, fields, best practice, troubleshooting, and FAQ coverage.
Main Areas
| Area | What It Is Used For |
|---|---|
| Audience | End users, clients, and customers. |
| Navigation | Where To Find It section. |
| Workflow | Recommended steps. |
| Fields | Important fields and controls. |
| Support | Troubleshooting and FAQ. |
Important Fields And Controls
| Field Or Control | What It Means | When To Use It |
|---|---|---|
| Customer language | Plain operational wording. | Avoid framework, database, and code terms. |
| Feature path | Menu or page path. | Keeps guides discoverable. |
| Permissions note | Explains missing menus or disabled actions. | Avoids confusion for role-limited users. |
| Actionable steps | Numbered workflow. | Makes the guide usable during real work. |
| Safety note | Warns about deletion, imports, numbering, or customer-facing output where needed. | Reduces mistakes. |
Recommended Workflow
- Check that the guide title matches a real QCRM feature or shared workflow.
- Check that the path is useful to an end user.
- Check that fields and statuses match current QCRM behavior.
- Check that troubleshooting covers likely first-line support issues.
- Check that the guide does not point to OneDrive or unrelated developer-only files.
Best Practice
- Review guides after major UI changes.
- Keep examples generic unless a customer-specific process is required.
- Prefer adding a new focused guide over making one page too broad.
Troubleshooting
- If a guide sounds technical, rewrite it from the user's task perspective.
- If a guide is too long, split setup, daily workflow, and troubleshooting into separate pages.
- If a guide references a removed menu item, update the path and index metadata.
FAQ
Was this rubric used for the generated guides?
Yes. The generated guide set follows this structure.
Can future guides use a different format?
Yes, if the format remains customer-facing and easier to use.