f9f3cc8e74
Schema Improvements: - Fix YAML import indentation across 800+ class files (sed: '^- ../' → ' - ../') - Add descriptions to 26 inline slots missing them (lint warnings) - Fix malformed imports in BirthPlace.yaml and CustodianObservation.yaml Validation Results: - linkml-lint: 4 warnings (intentional SCREAMING_CASE tier names) - gen-owl: SUCCESS (164,069 lines generated) - gen-json-schema: SUCCESS (9.4MB generated) Files affected: 1,034 files, +23,908 -15,200 lines
118 lines
4.3 KiB
YAML
118 lines
4.3 KiB
YAML
id: https://nde.nl/ontology/hc/class/Documentation
|
|
name: documentation_class
|
|
title: Documentation Class
|
|
imports:
|
|
- linkml:types
|
|
- ../slots/has_or_had_label
|
|
- ../slots/has_or_had_description
|
|
- ../slots/has_or_had_identifier
|
|
- ../slots/temporal_extent # was: valid_from + valid_to - migrated per Rule 53
|
|
- ./TimeSpan
|
|
- ../slots/has_or_had_description
|
|
- ../slots/has_or_had_identifier
|
|
- ../slots/has_or_had_label
|
|
- ../slots/temporal_extent
|
|
- ../slots/has_or_had_description
|
|
- ../slots/has_or_had_identifier
|
|
- ../slots/has_or_had_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/
|
|
doap: http://usefulinc.com/ns/doap#
|
|
default_prefix: hc
|
|
classes:
|
|
Documentation:
|
|
class_uri: schema:TechArticle
|
|
description: >-
|
|
Documentation resource for a service, API, platform, or system.
|
|
|
|
**DEFINITION**:
|
|
|
|
Documentation represents technical documentation resources such as
|
|
API documentation, user guides, developer references, or system manuals.
|
|
This replaces domain-specific slots like `api_documentation` with a
|
|
structured class that can capture multiple documentation resources
|
|
with different types and purposes.
|
|
|
|
**ONTOLOGY ALIGNMENT**:
|
|
|
|
- Schema.org: `schema:TechArticle` - technical documentation
|
|
- DOAP: `doap:homepage`, `doap:wiki` - project documentation
|
|
- FOAF: `foaf:Document` - generic document
|
|
- DCTERMS: `dcterms:references` - documentation references
|
|
|
|
**DOCUMENTATION TYPES**:
|
|
|
|
- API Reference: Endpoint specifications, parameters, responses
|
|
- User Guide: End-user instructions and tutorials
|
|
- Developer Guide: Integration and development instructions
|
|
- System Manual: Technical specifications and architecture
|
|
|
|
**USE CASES**:
|
|
|
|
1. **API Documentation**: Link to REST API reference docs
|
|
2. **Integration Guides**: How to integrate with the platform
|
|
3. **User Manuals**: End-user documentation for staff
|
|
|
|
exact_mappings:
|
|
- schema:TechArticle
|
|
close_mappings:
|
|
- foaf:Document
|
|
- doap:homepage
|
|
related_mappings:
|
|
- dcterms:references
|
|
- doap:wiki
|
|
slots:
|
|
- has_or_had_label
|
|
- has_or_had_description
|
|
- has_or_had_identifier
|
|
- temporal_extent # was: valid_from + valid_to - migrated per Rule 53
|
|
slot_usage:
|
|
has_or_had_identifier:
|
|
range: uri
|
|
required: true
|
|
identifier: true
|
|
examples:
|
|
- value: "https://data.rijksmuseum.nl/object-metadata/api/"
|
|
description: Rijksmuseum API documentation URL
|
|
has_or_had_label:
|
|
range: string
|
|
examples:
|
|
- value: "API Reference Documentation"
|
|
description: Label for API docs
|
|
- value: "Developer Integration Guide"
|
|
description: Label for integration guide
|
|
has_or_had_description:
|
|
range: string
|
|
examples:
|
|
- value: "Complete REST API reference with endpoint specifications, authentication, and response formats."
|
|
description: Description of API documentation content
|
|
temporal_extent: # was: valid_from + valid_to - migrated per Rule 53
|
|
description: |
|
|
Documentation validity period using CIDOC-CRM TimeSpan.
|
|
MIGRATED from valid_from + valid_to per slot_fixes.yaml (Rule 53).
|
|
range: TimeSpan
|
|
inlined: true
|
|
required: false
|
|
examples:
|
|
- value:
|
|
begin_of_the_begin: "2015-01-01"
|
|
description: Documentation available since 2015
|
|
comments:
|
|
- Generic documentation class replacing domain-specific documentation slots
|
|
- Supports multiple documentation types (API, user, developer, system)
|
|
- URL stored in has_or_had_identifier 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:
|
|
has_or_had_identifier: "https://data.rijksmuseum.nl/object-metadata/api/"
|
|
has_or_had_label: "Rijksmuseum Collection API"
|
|
has_or_had_description: "REST API documentation for accessing collection metadata and images"
|
|
description: Rijksmuseum API documentation
|