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,50 @@
---
sidebar_position: 3
title: Custom Fields
---
# Custom Fields Documentation Standard
Custom fields must be explicitly documented, especially when they are integrated with or sourced from external systems (e.g., IFS).
## Definition and Scope
Each custom field must be clearly identified as custom (i.e., non-core or non-standard). The documentation must specify:
- The external system it is connected to (if applicable)
- Whether the field is optional, conditional, or mandatory
Custom fields may not be applicable across the entire application and may vary by:
- Portal owner
- Tenant
- Deployment context
## Applicability and Visibility
Documentation must clearly state:
- Which portal owners or user groups can see or use the field
- Any conditions that control visibility or availability
If a custom field is only relevant in specific modules, flows, or screens, this must be explicitly stated.
## Behavior and Constraints
The business purpose of each custom field must be documented. Any constraints or special behavior should be described, including:
- Validation rules
- Read-only or system-managed values
- Dependency on external system data availability
## External System Dependency
For fields connected to external systems:
- Clearly define the source of truth
- Describe synchronization behavior (real-time vs. asynchronous)
- Document fallback or error behavior if the external system is unavailable
## Impact on UI and Integration
The presence or absence of custom fields must not negatively impact standard application behavior. Any UI or integration logic that depends on custom fields must be clearly documented to avoid assumptions in shared or multi-tenant environments.