Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

User documentation - implementation plan (Option A)

This page is the program plan for non-technical, page-centric documentation hosted in Docusaurus under documentation-site/docs/tutorials/ (Option A: expand the existing tutorial area rather than a new docs plugin). Engineering drafts and deep references remain under documentation/Decision-pro/docs/ (see user-guides/README.md there).

1. Objectives​

ObjectiveSuccess signal
Operators know what each screen is for and what happens when they actFewer “how do I…?” tickets for covered flows
AIS is understandable in business languageCommittees can explain scoring / policy / classification without API terms
Roles match realityGuides align with Decision-pro/constants.ts and lib/auth/permissions.ts
Legal safetyProduct text defers to Legal disclaimer where binding terms matter

2. Scope (in / out)​

In scope

  • Decision PRO routes in navigation (SIDEBAR_NAV in Decision-pro/constants.ts), including premium and upcoming items (marked clearly).
  • Detail routes (e.g. /loans/applications/[id], workflows [id]) at the level of tabs, outcomes, and operator actions.
  • AIS concepts that surface in Pro: scoring, policy vs model, default risk views, dynamic pricing, asset / NBE context, recommendations where the UI exposes them.

Out of scope for main guides

  • Raw OpenAPI, env var catalogs, internal .cursor / .kiro plans (staff-only).
  • Legal interpretation of regulations (bank counsel remains authority).

3. Information architecture (Option A)​

LayerLocation
Published user guidesdocumentation-site/docs/tutorials/** (this sidebar)
Authoring / deep annexesdocumentation/Decision-pro/docs/user-guides/** + existing files (USER_TRAINING_CREDIT_SCORING.md, COLLECTIONS_WORKFLOW_AI.md, etc.)
Partner / diligence toneExisting partner routes (/decision-pro-for-banks/, etc.) - do not merge legal copy into operator tutorials

4. Standard page template (every guide)​

Each feature page should eventually contain:

  1. Purpose - who uses it and when.
  2. How to open - menu + path (e.g. /loans/applications).
  3. Who can access - roles / “ask admin if missing.”
  4. What’s on the page - lists, tabs, KPI areas.
  5. Primary actions - what changes after click (status, row, export).
  6. Inputs & outputs (business) - fields and results operators expect.
  7. Downstream - where data shows next (approvals, audit, 360).
  8. Misunderstandings - callout (e.g. origination vs servicing).
  9. Related pages + glossary links.
  10. Optional “For IT” - one link to integrations/OpenAPI.

5. Phased rollout​

Phase 0 - Foundation (week 1-2)​

  • Option A tree under docs/tutorials/ with categories and hub index.md.
  • This implementation plan + monorepo documentation/Decision-pro/docs/user-guides/README.md.
  • Screenshot standards (mask PII, tenant name, theme).
  • Route × role spreadsheet exported from constants.ts + RBAC_ROUTE_MANIFEST.md.

Phase 1 - Getting started (week 2)​

  • Draft pages: sign-in / sessions, roles & navigation, dashboard, global UX.
  • Record 2-3 minute walkthrough video for dashboard + nav.

Phase 2 - Loans (week 3-5)​

  • Draft pages: applications, detail tabs, approvals & analytics, disbursements/repayments, portfolio/documents/regulatory, Pro book, collections + workflows.
  • Screenshots + click-by-click from COLLECTIONS_WORKFLOW_AI.md and application NBE tab copy.

Phase 3 - Credit & pricing (week 4-6)​

  • Draft: main scoring, history/batch, realtime, default prediction, dynamic pricing.
  • Convert USER_TRAINING_CREDIT_SCORING.md into numbered labs with sample cases.

Phase 4 - Product factory & intelligence (week 5-7)​

  • Draft: product builder, rules engine, automation, ML & AI centers.
  • Confirm product recommendation surfaces in UI per tenant; add screenshots.

Phase 5 - Customers, analytics, admin (week 6-8)​

  • Draft: Customer 360, analytics, compliance/audit, administration.
  • Align Customer 360 with CUSTOMER_360_QA_MATRIX.md for training sign-off.

Phase 6 - Understanding AIS (parallel week 4-8)​

  • Draft chapters: what AIS does, scoring story, risk/policy/models, asset classification & NBE, freshness in Pro.
  • Product review for wording vs AIS marketing / contracts.

Phase 7 - Appendices & packaging (ongoing)​

  • Glossary, FAQ by role, missing-menu troubleshooting.
  • Printable PDF pack (placeholder already in glossary area).

6. Governance​

RoleTask
Product / CSOwns accuracy of “what user sees,” prioritization
Risk / ComplianceReviews NBE, compliance, approval language
EngineeringUpdates guides when nav, permissions, or tabs change (PR checklist)
TrainingOwns LMS packaging, quizzes

PR rule (recommended): Any PR touching Decision-pro/constants.ts or visible loan/scoring tabs must update the matching tutorial page or add a DOC-DEBT issue with milestone.

7. Coverage checklist (nav manifest)​

Use Decision-pro/constants.ts as source. Items marked premium / upcoming in code should say so in guides.

  • Mission control: /dashboard, /analytics, /admin/system-status, /audit-logs
  • Profiles: /customers, /businesses (upcoming)
  • Intelligence hub: /ai-center (premium), /scoring/credit-scoring, history, batch, /scoring/realtime-scoring, /default-prediction, /dynamic-pricing
  • Loans: portfolio, applications, approvals (+ analytics), disbursements, repayments, collections (+ workflows), documents, regulatory, pro-book
  • Management: /product-builder (premium), /rules-engine, /automation (premium), /vcard (premium), /compliance (upcoming), /integrations, /customer-service
  • Admin: /admin/users, /admin/billing (upcoming), /admin/configuration (upcoming), /settings
  • ML center: /ml-center (see lending/intelligence docs)

8. Success metrics​

  • Coverage: 100% of standard and premium nav targets have at least one Purpose + Actions section.
  • Freshness: “Last reviewed” footer on high-change pages each release.
  • Support: ticket tag reduction for documented flows (measure baseline first).

9. Where you are now​

This repository iteration delivers written drafts for Phases 1-6 and appendices (see sidebar). Remaining work is mostly screenshots, videos, tenant-specific examples, and legal/compliance sign-off-tracked in Phase 0-7 checkboxes above.

Monorepo pointer: documentation/Decision-pro/docs/user-guides/README.md

Back: Decision PRO & AIS - product guides