docs: migrate HOIST HUB Documentation Standard to Docusaurus
This commit is contained in:
1 parent
ce58a0c6e0
commit
8b30e9405b
19 files changed
+966
No files matched your search
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Delivery & Governance",
|
||||
"position": 5
|
||||
}
|
||||
@@ -0,0 +1,71 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Approvals & Deliverables
|
||||
---
|
||||
|
||||
# Approvals & Deliverables
|
||||
|
||||
## Approvals
|
||||
|
||||
This section is mandatory and must be completed in accordance with the established process for every specification, as it captures the initial approval. The Hoist Business Analyst is responsible for obtaining this sign-off. Any approvals for subsequent changes will be recorded in the Change Log section.
|
||||
|
||||
### Functional Design Definition Approved
|
||||
|
||||
| Approver | Date Approved | Artifact | Change No. |
|
||||
|----------|--------------|----------|------------|
|
||||
| | | | |
|
||||
|
||||
### Technical Design & Estimate Approved
|
||||
|
||||
The TSM is responsible for getting this sign-off.
|
||||
|
||||
| Approver | Date Approved | Artifact | Change No. |
|
||||
|----------|--------------|----------|------------|
|
||||
| | | | |
|
||||
|
||||
---
|
||||
|
||||
## Deliverables
|
||||
|
||||
This section, owned by the developer, documents the final deliverables of the task. It must specify:
|
||||
|
||||
- The components included in the delivery
|
||||
- The delivery format (e.g., Delivery Build, Application Configuration Package (ACP), or Manual Deployment with instructions)
|
||||
- For ACP deliveries: the name of the ACP
|
||||
- For deliveries uploaded to DevOps (IFS Cloud): the specific folder within the Build Home structure where the files are located
|
||||
|
||||
---
|
||||
|
||||
## Delimitations & Dependencies
|
||||
|
||||
The configurations in this specification have been configured as documented. Requests for changes in the configuration necessary to fulfil (or prepare for future fulfilment of) any requirements not explicitly described in the business requirements specification will be considered outside the scope of this configuration.
|
||||
|
||||
The following are excluded from this specification:
|
||||
|
||||
- Translations other than stated under the translations chapter
|
||||
- Changes or extensions on Online Help (F1 Help), e-learning material, or process models
|
||||
|
||||
Document what is **NOT** covered by this specification, including functionality that will not be implemented. If you refer to external documents, make sure to include them either in the Appendices or in the Foundation for Functional Specification section.
|
||||
|
||||
---
|
||||
|
||||
## Go-Live Information / Upgrade Issues
|
||||
|
||||
Enter vital go-live information if appropriate, e.g.:
|
||||
|
||||
- Basic data setup
|
||||
- Scheduled tasks
|
||||
- Permission Sets
|
||||
- Whether upgrade scripts are required or manual data updates in IFS Applications are needed when the configuration is installed
|
||||
|
||||
*Delete this section if not applicable.*
|
||||
|
||||
---
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
This section is owned by the developer. Provide guidance on data volumes for the main tables. Does not need to be precise but should give an order of magnitude.
|
||||
|
||||
**Example:** The volume of data within the new functions is unlikely to be high. Typically, there could be several hundred X records and up to 10,000 Y entries each. There are no expected issues with high volume processing or large tables to be considered in the design and coding.
|
||||
|
||||
*Delete this section if not applicable.*
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Change Log
|
||||
---
|
||||
|
||||
# Change Log
|
||||
|
||||
:::danger
|
||||
Very Important
|
||||
This section is **exclusively** for recording all subsequent changes to the delivered HUB feature, encompassing change requests, requirement misunderstandings, and bug fixes.
|
||||
:::
|
||||
|
||||
Each change — whether a change request, requirement misunderstanding, or bug fix — must be documented as a new entry with the same level of detail as the original Sub-Function section of the specification. The **original Sub-Function section must remain unchanged** to ensure the initial requirements remain visible.
|
||||
|
||||
Every entry should provide:
|
||||
|
||||
- A concise, high-level explanation of the reason for the modification
|
||||
- The affected design sections, using clear tags or markers to highlight changes in lengthy specifications
|
||||
- An explicit indication of whether the entry addresses a **bug fix**, a **requirement misunderstanding**, or a **customer-requested change**
|
||||
|
||||
---
|
||||
|
||||
## Document Revision History
|
||||
|
||||
| Revision | Date | Author | Remarks |
|
||||
|----------|------|--------|---------|
|
||||
| 1 | 2026-03-17 | Najib El-Husseini | Initial Draft |
|
||||
|
||||
---
|
||||
|
||||
## Detailed Description — Change #1
|
||||
|
||||
Take the required sections from the Business Requirements Definition, Functional Design Definition, and Technical Design Definition to properly document the full change to this HUB feature. Include new test plans for the updated functionality.
|
||||
|
||||
---
|
||||
|
||||
## Detailed Description — Change #n
|
||||
|
||||
Take the required sections from the Business Requirements Definition, Functional Design Definition, and Technical Design Definition to properly document the full change to this HUB feature. Include new test plans for the updated functionality.
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Estimates
|
||||
---
|
||||
|
||||
# Estimates
|
||||
|
||||
The PM is responsible for the number of hours estimated for this HUB feature. The technical and functional resources will tell the PM their individual estimates and the PM will enter that combined number here.
|
||||
|
||||
This estimate includes:
|
||||
|
||||
- The time required to detail the requirements and functional design in this document
|
||||
- The time required to hand over and discuss the requirements to the developer
|
||||
- The time required to detail the technical design in this document
|
||||
- The time required by the HOIST developer to develop the solution and delivery artifacts
|
||||
- The time required by the HOIST developer to perform technical testing
|
||||
- The time required by the HOIST business analyst to perform functional testing
|
||||
- The time required by the HOIST business analyst to perform testing with the client
|
||||
|
||||
---
|
||||
|
||||
## T-Shirt Estimate
|
||||
|
||||
This section is used to specify a rough estimate for the development of the features specified in this HUB Spec. This estimate is given before any detailed business requirements have been captured and will be based on the QTY per type of HUB feature (New Module, Page, Field, Feature), but will not reflect details regarding how difficult or simple the implementation will be.
|
||||
|
||||
| Size | HUB Type (Example) | Hours |
|
||||
|------|--------------------|-------|
|
||||
| XS | Extra Small | 4 |
|
||||
| S | Small | 8 |
|
||||
| M | Medium | 16 |
|
||||
| L | Large | 40 |
|
||||
| XL | Extra Large | 80 |
|
||||
| EPIC | EPIC | 100+ |
|
||||
|
||||
### HUB T-Shirt Estimates
|
||||
|
||||
| HUB # | Description | Size | Total Hours |
|
||||
|-------|-------------|------|-------------|
|
||||
| 1 | Sales Quotation | Epic | 24 |
|
||||
|
||||
---
|
||||
|
||||
## Detailed Estimate
|
||||
|
||||
| HUB Obj # | Description | Estimator(s) | Estimate Type | Estimated Hours |
|
||||
|-----------|-------------|-------------|---------------|-----------------|
|
||||
| | Detail Requirements | | Func. | |
|
||||
| | Func. / Tech. Collab. | | Func. / Tech. | |
|
||||
| | Detail Requirements | | Tech. | |
|
||||
| | Development | | Tech. | |
|
||||
| | Testing | | Tech. | |
|
||||
| | Testing | | Func. | |
|
||||
| | Delivery | | Tech. | |
|
||||
| | Testing | | Func. | |
|
||||
| | Client Testing | | Func. | |
|
||||
| **TOTAL:** | | | | |
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Test Plan
|
||||
---
|
||||
|
||||
# Test Plan
|
||||
|
||||
## Technical & Unit Testing
|
||||
|
||||
Developers are required to thoroughly test HUB functionality by evaluating parameters such as null values, edge cases, and all potentially valid inputs against the technical specifications and requirements. Testing must confirm that no error messages are generated. Additionally, developers should perform regression testing between version changes to ensure that all existing HUB functionality remains correct and unaffected.
|
||||
|
||||
| Business Req # | HUB Obj # | Step # | Step Description | Test Data Input | Expected Result | Actual Result | Tester | Date Tested | Environment Tested |
|
||||
|----------------|-----------|--------|-----------------|-----------------|-----------------|---------------|--------|-------------|-------------------|
|
||||
| | | | | | | | | | |
|
||||
|
||||
---
|
||||
|
||||
## Business Test Plan
|
||||
|
||||
This section details the testing procedures to verify that the HUB spec fulfills the business requirements outlined in the specification. Test plans must directly align with these requirements to confirm their successful implementation.
|
||||
|
||||
Testing instructions should be:
|
||||
|
||||
- Clear and step-by-step
|
||||
- Accessible to individuals unfamiliar with the solution
|
||||
- Include specific basic data (sample inputs or datasets) for reliable and repeatable outcomes
|
||||
|
||||
Collaboration between the HOIST Business Analyst and the customer is essential to develop accurate and mutually agreed-upon test plans.
|
||||
|
||||
| Business Req # | Test # | Step # | Step Description | Test Data Input | Expected Result | Actual Result | Tester | Date Tested | Environment Tested |
|
||||
|----------------|--------|--------|-----------------|-----------------|-----------------|---------------|--------|-------------|-------------------|
|
||||
| | | | | | | | | | |
|
||||
|
||||
---
|
||||
|
||||
## Client / User Testing
|
||||
|
||||
This section is designed for use by the customer during the customer testing phase. The table in this section must align with the table in the Functional Results section above.
|
||||
|
||||
Successful testing of the HUB feature confirms that it has been developed and delivered as specified. Any changes or additional requirements should be documented in the Change Log section.
|
||||
|
||||
| Business Req # | Test # | Step # | Step Description | Test Data Input | Expected Result | Actual Result | Tester | Date Tested | Environment Tested |
|
||||
|----------------|--------|--------|-----------------|-----------------|-----------------|---------------|--------|-------------|-------------------|
|
||||
| | | | | | | | | | |
|
||||
Reference in new issue
Block a user