Chapter overview
Reading options
NOTEBOOK 08

Standards & citation

You’re reading the fixed October 2026 · Interactive reuse and evidence edition.Current notebook ↗
FOUNDATIONS / NOTEBOOK 08

A reusable release: from practice to publication

Make your next VAO or MODAVIS graph useful to someone who was not there when you made it. Use a clear handover, scoped checks, and a release whose sources and exact artifacts can be recovered.

Key idea & worked example

Conformance means meeting a specified contract. Different checks address parsing, structure, relationships, required capabilities and file identity.

Validation and scientific assessment complement one another; each needs an explicitly stated scope.See the worked example →
A release another researcher can follow
  1. ExplainSubject · source · scopeA short account of what the package or graph means.
    bind the account to artifacts
  2. VerifyVersions · files · checksExact artifacts and reproducible technical outcomes.
    give the next person a route
  3. Hand overTerms · limits · next stepsCredit, reuse instructions and unresolved questions.
Reusability comes from these connections. A passed check or an attractive viewer alone is not a complete research handover.

1. Check the handover before making a release claim

QuestionWhat the next researcher should receive
What does this represent?An identified subject and any state, configuration or context that qualifies the account.
Which exact release did you use?The VAO standard and ontology versions, plus the object or dataset content version and immutable source references.
Which bytes did you use?Exact realization and carrier identities, byte sizes and digests, with a clear distinction between originals and derivatives.
Why is a statement present?Its attributable assertion, source fragment, method, generating activity, review status and unresolved qualifications.
What can the receiving client do?Declared capabilities, required profiles, complete groups and dependencies; a report of unavailable or unsupported operations.
How may the resources be reused?Creators, attribution, resource-specific reuse terms, source links and documented changes.
How can a result be reproduced?Input identities, commands, tool versions, check results and checks that were not run.

2. Run checks in an order that makes failures understandable

Different checks protect different parts of the account
  1. Structure & meaningParsing · schema · relationsCheck the record against its declared version and profiles.
    then verify the artifact
  2. Exact artifactsBytes · bindings · closureVerify the files, carrier mappings and required members.
    then assess the scope
  3. InterpretationSource review & capability testsAssess the claim and the operation you actually support.
Run additional runtime, linked-data or publication checks when those capabilities or profiles are claimed.

For a VAO, validate the workspace, pack to a new output, and validate the produced carrierCarrierA package or workspace that contains a manifest, carrier mapping and selected realizations. Bootstrap, preservation-closure and custom carriers serve different delivery purposes.Work through the Cuntz example →. Check release bindings with the actual release descriptor, not an unrelated example descriptor. Check dependency closureDependency closureThe complete set of prerequisites for a selected task, obtained by following every required dependency. It can be smaller than the whole preservation package.Follow a model and its dependencies → for the groups needed by your intended operation. For an RDFRDFA graph data model: statements connect a subject to an object through an identified relationship. For Cuntz, an observation can point to the pipe it describes and the evidence it uses.Follow a Cuntz observation through the graph → graph, load the pinned ontology hierarchy and shapes. The tutorial helper checks exchange data; publication and application profiles may require further records.

Cuntz · Worked example#

How can a file pass validation but support a limited conclusion?

Conformance means meeting a specified contract. Different checks address parsing, structure, relationships, required capabilities and file identity.

A useful result states its scope
  1. ContractVersion + profilesIdentify which requirements were checked.
    run the relevant checks
  2. Technical checksRecorded outcomesParsing, relationships, fixity and other claimed layers.
    interpret their limits
  3. Research judgmentEvidence & interpretationReview what the result can support.
Technical validation and scientific review answer different questions.
Work through the example 3 STEPS

Take the published observation with value 1281 millimetres. A reader wants to know both whether its record is valid and whether the measurement answers a question about the pipe.

  1. Check the structure

    A schema can check that the result has the required form and that a numerical field contains a number. Semantic checks can verify that references point to appropriate records.

  2. Check the evidence links

    Resolve the pipe, measurement activity and workbook realization; verify the cited source bytes. These operations establish what the record says and which source it identifies.

  3. Assess fitness for the question

    The workbook timestamp still is not the measurement-session date. A valid record without a documented calibration uncertainty cannot support an uncertainty claim simply because its schema passed.

BASIS FOR THIS EXAMPLE
  • Cuntz Positiv · VAO 0.5.0-rc.2 ↗

    Published manifest: identities, measurement observations, realization digests, profiles and rights. Exact examples checked against this release.

  • VAO Standard 0.5.0 ↗

    The standard contract is separate from the Cuntz dataset content version 0.5.0-rc.2.

The notebook’s JSON teaching excerpt is deliberately incomplete and is not presented as a complete, independently conforming VAO package.

The useful distinction. Validation and scientific assessment complement one another; each needs an explicitly stated scope.

3. Use a failure as a specific next action

Observed problemUseful recovery
A payload digest or byte size differsFind whether the download failed or the file was transformed. Acquire the pinned realization or document a coherent new derivative; never relabel different bytes as a match.
A manifest edit breaks its carrier pinRecompute the exact manifest-byte bindings for the new release, then check carrier and release descriptors together.
A required group is incompleteFollow the dependency graph and acquire the missing exact members. Report a partial selection honestly.
A graph collapses instrument and model identityRestore distinct IRIs and the representation relation; rerun the negative and positive examples.
A timestamp is valid but its meaning is uncertainPreserve the source qualification. Separate file history, capture time, historical scope and measurement time.
A client cannot execute a profileKeep useful lower-level inspection available and state the unsupported operation. Test a compatible client for the claimed task.

4. Write a report someone else can inspect

Technical detail · Illustrative handover note · fill with your real inputs
Illustrative handover note · fill with your real inputs
Subject and scope:
  [instrument / state / configuration / research question]
Source releases:
  VAO Standard 0.5.0; MODAVIS Ontology Network 0.1.0
  [exact object or dataset version and source identifier]
Inputs:
  [manifest / graph / realization / carrier identity and SHA-256]
Tools and commands:
  [release, environment, exact command and working directory]
Checks completed:
  [profile or layer, result, retained diagnostic report]
Checks not performed:
  [runtime / publication / acoustic / historical review, as applicable]
Reuse:
  [resource creators, terms, source links, derivative changes]
Remaining questions:
  [what the evidence does not yet establish]

The template is a human-readable handover note, not a normative VAO materialization receipt or a machine-readable validation report. Use the released schema for those artifacts. A receipt documents acquisition; a technical report documents checks; a research account explains what their combined evidenceEvidenceMaterial offered as grounds for a claim. Its relevance depends on the claim, context, transmission and interpretation.Work through the Cuntz example → can support.

Reuse keeps credit and terms attached
  1. Source releaseRead the rights recordCheck the specific resource and release.
    retain attribution
  2. DerivativeDescribe your changesKeep creator credit and the applicable terms.
    carry terms forward
  3. DistributionCredit travels with itGive downstream readers the source and license.
Cuntz’s published CC BY-SA 4.0 terms and attribution accompany its web derivatives.

5. Make the first reuse easy

Give the next person a small entry point, a concise explanation and one runnable example. Link the full preservation copy, original source, terms and validation evidence. Keep earlier released artifacts immutable when the account changes. For a repository distribution, follow the versioned repository profile and record the actual published carrier identities.

For an ontology adaptation, document your application profile and any project-owned terms or mapping graph. Keep assertions and source evidence available behind convenience displays. For a 3D notebook, provide the attributed poster and complete explanation alongside optional rendering. A reader should be able to understand the result without a GPU and distinguish a visual demonstration from a measured or playable research claim.

Cuntz · Worked example#

Which Cuntz identifier belongs in a citation?

Versioned citation separates the physical subject, the released research object and the explanation or derived artifact actually used.

Cite the artifact that supports your statement
  1. Object releaseVersion DOIIdentifies the published Cuntz package.
    name the relevant member
  2. Exact realizationDigest & identifierIdentifies the model bytes actually used.
    cite the explanatory account
  3. ExplanationNotebook editionIdentifies the teaching text you consulted.
These citations refer to different artifacts; preserve the link among them.
Work through the example 3 STEPS

A reader uses the notebook’s model to discuss a geometry, while another uses the 1281 mm workbook observation. Their references should identify different evidence even though both concern Cuntz.

  1. Identify the release

    Use version DOI 10.5281/zenodo.22151203 for the inspected dataset. Record the specific realization or observation, rather than citing only the project community.

  2. Identify what was used

    For the web preview, retain the derivative’s digest and transformation note. For the observation, identify the pipe, property, source cell and workbook realization.

  3. Cite the explanation separately

    Use “Cite this page” for the notebook’s fixed edition. Its fingerprint identifies the explanation; it does not replace the source dataset or model fingerprint.

BASIS FOR THIS EXAMPLE
  • Cuntz Positiv · VAO 0.5.0-rc.2 ↗

    Published manifest: identities, measurement observations, realization digests, profiles and rights. Exact examples checked against this release.

  • VAO Standard 0.5.0 ↗

    The standard contract is separate from the Cuntz dataset content version 0.5.0-rc.2.

The dataset content version 0.5.0-rc.2, VAO format version 0.5.0 and website edition are separate version systems.

The useful distinction. A citation chain lets a reader recover both the evidence and the interpretation.

Sources & further reading

  1. VAO Standard 0.5.0 · immutable release

    Specification, schemas, reference tools and fixtures. Use this exact standard version for the exercises.

  2. MODAVIS Ontology Network 0.1.0 · immutable release

    Terms, governed vocabularies, versioned shapes and interpretation guide.

  3. Cuntz Positiv · content release 0.5.0-rc.2

    The real observation and model used for the Cuntz examples. Its content version differs from VAO formatVersion 0.5.0.

  4. VAO 0.5.0 conformance specification
  5. MODAVIS 0.1.0 interpretation guide
Page editions 2026-10-workbench ↓

Read a fixed snapshot of this chapter, or return to the current notebook.

Edition 2026-10-workbench · SHA-256 b249a664c082Page metadata ↗