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,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.
|
||||
Reference in new issue
Block a user