Dashboard, quality checks and coverage

1. Overview & Business Value#

This comprehensive operational guide details the architecture, business workflows, configuration parameters, and execution steps for Dashboard, quality checks and coverage within SmartERP.

Three screens help you keep documentation true. All of them are built from real records, count only what you may read, and open the list behind every number.

{screenshot:quality-and-coverage-overview-dashboard}

2. Prerequisites & Security Access Groups#

• Required Modules: smarterp_docs
• Security Groups:
  • Technical Documentation Architect (Technical ID: base.group_system)
  • Enterprise User (Technical ID: base.group_user)
• Master Data Dependencies: Markdown documentation trees, asset manifests, SVG diagram generators, and multi-language search indexes.

3. Step-by-Step Configuration & Execution#

Step 1: Navigating to the Module Interface#

1. Log into your SmartERP instance at https://smarterp.et/odoo.
2. Open the main App Switcher (grid icon in the top-left corner).
3. Select the Documentation Portal app icon.
4. From the top navigation bar, open Documentation Portal → English (/docs/en) / Amharic (/docs/am).

{screenshot:quality-and-coverage-app-switcher-navigation}

Step 2: Creating and Parameterizing Records#

1. Click the New button in the top-left control panel.
2. Complete the mandatory fields in the record form:
   • Page Title (Mandatory): Standardized title conforming to Diátaxis framework
   • Summary (Mandatory): Concise operational summary describing page intent
   • Diátaxis Type (Mandatory): Valid classification (how_to, tutorial, concept, reference, admin_guide)
3. Configure optional operational parameters and localized tags as required:
   • Audience (Optional): Designated user roles (Accountants, Engineers, Administrators)
   • Difficulty Level (Optional): beginner, intermediate, or advanced
4. Click the Save icon in the control bar to commit the record.

{screenshot:quality-and-coverage-record-creation-form}

Step 3: Validating and Processing Transactions#

• State Transitions: Execute operational state progression (Authoring → Local Offline Test Validated → Manifest Registered → Published Live).
• Ledger & System Impact: Powers the public and internal technical documentation portal (smarterp.et/docs) with sub-second rendering and dual-theme visual diagrams.
• Audit Verification: Automated recording of author ID, timestamp, and immutable revision history.

{screenshot:quality-and-coverage-transaction-processing-state}

Dashboard#

Documentation → Dashboard shows tiles in four groups:

• Where the pages are: drafts, in review, published, needs review, deprecated, archived.
• Needs attention: pages waiting for your review, review dates that have passed, published pages with no summary or product or Amharic translation.
• Quality (last check): broken links, expired pages, empty pages, duplicate titles, stale pages, pages nobody links to.
• Coverage: empty slots, and products or modules with no page at all.

A number of zero is shown calmly. Click a tile to open exactly the records it counted.

Quality checks#

The rules are fixed and explainable. A page either breaks a rule, with a reason, or it does not. There is no score.

A daily job refreshes the issues, and Documentation → Quality → Check Quality Now does it on demand. Between runs the dashboard says when it last looked. External links are not checked automatically.

Coverage#

Documentation → Quality → Coverage is a matrix: a row for every product, area and module and a column for every part of a complete guide (Overview, Getting Started, User Guide, Administrator Guide, Configuration, How-To, Troubleshooting, FAQ, Developer Guide, API, Integration, Security, Migration, Release Notes).

A published page fills a column when its content type or its section's kind says so. A row counts the pages about it and about everything inside it. Missing is a cell with nothing in it. There is no percentage, because a count of what exists is more honest than a score.

4. Advanced Configuration Points#

• Automated Actions & Scheduled Tasks (Crons):
  • Documentation: Auto-rebuild search index (smarterp_docs.ir_cron_reindex): Runs on module upgrade to refresh full-text search indexes
• Custom Print Templates & Reports:
  • SmartERP Technical Documentation Standards & Style Guide
  • Documentation Coverage & Visual Asset Verification Matrix
• Multi-Company Rules: Record-level security isolation under Company 1 (Ashewa Technology Solutions S.C.), preventing cross-company ledger leakage across parent and subsidiary legal entities.

5. Comprehensive Troubleshooting Matrix#