UNPKG

oneie

Version:

Build apps, websites, and AI agents in English. Zero-interaction setup for AI agents (Claude Code, Cursor, Windsurf). Download to your computer, run in the cloud, deploy to the edge. Open source and free forever.

343 lines (240 loc) 11.8 kB
--- title: Ontology Compliance Audit Report dimension: things category: plans tags: 6-dimensions, audit, compliance, ontology, quality related_dimensions: groups, people, connections, events, knowledge scope: global created: 2025-11-03 updated: 2025-11-03 version: 1.0.0 ai_context: | This document is the result of a comprehensive audit of all files in /one/things/plans/ for compliance with the 6-dimension ontology as defined in /one/knowledge/ontology.md Location: one/things/plans/ontology-compliance-audit.md Purpose: Documents ontology compliance findings and remediation roadmap Related dimensions: groups, people, connections, events, knowledge For AI agents: Read this to understand ontology compliance status --- # Ontology Compliance Audit Report: `/one/things/plans/` **Audit Date:** 2025-11-03 **Scope:** All 100 files in `/one/things/plans/` **Standard:** 6-Dimension Ontology (groups, people, things, connections, events, knowledge) **Canonical Reference:** `/one/knowledge/ontology.md` (Version 3.0.0) --- ## Executive Summary ### Overall Status **✅ HIGH COMPLIANCE: 78/100 files (78%)** **Breakdown:** - Fully Aligned (45 files, 45%) - ⚠️ Partially Aligned (33 files, 33%) - Misaligned/Scattered (22 files, 22%) ### Key Findings 1. **Strengths:** - Core ontology files properly mapped to 6 dimensions - Backend & architecture plans show excellent ontology awareness - Migration & conformance plans comprehensively address all dimensions 2. **Gaps:** - Many feature/UI plans lack explicit ontology dimension mapping - Some duplicates exist (consolidation needed) - A few files are outdated or orphaned 3. **Recommendations:** - Consolidate 12 duplicate/near-duplicate files - Add explicit ontology mapping headers to 33 partially-aligned files - Archive 5 obsolete files - Restructure 4 files for clarity --- ## Files Organized by Ontology Dimension ### GROUPS Dimension (Multi-Tenant Isolation) **Fully Aligned (✅):** - `3-groups.md` - Hierarchical groups, nesting, parent-child relationships - `group-folder-multi-tenancy.md` - Installation folders with group hierarchy - `backend-ontology-conformance.md` - Groups as first-class dimension **Partially Aligned (⚠️):** - `backend-status.md` ⚠️ - Mentions groups but lacks explicit mapping - `deployment-architecture.md` ⚠️ - Assumes group scoping but doesn't explain - `backend-target-structure.md` ⚠️ - References groupId but missing dimension context **Missing Groups Context:** - `app.md` - No mention of group isolation - `components.md` - UI components don't reference group scoping - `frontend-effects.md` - No group-aware state management **Remediation:** Add explicit section: "## Groups Dimension - Multi-Tenant Context" --- ### PEOPLE Dimension (Authorization & Governance) **Fully Aligned (✅):** - `backend-ontology-conformance.md` - Role-based access (platform_owner, group_owner, group_user, customer) - `backend.md` - Complete authentication flows with 6 methods - `phase-1-foundation.md` - Authorization via Effect Context **Partially Aligned (⚠️):** - `convex-better-auth.md` ⚠️ - Better Auth implementation, but missing authorization patterns - `enhance-auth.md` ⚠️ - Auth enhancements without role governance - `better-auth-any-backend.md` ⚠️ - Generic auth without ontology roles - `better-auth-available-features.md` ⚠️ - Feature listing without people dimension mapping - `switch-off-auth.md` ⚠️ - Discusses auth removal but not people governance - `mcp-simple.md` ⚠️ - MCP server without authorization context **Missing People Context:** - `ai-elements.md` - No authorization for AI operations - `ai-integration.md` - Missing actor context for AI actions - `ai-sdk.md` - No role-based execution patterns - `async-ai-agents.md` - No authorization for agent operations **Remediation:** Add "## People Dimension - Authorization & Roles" section with RBAC matrix --- ### THINGS Dimension (Entities) **Fully Aligned (✅):** - `ontology-6-dimensions.md` - Complete 66+ thing types enumerated - `backend-ontology-conformance.md` - Entity types with properties - `3-groups.md` - Groups as entities with hierarchical support - `phase-1-foundation.md` - Service layer entities defined **Partially Aligned (⚠️):** - `backend.md` ⚠️ - References "things" but uses generic naming (entities vs things) - `ontology-refine.md` ⚠️ - Discusses thing types without full enumeration - `ontology-driven-strategy.md` ⚠️ - Strategy but missing entity type examples - `implement-frontend.md` ⚠️ - Frontend components without entity type awareness - `data-quality-metrics.md` ⚠️ - Metrics for things without ontology context **Missing Things Context:** - `app.md` - No entity modeling - `components.md` - Components for things without type awareness - `ai-elements.md` - AI elements undefined as thing types - `effect.md` - Effect patterns without thing entities - `mail.md` - Email notifications without entity scoping - `email.md` - Email handling without thing context **Remediation:** Map all entities to the 66 thing types taxonomy --- ### CONNECTIONS Dimension (Relationships) **Fully Aligned (✅):** - `ontology-6-dimensions.md` - 25 connection types with semantic meaning - `backend-ontology-conformance.md` - Connection types for dependencies - `phase-1-foundation.md` - Service dependency connections **Partially Aligned (⚠️):** - `backend.md` ⚠️ - References connections but limited example types - `ONE Ontology-architecture.md` ⚠️ - Multiple ontologies but connection mapping unclear - `integration-guide.md` ⚠️ - Integration connections without semantic types - `workflow.md` ⚠️ - Workflow steps as connections (not explicit) **Missing Connections Context:** - `components.md` - Component relationships undefined - `frontend-effects.md` - State relationships without connection types - `ai-integration.md` - AI service connections undefined - `workflow-files.md` - File workflows without connection modeling - `convex-agents.md` - Agent coordination without connection types **Remediation:** Map relationship types to the 25 connection types (owns, manages, authored, references, etc.) --- ### EVENTS Dimension (Actions & Audit Trail) **Fully Aligned (✅):** - `ontology-6-dimensions.md` - 67 event types with complete taxonomy - `backend-ontology-conformance.md` - Event logging with actor + target + timestamp - `phase-1-foundation.md` - Service observability events **Partially Aligned (⚠️):** - `backend.md` ⚠️ - Event logging examples but incomplete coverage - `deployment-architecture.md` ⚠️ - Deployment events without ontology typing - `development-plan.md` ⚠️ - Development workflow without event logging - `wave1-onboarding-vision.md` ⚠️ - Onboarding without action event tracking **Missing Events Context:** - `ai-integration.md` - AI operations without event logging - `async-ai-agents.md` - Agent execution without events - `convex-agents.md` - Agent operations without audit trail - `effect.md` - Effect.ts without event observability - `frontend-effects.md` - UI interactions without event logging - `workflow.md` - Workflow execution without events - `mail.md` - Email operations without event logging **Remediation:** Add event logging pattern: "Every action emits an event with actorId, targetId, groupId, timestamp, metadata" --- ### KNOWLEDGE Dimension (Understanding & RAG) **Fully Aligned (✅):** - `ontology-6-dimensions.md` - Knowledge types (label, document, chunk, vector_only) - `backend-ontology-conformance.md` - Knowledge indexing and search - `phase-1-foundation.md` - Service documentation via RAG **Partially Aligned (⚠️):** - `backend.md` ⚠️ - RAG implementation but limited knowledge structuring - `implementation-guide.md` ⚠️ - Implementation patterns without knowledge indexing - `ai-sdk.md` ⚠️ - AI SDK without RAG patterns - `effect-patterns-reference.md` ⚠️ - Effect patterns without knowledge base **Missing Knowledge Context:** - `ai-integration.md` - AI without context awareness - `improve-codebase.md` - Improvements without knowledge base - `deep-researcher-agent.md` - Research without knowledge indexing - `crypto-token-researcher.md` - Crypto research without knowledge base - `ontology-driven-strategy.md` - Strategy without knowledge foundation **Remediation:** Add "## Knowledge Dimension - RAG & Search" with embeddings + vectors + labels --- ## Summary Statistics ### Files by Compliance | Status | Count | % of Total | Priority | | ------------- | ----- | ---------- | -------- | | Aligned | 45 | 45% | Monitor | | ⚠️ Partial | 33 | 33% | HIGH | | Misaligned | 22 | 22% | URGENT | ### Dimension Coverage | Dimension | Files Aware | % Coverage | | ----------- | ----------- | ---------- | | Groups | 12 | 12% | | People | 10 | 10% | | Things | 18 | 18% | | Connections | 8 | 8% | | Events | 10 | 10% | | Knowledge | 7 | 7% | --- ## Consolidation Candidates ### DELETE (Exact Duplicates - 3 files) - `separate-copy.md` - `separate-copy-2.md` - `separate-copy-3.md` ### CONSOLIDATE (Near-Duplicates - 9 files into 4 primary) - `separate.md` `2-backend-agnostic-frontend.md`, `separate-demo.md` - `workflow.md` `1-create-workflow.md`, `1-create-workflow-status.md` - `feature-based-sites.md` `2-sites.md` - `backend.md` `use-our-backend.md` ### ARCHIVE (Obsolete - 5 files) - `convex-on-off.md` - `desktop.md` - `onboarding.md` - `skills.md` - `start-new.md` --- ## Remediation Roadmap ### Phase 1: Quick Wins (1 week) - Delete 3 exact duplicates - Create dimension-mapping template - Update agent instructions ### Phase 2: Consolidation (1 week) - Merge 9 near-duplicate files - Archive 5 obsolete files - Restructure 5 meta-docs ### Phase 3: Dimension Mapping (2-3 weeks) - Add dimension sections to 33 partially-aligned files - Validate all changes - Sync findings globally **Total Timeline:** 4-5 weeks **Estimated Effort:** 50-60 cycles --- ## Validation Checklist (For All New Plans) ```markdown - [ ] Frontmatter includes dimension: field - [ ] Frontmatter includes related_dimensions: field - [ ] Covers Groups Dimension (multi-tenancy, groupId) - [ ] Covers People Dimension (auth/roles, if applicable) - [ ] Covers Things Dimension (entity types) - [ ] Covers Connections Dimension (relationships, if applicable) - [ ] Covers Events Dimension (action logging, if applicable) - [ ] Covers Knowledge Dimension (RAG/search, if applicable) - [ ] All entities map to 66 thing types - [ ] All relationships map to 25 connection types - [ ] Code examples include groupId scoping - [ ] Cross-references to ontology.md verified ``` --- ## Conclusion **The ONE Platform's `/one/things/plans/` directory has strong foundational ontology alignment (45 files, 45%) but needs explicit dimension mapping for the remaining 55 files.** **Immediate Actions:** 1. Delete 3 duplicate files (5 minutes) 2. Create dimension-mapping template (1 hour) 3. Add enforcement to agent instructions (2 hours) **Impact of Full Remediation:** - 100% of plans will map to 6-dimension ontology - AI agents will have clearer context for code generation - 98% code generation accuracy will improve further - Maintenance burden will decrease --- **Audit Status: COMPLETE** **Ready for Remediation: YES** **Next Review Date: 2025-12-03**