Files
2025-11-29 18:29:15 +08:00

1.8 KiB

Reference Guides

This directory contains comprehensive reference guides for ontological documentation.

Files

concept_extraction_guide.md

Methodologies and techniques for identifying and extracting domain concepts, entities, and relationships from software codebases.

Topics covered:

  • Static code analysis techniques
  • Naming convention analysis
  • Data structure analysis
  • Configuration and metadata analysis
  • Language-specific extraction patterns (Python, JavaScript/TypeScript, Java)
  • Concept categorization framework
  • Relationship identification
  • Extraction workflow
  • Quality assurance

documentation_templates.md

Standardized templates for creating comprehensive ontological documentation.

Templates included:

  • Concept Definition Template
  • Relationship Documentation Template
  • Domain Model Overview Template
  • Ontology Change Log Template
  • API Ontology Template
  • Database Schema Ontology Template
  • Event-Driven Architecture Ontology Template

ontology_patterns.md

Common ontological patterns and taxonomies found in software systems.

Patterns covered:

  • Fundamental relationship types (Is-A, Part-Of, Instance-Of, Depends-On, Associates-With)
  • Layered Architecture Pattern
  • Domain-Driven Design Pattern
  • MVC Pattern Ontology
  • Microservices Pattern Ontology
  • Taxonomy classification systems
  • Ontology validation rules

Usage

These guides are designed to be used together:

  1. Start with ontology_patterns.md to understand common patterns
  2. Use concept_extraction_guide.md to extract concepts from your codebase
  3. Apply documentation_templates.md to document your findings

Integration with Main Skill

These references support the main SKILL.md and are automatically available when the ontological documentation skill is activated.