How to use this Template

TDIS templates provide a consistent, governed structure for documenting TrinityIDC metadata, database objects, workflows, and ontology‑aligned concepts. This guide explains how to use the templates effectively within GitBook.

---

1. Creating a New Page Using a Template

When creating a new documentation page:

1. Click “New Page” in GitBook.

2. Select “Choose a template”.

3. Pick the appropriate TDIS template:

   • TDIS Data Dictionary Template — Table (Stage A)

   • TDIS Data Dictionary Template — View (Stage A)

GitBook will create a new page pre‑populated with the template structure.

---

2. Filling Out the Template

Each template includes placeholder fields such as:

• {{OBJECT_NAME}}

• {{SCHEMA}}

• {{VERSION}}

• {{COLUMN_NAME}}

• {{DESCRIPTION}}

Replace each placeholder with the appropriate values from:

• SQL DDL scripts

• SOCS metadata

• iGNOSIS metadata (when applicable in future stages)

• TDIS Master Data Dictionary Prompt output

Do not remove section headings unless the template explicitly marks them as optional.

---

3. When to Use Each Template

Table Template

Use this template when documenting:

• Physical tables defined in SQL DDL

• SOCS‑generated tables

• iGNOSIS‑managed physical objects (future Stage B/C)

View Template

Use this template when documenting:

• SQL views

• Derived objects

• SOCS‑generated views

• iGNOSIS‑managed derived objects (future Stage B/C)

---

4. Template Governance

TDIS templates are governed artifacts. When modifying a template:

• Ensure changes align with the TDIS Master Prompts

• Maintain structural consistency

• Avoid removing required sections

• Version changes when appropriate

• Update the Template Library README to reflect new versions

---

5. Future Evolution (Stage A → B → C)

As TrinityIDC transitions through the metadata authority stages:

• Stage A: SQL DDL is primary

• Stage B: SQL DDL + iGNOSIS metadata are co‑primary

• Stage C: iGNOSIS becomes the primary metadata authority

Templates will evolve accordingly. Always use the template version that matches the current TDIS stage.

---

6. Best Practices

• Keep descriptions concise but complete

• Use consistent terminology (USL, ontology terms, glossary terms)

• Ensure column definitions match SQL DDL exactly

• Document constraints and relationships explicitly

• Include history entries for traceability

• Use Notes for clarifications or business rules

---

These templates ensure that every TDIS artifact is consistent, governed, and ready for future automation through SOCS, dbINSTALLER, and iGNOSIS metadata integration.