Documentable Things

GraphArch can document authored explanations and the things described by RDF. This catalogue lists the kinds that the current collection and documentation stages recognise. Recognition uses explicit source structure, RDF types, relationships, and publication hints. A target's scope and profile decide which of those things appear in a publication.

Documentable thingWhat GraphArch recognises today
Markdown pages and guidesGuides, explanations, reusable sections, and illustrated narratives
Ontologies and RDF resourcesOWL ontologies; OWL/RDFS classes, datatypes, properties, and named individuals; supplied labels, definitions, and relationships
Ontology families and modulesExplicitly registered families and members, plus declared modules and their membership
SHACL shapesNamed node and property shapes, with their retained constraints and nested RDF expressions
SKOS taxonomiesConcept schemes, concepts, collections, and ordered collections, with source hierarchy, labels, notes, and mappings
EKGF use-case treesActual EKGF Use Case instances, ownership and reuse links, related resources, and generated neighborhood diagrams
EKGF maturity modelsModels, pillars, capability areas, capabilities, and levels, with their declared hierarchy and authored companion explanations
Published specificationsPublished W3C specification structure, metadata, sections, and examples
SPARQL queriesQuery text and documentation comments, published without executing the query
Legal preamblesSupported legal-disclosure blocks, with complete wording preserved for HTML and PDF

Which collector supports each thing?

A documentable thing is what readers learn about. A collector is the source reader that brings its content into the documentation graph. One RDF file can contain several documentable kinds, and the same kind can arrive from a file, an RDF URL, a Git repository, or a SPARQL endpoint.

Documentable thingSupporting collectors
Markdown pages and guidesMarkdown File Collector, with the Image Collector for images
Ontologies, SHACL shapes, SKOS taxonomies, EKGF use cases, and maturity modelsRDF File Collector, RDF URL Collector, or SPARQL Endpoint Collector; repository scanners discover and dispatch file collectors
Ontology families and modulesRDF File Collector, RDF URL Collector, or SPARQL Endpoint Collector, retaining explicit family registry and module declarations
Published W3C specificationsPublished W3C Specification Collector
SPARQL queries as documentationSPARQL File Collector
Legal preamblesLegal Preamble Collector

The Collectors catalogue lists each source reader, its supported inputs, and the documentable things it can supply. The documentation stage recognises retained RDF types and relationships and builds the reference entries or diagrams; a generic RDF reader alone does not decide which publication to generate.

Try a practical example

Each type guide includes input you can inspect, an explanation of the result, and a link to generated output. Start with a Markdown guide, a customer vocabulary, a SHACL rule, or a use-case tree.

The same semantic content can arrive through an RDF file or URL, a repository, or an explicit SPARQL collection request. Those are ways to obtain sources; they do not define what the resources mean. See Usage for transport, configuration, CI, and publishing workflows.

Choose the reading experience

A publication's scope selects the subjects and content to include; its profile and renderer determine how readers encounter them. The same authored explanation can introduce a website and appear in a printed specification. An ontology can have its authoritative reference alongside a separate guide for newcomers. See publication targets for the available outputs.

Recognition of a resource does not imply every specialist reading experience is implemented. SKOS resources, for example, have a generated vocabulary reference; a dedicated interactive taxonomy tree or A–Z browser is a separate capability. The SKOS guide describes the current presentation.

GraphArch retains source statements rather than inventing missing explanations or fetching ontology imports implicitly. The quality report helps reviewers find missing annotations and competing source statements.

If a kind of subject is missing, see Contributing code and the delivery contract for adding specialized collection or documentation support with retained provenance.

Search documentation

Enter words to search this site.