Complete Documentation
📚 Hosted Documentation: For the most up-to-date and comprehensive technical documentation, visit the hosted documentation site.
Comprehensive technical documentation for the CAC Ontology Family.
Online Documentation
Entity Reference
- Entities A-Z - Complete alphabetical reference of all ontology entities (classes, properties, individuals)
This comprehensive reference provides detailed information about every class, property, and individual defined in the CAC Ontology Family.
Repository Documentation
The CAC-Ontology GitHub repository contains extensive documentation:
Core Documentation Files
docs/architecture.md- Complete system architecture and module relationships- Module organization and dependencies
- Design patterns and best practices
- Integration with CASE and UCO
docs/design.md- Design principles and technical specifications- Ontology design decisions
- Naming conventions
- Modeling patterns
docs/user_doc.md- User documentation and examples- Getting started guide
- Common use cases
- Best practices
docs/PRD.md- Product requirements and specifications- Feature requirements
- Use case definitions
- Functional specifications
docs/glossary.md- Terminology and acronyms- Domain-specific terms
- Acronym definitions
- Cross-references
Module-Specific Documentation
Each ontology module includes inline documentation in RDF/OWL format:
- Class definitions with
rdfs:commentannotations - Property descriptions and usage guidelines
- Example usage patterns
Examples
The repository includes 30+ real-world example files:
- Located in the
examples/directory - Based on actual law enforcement cases
- Demonstrating practical applications
- See the Examples Gallery for more information
SPARQL Queries
Example SPARQL queries are available in:
example_SPARQL_queries/directory- Analytics and query examples
- Common investigation patterns
Validation Documentation
SHACL validation documentation:
- Validation shapes for all major modules
- Business rule definitions
- Validation error handling
API and Tool Integration
Python Tools
The repository includes Python tools for working with the ontology:
pip install -r requirements.txt
Docker Validation
Validation infrastructure using Docker:
docker compose -f testing/docker-compose.yaml up -d
Contributing to Documentation
To improve documentation:
- Fork the repository
- Edit documentation files in the
docs/directory - Submit a pull request
- See CONTRIBUTING.md for guidelines