Lars
1056078e6a
Update the logging mechanism for ID collisions to include more structured metadata, enhancing the clarity of logged information. This change aims to facilitate easier analysis of conflicts during the ingestion process and improve overall traceability. |
||
|---|---|---|
| .. | ||
| 01_User_Manual | ||
| 02_concepts | ||
| 03_Technical_References | ||
| 04_Operations | ||
| 05_Development | ||
| 06_Roadmap | ||
| 99_Archive | ||
| 00_General | ||
| AUDIT_LLM_PROFILE_INTEGRATION.md | ||
| AUDIT_WP25B_CODE_REVIEW.md | ||
| README.md | ||
| doc_type | audience | status | version | context |
|---|---|---|---|---|
| documentation_index | all | active | 4.5.8 | Zentraler Einstiegspunkt für die Mindnet-Dokumentation. Inkludiert WP-24c Phase 3 Agentic Edge Validation, automatische Spiegelkanten und Chunk-Aware Multigraph-System. |
Mindnet Dokumentation
Willkommen in der Dokumentation von Mindnet v4.5.8! Diese Dokumentation hilft dir dabei, das System zu verstehen, zu nutzen und weiterzuentwickeln.
🚀 Schnellstart
Neu hier? Beginne mit diesen Dokumenten:
- Vision & Strategie - Verstehe die Ziele und Prinzipien von Mindnet
- Glossar - Lerne die wichtigsten Begriffe kennen
- Dokumentationskarte - Finde schnell die richtige Dokumentation
Je nach Rolle:
- 👤 Benutzer/Autor: Starte mit Chat Usage Guide und Knowledge Design
- 👨💻 Entwickler: Beginne mit Developer Guide
- 🔧 Administrator: Siehe Admin Operations
📚 Dokumentationsstruktur
Die Dokumentation ist in logische Bereiche unterteilt:
00_General (Grundlagen)
Grundlegende Informationen für alle Zielgruppen:
- Vision & Strategie
- Glossar
- Dokumentationskarte (Navigation)
01_User_Manual (Anwendung)
Anleitungen für Endbenutzer und Autoren:
- Chat-Bedienung
- Knowledge Design (Content-Regeln)
- Authoring Guidelines
- Obsidian-Integration
02_Concepts (Fachliche Logik)
Konzeptionelle Erklärungen für Architekten:
- Graph-Logik
- KI-Persönlichkeit & Router
03_Technical_Reference (Technik & Code)
Detaillierte technische Referenzen für Entwickler:
- Datenmodell
- Ingestion-Pipeline
- Retrieval & Scoring
- Chat-Backend
- Frontend-Architektur
- Konfiguration
04_Operations (Betrieb)
Betriebsanleitungen für Administratoren:
- Admin Operations (Installation, Backup, Troubleshooting)
- Server Operations Manual (Systemd, Disaster Recovery)
05_Development (Entwicklung)
Entwickler-Ressourcen:
- Developer Guide (Workflow, Architektur, Module)
- GenAI Best Practices (Prompt-Library)
06_Roadmap (Planung)
Projektplanung und Roadmap:
- Active Roadmap (aktuelle Workpackages)
- Handover Prompts (Übergabe-Prompts für neue Entwickler)
99_Archive (Archiv)
Historische Dokumentation:
- Legacy Workpackages (abgeschlossene WPs)
🔍 Navigation nach Rolle
👨💻 Entwickler
| Frage | Dokument |
|---|---|
| Wie richte ich meine Entwicklungsumgebung ein? | Developer Guide |
| Wie ist die Architektur aufgebaut? | Architektur-Patterns |
| Wie erweitere ich das System? | Developer Guide - Teach-the-AI |
| Wie teste ich meine Änderungen? | Testing Guide |
| Welche API-Endpunkte gibt es? | API Reference |
🔧 Administratoren
| Frage | Dokument |
|---|---|
| Wie installiere ich Mindnet? | Admin Operations |
| Wie konfiguriere ich die Services? | Admin Operations - Deployment |
| Wie führe ich Backups durch? | Admin Operations - Backup |
| Was tun bei Problemen? | Admin Operations - Troubleshooting |
| Wie betreibe ich den Server? | Server Operations Manual |
👤 Anwender
| Frage | Dokument |
|---|---|
| Wie starte ich mit Mindnet? | Schnellstart |
| Wie verknüpfe ich Notizen? | Knowledge Design - Edges |
| Was sind automatische Spiegelkanten? | Knowledge Design - Spiegelkanten |
| Was ist Phase 3 Validierung? | Knowledge Design - Phase 3 |
| Was sind Note-Scope Zonen? | Note-Scope Zonen |
| Wie nutze ich den Chat? | Chat Usage Guide |
| Wie strukturiere ich meine Notizen? | Knowledge Design |
| Wie schreibe ich für den Digitalen Zwilling? | Authoring Guidelines |
| Wie integriere ich Obsidian? | Obsidian Integration |
🧪 Tester
| Frage | Dokument |
|---|---|
| Welche Test-Strategien gibt es? | Testing Guide - Strategien |
| Wie führe ich Tests aus? | Testing Guide - Frameworks |
| Wie erstelle ich Test-Daten? | Testing Guide - Test-Daten |
| Was ist die Test-Checkliste? | Testing Guide - Checkliste |
🚀 Deployment
| Frage | Dokument |
|---|---|
| Wie deploye ich automatisch? | Deployment Guide - CI/CD |
| Welche Rollout-Strategien gibt es? | Deployment Guide - Rollout |
| Wie führe ich einen Rollback durch? | Deployment Guide - Rollback |
| Was muss vor dem Deployment geprüft werden? | Deployment Guide - Checkliste |
📖 Dokumentationsprinzipien
Diese Dokumentation folgt klaren Prinzipien:
- Single Source of Truth: Informationen werden nicht dupliziert, sondern referenziert
- Konkrete Beispiele: Technische Dokumente enthalten immer Code-Snippets
- Human Readable: Benutzerhandbücher enthalten Narrative und Szenarien
- KI-Optimiert: Jede Datei hat YAML-Frontmatter für bessere RAG-Integration
🔄 Dokumentation aktualisieren
Wenn du an einem Feature arbeitest, nutze die Maintenance Matrix in der Dokumentationskarte, um zu sehen, welche Dateien aktualisiert werden müssen.
✅ Qualitätsprüfung
Die Dokumentation wurde systematisch für alle Rollen geprüft:
- Entwickler: Setup, Architektur, Code, Testing, Debugging ✅
- Administratoren: Installation, Betrieb, Wartung, Backup, DR ✅
- Anwender: Nutzung, Content-Erstellung, Workflows ✅
- Tester: Test-Strategien, Frameworks, Tools ✅
- Deployment: CI/CD, Rollout, Versionierung, Rollback ✅
Siehe Qualitäts-Checkliste für Details.
💡 Feedback
Falls du Verbesserungsvorschläge für die Dokumentation hast oder Fehler findest, melde diese bitte im Repository.
Letzte Aktualisierung: 2025-01-XX
Version: 4.5.8 (WP-24c: Phase 3 Agentic Edge Validation - Integrity Baseline)