LOF-P-013: Documentation

Draft for ratification

Part of the founding draft of the LOF principles.

Summary

The ontology has a public repository with documentation and an issue tracker.

Purpose

Documentation is how users outside the development team learn what an ontology is for and how to use it correctly.

Recommendations and requirements

1. The ontology has a public repository in, or linked from, the Foundry GitHub organization.
2. The README states the scope, competency questions, grounding decisions (LOF-P-004), maintainers, license, and how to cite.
3. Issues can be reported through a public tracker.

Implementation

The ontology repository template includes a README with these sections and a term-request issue form.

Examples

See the LOF ontology template.

Criteria for review

All README sections are filled in.

Automated check: Registry schema validation of repository and tracker.

Feedback and discussion

Propose changes to this principle by pull request against docs/principles/lof-p-013-documentation.md, or open a thread in Discussions.

Discussion