- Group hub-documentation into explanation/, how-to/, and reference/ per Diátaxis - Move ifs-integration.md to new hoist-hub/ category - Add contributing/ category with Diátaxis framework explainer - Move tutorial-basics and tutorial-extras under docusaurus-guide/ - Rewrite docs/intro.mdx as site entry point with category navigation - Update all doc titles to reflect their Diátaxis type - Add HOIST logo to homepage hero and fix Get Started link
2.4 KiB
sidebar_position, title
| sidebar_position | title |
|---|---|
| 2 | Functional Design Definition |
Functional Design Definition
This section, crafted by the Hoist Business Analyst in close partnership with the customer, provides a comprehensive guide to the solution. It outlines how the HUB feature will address the requirements specified in the Business Requirements section, ensuring all aspects are thoroughly covered.
To support developers — especially those unfamiliar with the relevant IFS functionality — this section includes:
- Process Flow Diagram done in Visio (e.g., Create Quote to Convert to Order). Start by reviewing the master flow diagram: Mobile and IFS Flow on Hoist Hub in SharePoint. Diagram needs to fit in an 8.5 x 11 Portrait format.
- Screens — description, mock-ups, fields, buttons and actions, workflow
- Approvals — approval logic if needed
The customer will review and approve this section during the sign-off process to confirm it aligns with their expectations.
Screens
For each screen, document the following:
Screen Description
Describe the purpose of the screen and the general use of it.
Screen Mock-Ups
Visual representations of the user interface. Initially display wireframes done in Visio or Balsamiq. As screens are developed, take snapshots and annotate changes with Snagit.
Fields
Fields in the table must be in the order they appear on the screen.
| Name | Characteristics | Notes |
|---|---|---|
| Quotation No | View Only | Populated on Save to IFS |
| Customer | Dropdown, Mandatory | Dropdown from IFS Customers |
| Delivery Date | Enterable, Mandatory, Date Field | Date Picker |
Characteristics legend:
- View Only
- Enterable
- Mandatory / Not Mandatory
- Dollar, Date, Text, Dropdown
Buttons and Actions
| Name | When Active | On Click Actions |
|---|---|---|
| Save | Always | Save Quote Header to IFS; Return the Quotation No; Save Quote record to HUB |
Workflow
Describe the workflow logic if needed:
- Sequential
- Parallel Any
- Parallel All
Approvals
Describe the approval logic if needed.
Permissions & Security
Use this section to define which HUB Profiles have which Permissions.
| HUB Profile | HUB Permissions | Notes |
|---|---|---|
| External User | Can Create Quotes on HUB | |
| External User | Can Delete Quotes on HUB | |
| External User | Can Update Quotes on HUB |