Metadata Model
Summary
Metadata makes each page independently discoverable, governable, and usable by people, search, automation, and AI reasoning. Values must describe verified documentation and implementation state rather than intended functionality.
Audience
- Documentation authors and tooling maintainers
- Product, engineering, architecture, security, and operations owners
Reference Content
Core page metadata
| Field | Type | Purpose |
|---|---|---|
id | string | Permanent unique document identity |
title | string | Human-readable page title |
description | string | Search and preview summary |
sidebar_label | string | Concise navigation label |
slug | string, optional | Stable route override |
content_type | controlled string | Primary taxonomy classification |
audience | string list | Intended reader groups |
tags | string list | Broad classification facets |
keywords | string list | Search terms and synonyms |
visibility | controlled string | Access classification |
source_type | controlled string | Authored, generated, or hybrid origin |
related_docs | path list | Direct documentation links |
Domain and ownership metadata
| Field | Type | Purpose |
|---|---|---|
module | string | Primary HR Suit module |
feature | string | Primary feature or capability, when applicable |
service | string | Primary implementation service |
bounded_context | string | Domain ownership boundary |
business_domain | string | Enterprise business domain |
business_owner | string | Business outcome owner |
technical_owner | string | Implementation owner |
service_owner | string | Runtime service owner |
documentation_owner | string | Content maintenance owner |
support_owner | string | Operational support owner |
owner | string | Current required accountable documentation owner |
reviewers | string list | Required reviewer roles or teams |
Evidence and lifecycle metadata
| Field | Type | Purpose |
|---|---|---|
repository | string | Primary repository identifier |
source_of_truth | path list | Authoritative source paths or generated specifications |
implementation_status | controlled string | Verified implementation maturity |
documentation_status | controlled string | Documentation workflow state |
status | controlled string | Current portal lifecycle compatibility field |
review_cycle | controlled string | Scheduled review frequency |
last_reviewed | ISO date | Last completed evidence review |
next_review | ISO date, optional | Calculated or approved next review date |
Relationship and version metadata
| Field | Type | Purpose |
|---|---|---|
depends_on | identifier list | Required upstream nodes |
used_by | identifier list | Known downstream consumers |
related_modules | identifier list | Related module nodes |
related_services | identifier list | Related service nodes |
related_events | identifier list | Related event nodes |
related_api | identifier list | Related API nodes |
related_database | identifier list | Related persistence nodes |
related_ui | identifier list | Related UI nodes |
introduced_in | version string | First documented release/version |
deprecated_in | version string, optional | Deprecation release/version |
Controlled values
implementation_status: planned, foundation, implemented, transitional, legacy, deprecated, removed.
documentation_status: planned, draft, review, approved, published, archived.
visibility: public, customer, partner, internal, restricted. The validator temporarily accepts legacy confidential while migration is controlled.
Example
module: organization
service: employee-service
bounded_context: employee
business_domain: workforce-management
business_owner: product-owner
technical_owner: employee-team
service_owner: employee-team
documentation_owner: documentation-team
support_owner: support-team
repository: 7CoreItSolutions/SalaryManagementAPI
source_of_truth:
- microservices/src/employee-service/Domain/Organization/Organization.cs
implementation_status: implemented
documentation_status: draft
depends_on:
- platform
used_by:
- attendance
related_services:
- platform-service
related_events:
- DepartmentChanged
introduced_in: RC1
last_reviewed: 2026-07-15
next_review: 2026-10-15
Extended fields are optional during corpus migration. Newly approved module pages should populate applicable fields; empty relationship lists are preferred to speculative links.
Related Articles
See Also
Keywords
- Metadata schema
- Controlled values
- Dependency metadata
Revision Information
- Status: Draft
- Last reviewed: 2026-07-15
- Review cycle: Quarterly