glam/schemas/20251121/linkml/modules/classes/Documentation.yaml
kempersc d52149a5e8 Refactor schema definitions for archival entities and documentation types
- Updated descriptions and classifications for Diocesan and District Archive record types to enhance clarity and alignment with archival standards.
- Introduced structured aliases and alternative descriptions in multiple languages for key classes, improving accessibility and usability.
- Enhanced the Documentation and Documentation Centre classes with clearer definitions and broader mappings to relevant ontologies.
- Refined the DispositionService and DispositionServiceType schemas to better reflect operational contexts and service classifications.
- General cleanup of unused prefixes and redundant annotations across various schema files to streamline the overall structure.
2026-02-15 16:25:32 +01:00

75 lines
2.4 KiB
YAML

id: https://nde.nl/ontology/hc/class/Documentation
name: documentation_class
title: Documentation Class
imports:
- linkml:types
- ../slots/has_description
- ../slots/identified_by
- ../slots/has_label
- ../slots/temporal_extent
prefixes:
linkml: https://w3id.org/linkml/
hc: https://nde.nl/ontology/hc/
schema: http://schema.org/
dcterms: http://purl.org/dc/terms/
foaf: http://xmlns.com/foaf/0.1/
crm: http://www.cidoc-crm.org/cidoc-crm/
default_prefix: hc
classes:
Documentation:
class_uri: schema:TechArticle
description: >-
Technical reference resource describing platform interfaces, workflows, or operational guidance.
broad_mappings:
- schema:CreativeWork
close_mappings:
- foaf:Document
- schema:TechArticle
- crm:E73_Information_Object
related_mappings:
- dcterms:references
slots:
- has_label
- has_description
- identified_by
- temporal_extent
slot_usage:
identified_by:
range: uri
required: true
identifier: true
examples:
- value: https://data.rijksmuseum.nl/object-metadata/api/
has_label:
# range: string
examples:
- value: API Reference Documentation
- value: Developer Integration Guide
has_description:
# range: string
examples:
- value: Complete REST API reference with endpoint specifications, authentication, and response formats.
temporal_extent:
range: TimeSpan
inlined: true
required: false
examples:
- value:
begin_of_the_begin: '2015-01-01'
comments:
- Generic documentation class replacing domain-specific documentation slots
- Supports multiple documentation types (API, user, developer, system)
- URL stored in identified_by as the primary identifier
- Aligns with Schema.org TechArticle for technical documentation
see_also:
- https://schema.org/TechArticle
- http://usefulinc.com/ns/doap#
examples:
- value:
identified_by: https://data.rijksmuseum.nl/object-metadata/api/
has_label: Rijksmuseum Collection API
has_description: REST API documentation for accessing collection metadata and images
annotations:
specificity_score: 0.1
specificity_rationale: Generic utility class/slot created during migration
custodian_types: "['*']"