Initial commit

skills/ontological-documentation/templates/assets-README.md

@@ -0,0 +1,79 @@
+# 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:**
+1. Copy the template to your project
+2. Replace placeholders with your domain information
+3. Fill in the concept hierarchy
+4. Document relationships
+5. Add implementation details
+
+## Creating Your Own Ontology
+
+1. **Start with the template**: Copy `ontology-templates/domain-ontology.md`
+2. **Review the example**: Study `examples/ecommerce-ontology.md` for structure
+3. **Extract concepts**: Use `scripts/extract_concepts.py` on your codebase
+4. **Document relationships**: Apply patterns from `references/ontology_patterns.md`
+5. **Use standard templates**: Reference `references/documentation_templates.md`
+6. **Generate diagrams**: Use `scripts/generate_ontology_diagram.py`
+
+## Adding New Examples
+
+When adding new examples:
+1. Follow the structure shown in `ecommerce-ontology.md`
+2. Include concept hierarchies
+3. Document key relationships
+4. Provide business rules
+5. Add implementation examples
+6. Link to related documentation
+
+## Adding New Templates
+
+When creating new templates:
+1. Use placeholder syntax: `[Placeholder Name]`
+2. Include usage instructions
+3. Provide inline comments
+4. Keep structure clear and minimal
+5. Add to this README with description

skills/ontological-documentation/templates/domain-ontology.md

@@ -0,0 +1,35 @@
+# Domain Ontology Template
+
+## Overview
+This template provides a structured approach to documenting domain ontologies for software systems.
+
+## Domain: [Domain Name]
+
+### Core Concepts
+<!-- List the main domain concepts -->
+
+```
+[Domain Name]
+├── Primary Entities
+│   ├── Entity 1
+│   ├── Entity 2
+│   └── Entity 3
+├── Value Objects
+│   ├── Value Object 1
+│   └── Value Object 2
+├── Services
+│   ├── Service 1
+│   └── Service 2
+└── Repositories
+    ├── Repository 1
+    └── Repository 2
+```
+
+### Relationships
+<!-- Document key relationships between concepts -->
+
+## Usage Instructions
+1. Replace [Domain Name] with your actual domain
+2. Fill in the core concepts hierarchy
+3. Document the relationships
+4. Add specific concept details using the concept template