UX: implement modal interface

[ribose-jeffreylau]

Each mode is a different entry point. Taking the following use cases into consideration:

• audit mode
  • sub-mode: manage NC, CAPA, audit plan, audit programme
  • sub-mode: internal auditor mode
  • implements {save/load/undo/redo}
  • generate audit plan
  • generate audit report
  • sub-mode: internal auditee mode
  • sub-mode: external auditee mode (for 2nd and 3rd party)
  • can transition to:
  • manage mode
• external auditor mode (for 2nd and 3rd party) (future work?)
  • QUESTION: should it be a separate client altogether? Most probably.
  • implements {save/load/undo/redo}
  • generate audit plan
  • generate audit report
• manage mode
  • implements {export/import}
  • for modes: { build, mapping }
  • sub-mode "build" mode:
  • allows for the following types of standards (source: training materials from SCC onboarding):
    • management system standards
    • build out "digital twin" of existing organization processes
    • currently it's called "implementation"
    • performance standards
    • e.g. measure product performance under specific environments
    • TBI
    • prescriptive standards
    • e.g. material thickness, type
    • TBI
    • service standards
    • e.g. measure fitness of purpose of a particular service
    • TBI
    • design standards
    • e.g. specific product characteristics
    • TBI
  • implements persistence mechanism A
  • manage evidence
    • manage links to external documents
  • sub-mode "mapping" mode: (to reference models)
  • implements persistence mechanism A
  • compare between mapping versions
  • TODO put existing "auto-mapper" here
  • sub-mode / sidebar: explore mode
  • browse / search for potentially relevant reference models
    • from local / remote repositories
    • compare between model editions
    • show graph of linked models (arrow <=> "has normative references to")
  • features:
  • dashboard for overview of compliance
    • statuses of previous audits including CAPA
  • view/manage audit schedule
  • can transition to:
  • audit mode
• reference model authoring mode (future work?)
  • implements persistence mechanism A
  • fine-tune existing reference model (e.g. those imported from metanorma)
  • author from scratch (?)
• integration mode (future work?)
  • a background daemon integrating into existing organization workflows, providing hook API, etc., e.g. to send out reminders to specific teams, start scheduled events, send out various reports, etc.
  • the daemon itself can have an API...

Splitting into modes allow documentation that is more focused on specific user stories as well as a more focused UI, in turn lessening the need of extensive documentation.

persistence mechanism A

Choices:

• Use git with autosave + {undo/redo/changelog}
  • {import/export}
  • Imported model replaces current one (~= HEAD / "working copy" in git's term)
  • could add tagging to specific versions
  • which naturally leads to a UI with ability to manage tags, compare between tags, etc.
• {save/load} + {undo/redo/changelog}
  • could potentially autosave but saves to a file with all relevant states
  • Loaded model replaces current one
  • Comparison between versions require choosing a file -- not as intuitive.