90 lines
3.3 KiB
YAML
90 lines
3.3 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/
|
|
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_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: "['*']"
|