docs: reorganize site structure using Diátaxis framework
- 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
This commit is contained in:
1 parent
2cfb6f5ef7
commit
b9a194f7c5
44 files changed
+200
-63
No files matched your search
@@ -0,0 +1,21 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: HUB Spec Standard Overview
|
||||
---
|
||||
|
||||
# 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.
|
||||
:::
|
||||
Reference in new issue
Block a user