Assets

This directory contains examples and templates for ontological documentation.

Directory Structure

assets/
├── examples/               # Real-world examples
│   └── ecommerce-ontology.md
└── ontology-templates/     # Reusable templates
    └── domain-ontology.md

Examples

ecommerce-ontology.md

A complete example demonstrating ontological documentation for an e-commerce system.

Includes:

Core concept hierarchy
Entity relationships
Business rules
Implementation examples
Documentation structure

Use this example to:

Understand how to structure domain ontologies
Learn relationship documentation patterns
See practical implementation examples
Get inspiration for your own domain models

Templates

domain-ontology.md

A ready-to-use template for documenting domain ontologies.

Features:

Pre-structured sections
Placeholder content
Usage instructions
Hierarchical concept organization

How to use:

Copy the template to your project
Replace placeholders with your domain information
Fill in the concept hierarchy
Document relationships
Add implementation details

Creating Your Own Ontology

Start with the template: Copy ontology-templates/domain-ontology.md
Review the example: Study examples/ecommerce-ontology.md for structure
Extract concepts: Use scripts/extract_concepts.py on your codebase
Document relationships: Apply patterns from references/ontology_patterns.md
Use standard templates: Reference references/documentation_templates.md
Generate diagrams: Use scripts/generate_ontology_diagram.py

Adding New Examples

When adding new examples:

Follow the structure shown in ecommerce-ontology.md
Include concept hierarchies
Document key relationships
Provide business rules
Add implementation examples
Link to related documentation

Adding New Templates

When creating new templates:

Use placeholder syntax: [Placeholder Name]
Include usage instructions
Provide inline comments
Keep structure clear and minimal
Add to this README with description

2.1 KiB Raw Blame History