docs: migrate HOIST HUB Documentation Standard to Docusaurus

This commit is contained in:
jaime.meza committed 2026-06-18 12:54:44 -05:00
1 parent ce58a0c6e0
commit 8b30e9405b
19 files changed
+966

No files matched your search

@@ -0,0 +1,4 @@
{
"label": "Overview",
"position": 1
}
@@ -0,0 +1,21 @@
---
sidebar_position: 1
title: Purpose & Guidance
---
# Purpose & Guidance
This document specifies how the defined functions shall be developed or how the application shall be customized to solve the business requirements.
The **Solution Description** defines what will be delivered. The solution is matched against the requirements described in the Requirements section.
The **Delimitations** describe what is explicitly not covered by this spec. Together with the Solution description, these sections delimit the extent of the functional addition agreed for implementation.
The **Business Requirements and References** describe the business problem(s) to be resolved by this HUB spec. This section should be completed by a representative of the business user. The language of this section is aimed at capturing the desired outcomes and is less concerned with how those outcomes will be achieved.
:::tip[Important Reminders]
- Green texts include guidance and examples — remove them as the specification is written.
- Remove sections that do not apply.
- Spell and grammar check the document each time you save it and before it goes to the customer.
- Strict adherence to the initial and change order sign-off processes. No work/changes/fixes are given to developers before this step.
:::
+38
View File
@@ -0,0 +1,38 @@
---
sidebar_position: 2
title: Process Roles & Responsibilities
---
# Process Roles & Responsibilities
## Customers
Customers are responsible for understanding the business and/or IFS process and how the HUB spec applies to their specific solution. Before granting approval, the Customer must thoroughly review the document and ensure they fully comprehend its contents. We encourage customers to ask questions or seek clarification during this stage to avoid any misunderstandings.
Approval is a critical step, and we value the customer's input and feedback. However, once approval is granted, any legitimate requirements not identified during this stage — regardless of how they were overlooked — will be considered a change to the scope and may require additional agreements.
## Hoist Business Analyst
The Hoist Business Analyst acts as the primary point of contact between the Customer and the Hoist HUB Developer, ensuring that all communication is streamlined and efficient. To maintain clarity and avoid potential miscommunication, the customer should not have direct contact with the Hoist Developer. All communication must be routed through the Hoist Business Analyst to ensure that the documentation and re-sign off processes are strictly followed.
They handle any questions the Hoist Developer might have regarding the desired functionality, either providing answers directly or sourcing them as needed. Additionally, the Hoist Business Analyst is responsible for creating the test steps and then collaborates with the Hoist Developer to conduct preliminary testing before the HUB feature is delivered to the customer for final testing.
## Hoist Developer (DEV)
The Hoist Developer is responsible for the content of the Technical Design Definition. They will provide technical estimates, develop according to specifications, and create the required deliveries. The Hoist Developer will work with the Hoist Business Analyst to understand the required solution and offer guidance on the requested solution's feasibility and offer alternatives if the solution is determined to be problematic or inefficient.
:::warning
It is crucial that the Hoist Business Analyst does not commit to a feature with the customer before ensuring feasibility with the Hoist Technical Solution Manager or Hoist Lead Developer. Any feature that is not discussed with the development lead before committing to the client will be ignored.
:::
## Hoist Project Manager (PM)
The Hoist Project Manager is responsible for communicating the estimates and SOW to the appropriate leadership in the client business. They are responsible for getting the approvals and updating this document's approval section with the appropriate information and saved artifacts (email, pdf, etc.)
## Technical Solution Manager (TSM)
The HOIST Technical Solution Manager is responsible for providing oversight and management of technical aspects. This includes coordination of technical resources and managing development work and priorities.
## HUB Delivery Lead
The HOIST HUB Delivery Lead is responsible for the overall solution and technical direction, providing oversight and management of both application and technical aspects. This includes the review and approval of all HUB specs before development commences.