Search
Intermediate Certificate on pass

Public Docs Navigation

Module guides, role guides, walkthroughs, troubleshooting, and docs links.

3 lessons 40 min 5-question assessment 70% to pass

What you’ll learn

  • Explain the public support and customer success control purpose behind public docs navigation
  • Configure help center articles, search indexing, and public assistants
  • Handle customer maturity assessments, roadmap triages, and demo environments
  • Provide audit-ready customer support history logs and service SLA reports

Course content

3 lessons · 40 min of reading
01
Lesson 1 of 3 Reading 12 min

Map module guides

Public Docs Navigation focuses on public documentation navigation, mapping module directories, role guides alignment, and validating links. In AWRA, public support resources, help centers, and AwraIQ public assistants provide users with quick self-help guides, glossary lookups, and clear escalation routes.

The primary objective is support ticket reduction and customer enablement. Admins should organize search keywords and verify docs links before publication.

In practice, an editor verifies navigation sidebar routes, links troubleshooting files, and checks redirect links.

Navigation setup path

1

Structure

Group guides into module folders (e.g. Sales, Accounting).

2

Link

Create sidebar navigation nodes and link target documents.

3

Audit

Run link checker checks on all page URLs.

4

Publish

Sync sidebar configs with public documentation views.

Support model

  • AwraIQ assistants answer questions using verified docs references.
  • Help center articles must match structured categories.
  • Glossary lookups improve user terminal terminology clarity.
  • Always verify sitemap URLs before public search indexing.
02
Lesson 2 of 3 Workshop 14 min

Align role navigation guides

The operating routine is to map documentation folder paths, coordinate role guide navigation directories, audit page links, and edit redirects. That sequence prevents content gaps and ensures user feedback updates are applied promptly.

Before finalizing updates, check sidebar config files, folder paths, URL targets, redirect rules, and audit reports. These safety reviews protect help center structures, database references, and customer privacy details.

An administrator can edit help articles, map documentation directories, or monitor public query logs directly from the support manager.

Navigation troubleshooting

Signal Check Action
Broken doc link found Verify source and target URL patterns Correct link scheme reference in file and publish
New module guides ready Check module folder configurations Register guides in sidebar navigation and rebuild index
Legacy route redirect Identify outdated page URL references Add redirect code in routing config and test
Docs audit completed Check navigation structure checks Validate sidebar files and save changes

Support decisions

  • Publish help articles matching active categories indices.
  • Audit AwraIQ public query logs for unresolved gaps.
  • Organize glossary terms using consistent tag rules.
  • Manage public sitemaps to optimize search coverage.
03
Lesson 3 of 3 Practice 14 min

Verify documentation links

Support changes and documentation updates should leave proof. Useful evidence includes sidebar configs, link audit logs, folder directory sheets, and redirect rule registries, which is required for content audits and customer feedback reviews.

Management should review support metrics: ticket resolution speed, article view counts, and search query match rates indicate help center quality needs.

In practice, closure means navigation folders map correctly, redirect links resolve, and sitemaps are rebuild.

Docs navigation checklist

Sidebar folders are mapped
URL link check is clean
Redirect codes are active
Sitemap is rebuilt
Change logs are archived

Oversight validation

  • Confirm that change logs record documentation edits.
  • Verify that public sitemaps list all active URLs.
  • Validate that user feedback forms match articles keys.
  • Ensure support escalation paths are fully tested.

Finished the material?

Take the 5-question assessment and earn your certificate — 70% to pass.

Take the assessment

Help Center

Need a quick answer while you read?

Run inventory, procurement, assets, sales, and field work with approved AWRA guidance for setup, migration, integrations, security, pricing, and support.

Search all approved AWRA public help articles.

Open Help Center