diff --git a/DESIGN_PRINCIPLES.md b/DESIGN_PRINCIPLES.md new file mode 100644 index 0000000..e981a7d --- /dev/null +++ b/DESIGN_PRINCIPLES.md @@ -0,0 +1,26 @@ +# 🏗️ Design Principles + +## 1. Portability First + +- **Zero environment coupling**: No hardcoded paths, no system-specific references +- **Relative paths only**: All cross-references use `../skills/`, `../knowledge/` patterns +- **"Pick up and go"**: Copy the v6/ folder to any system and it works + +## 2. Modularity + +- **Core is self-sufficient**: Works alone without dependencies +- **Skills enhance**: Add reasoning techniques as needed +- **Specialties compose**: Load multiple domains without conflicts +- **Knowledge is reference**: Shared examples available to all layers + +## 3. Versioning + +- **All files tagged**: `version: 6.0` in frontmatter +- **Compatibility tracked**: `compatibleWith: Frank.core v6+` +- **Forward compatible**: v6+ notation allows future evolution + +## 4. Multi-Specialty Support + +- **No command conflicts**: Each specialty uses domain-specific commands +- **Shared skills**: Multiple specialties can reference same CoT/ToT/RAG modules +- **Conflict resolution**: When overlaps exist, documentation explains disambiguation diff --git a/README.md b/README.md index 583ccb9..3ea3655 100644 --- a/README.md +++ b/README.md @@ -148,61 +148,6 @@ Copy the content you need directly into your LLM chat of choice. --- -## 🏗️ Design Principles - -### 1. Portability First - -- **Zero environment coupling**: No hardcoded paths, no system-specific references -- **Relative paths only**: All cross-references use `../skills/`, `../knowledge/` patterns -- **"Pick up and go"**: Copy the v6/ folder to any system and it works - -### 2. Modularity - -- **Core is self-sufficient**: Works alone without dependencies -- **Skills enhance**: Add reasoning techniques as needed -- **Specialties compose**: Load multiple domains without conflicts -- **Knowledge is reference**: Shared examples available to all layers - -### 3. Versioning - -- **All files tagged**: `version: 6.0` in frontmatter -- **Compatibility tracked**: `compatibleWith: Frank.core v6+` -- **Forward compatible**: v6+ notation allows future evolution - -### 4. Multi-Specialty Support - -- **No command conflicts**: Each specialty uses domain-specific commands -- **Shared skills**: Multiple specialties can reference same CoT/ToT/RAG modules -- **Conflict resolution**: When overlaps exist, documentation explains disambiguation - ---- - -## 📜 Version History - -### v6.0 (April 2026) -**Major refactor**: Monolithic → Modular architecture - -**Changes**: -- ✅ Created 3-layer system (Core → Skills → Specialties) -- ✅ Created 6 specialties (itil, devops, prompt-engineering, data-analysis, sccm, TEMPLATE) -- ✅ Zero environment coupling achieved -- ✅ Multi-specialty composition support -- ✅ Full documentation (ARCHITECTURE.md, README.md, LEGACY.md) - -**Migration**: v4/v5 → v6 (see Migration section above) - -### v5.0 (2024-2025) -- Single consolidated file: FrankGPT.consolidated-instructions.md -- Monolithic approach with all capabilities included -- IT operations focus with ITIL integration - -### v4.0 (2023-2024) -- Multiple agent files in agents/ folder -- Separate: Data Analyst, SCCM Tutor, custom agents -- Core instructions in instructions/ folder - ---- - ## 📄 License This is a personal AI assistant framework. Use, modify, and extend as needed for your projects.