- 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
51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
---
|
|
sidebar_position: 3
|
|
title: How to Document 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.
|