Standardisierte Rememberizer-Terminologie¶
Dieses Dokument bietet eine Referenz für die bevorzugte Terminologie, die bei der Diskussion von Rememberizer-Funktionen und -Konzepten verwendet werden soll. Die Einhaltung dieser Standards trägt zur Konsistenz in der Dokumentation bei.
Bevorzugte Begriffe und Definitionen¶
| Bevorzugter Begriff | Alternative Begriffe | Definition |
|---|---|---|
| Vektor Speicher | Vektor Datenbank | Der bevorzugte Begriff für die Vektor-Datenbankimplementierung von Rememberizer ist "Vektor Speicher." Während "Vektor Datenbank" technisch korrekt ist, sollte "Vektor Speicher" aus Konsistenzgründen verwendet werden. |
| Vektor Einbettungen | Einbettungen | Der vollständige Begriff "Vektor Einbettungen" wird in Bildungsinhalten bevorzugt, während "Einbettungen" in technischen Kontexten und Codebeispielen akzeptabel ist. |
| Datenquelle | Wissensquelle, Integration | "Datenquelle" ist der bevorzugte Begriff, um auf die Ursprünge von Daten (Slack, Google Drive usw.) zu verweisen. |
| Gemeinsames Wissen | Geteiltes Wissen | Verwenden Sie "Gemeinsames Wissen", wenn Sie auf die Funktion verweisen, die das Teilen von Wissen mit anderen Benutzern und Anwendungen ermöglicht. |
| Memento | Memento Filter | Verwenden Sie "Memento" als den primären Begriff, obwohl "Memento Filter" in UI-Kontexten akzeptabel ist. |
| Speicherintegration | Geteilter Speicher | "Speicherintegration" ist der bevorzugte vollständige Name der Funktion; "Geteilter Speicher" ist in benutzerorientierten Inhalten akzeptabel. |
| OAuth2-Authentifizierung | OAuth | Verwenden Sie den vollständigen Begriff "OAuth2-Authentifizierung" in formellen Dokumentationen, obwohl "OAuth" in weniger formellen Kontexten akzeptabel ist. |
| Durchsuche dein Wissen | Suche in Rememberizer | "Durchsuche dein Wissen" sollte verwendet werden, wenn auf den Funktionsnamen in Titeln und Navigation verwiesen wird. |
| Einprägen | Speichern | Verwenden Sie "Einprägen" für den API-Endpunkt und den Funktionsnamen, während "Speichern" in erklärenden Kontexten verwendet werden kann. |
| X-API-Key | x-api-key | Verwenden Sie das großgeschriebene "X-API-Key" in der Dokumentation, obwohl die Kleinschreibung in Codebeispielen akzeptabel ist. |
API-Konventionen¶
API-Dokumentationsverzeichnis¶
Der offizielle API-Dokumentationspfad ist /en/developer/api-docs/. Der veraltete Pfad /en/developer/api-documentations/ sollte schrittweise eingestellt werden.
API-Header¶
Die folgenden Header-Konventionen sollten konsequent verwendet werden:
- Authorization-Header:
Authorization: Bearer YOUR_JWT_TOKEN - API-Schlüssel-Header:
X-API-Key: YOUR_API_KEY - Content-Type-Header:
Content-Type: application/json
API-Endpunkt-Stil¶
API-Endpunkte sollten konsistent gestaltet werden:
- Basis-URL:
https://api.rememberizer.ai/api/v1/ - Endpunkt-Pfade in Kleinbuchstaben mit Bindestrichen nach Bedarf:
/documents/search/ - Vektor-Speicher-Pfade mit Platzhalter für Parameter:
/vector-stores/{vector_store_id}/documents/search
Benennungsrichtlinien für Funktionen¶
Integrationsnamen¶
Integrationsnamen sollten dem Muster folgen:
- Rememberizer {Integrationsname} Integration (z. B. "Rememberizer Slack Integration")
MCP-Serverbenennung¶
MCP-Servertypen sollten klar unterschieden werden:
- Rememberizer MCP-Server: Server für allgemeine Zwecke
- Rememberizer Vector Store MCP-Server: Server speziell für Vektorstore-Operationen
Dokumenttitel-Konventionen¶
Dokumenttitel sollten diesen Konventionen folgen:
- Wichtige Wörter großschreiben (Titelcase)
- Konsistente Terminologie für Funktionen verwenden
- Abkürzungen in Titeln vermeiden, es sei denn, sie sind allgemein anerkannt (z. B. API)
- Titel kurz und beschreibend halten
Verwendung dieses Leitfadens¶
Beim Erstellen oder Aktualisieren von Dokumentationen beziehen Sie sich auf diesen Leitfaden, um eine konsistente Terminologie sicherzustellen. Wenn Sie in der Dokumentation auf abweichende Begriffe stoßen, priorisieren Sie die Aktualisierung auf die hier aufgeführten bevorzugten Begriffe, wenn Sie andere Änderungen an diesen Dokumenten vornehmen.
Denken Sie daran, dass die Aufrechterhaltung der Link-Integrität und der Dateinamen entscheidend ist. Konzentrieren Sie sich daher darauf, die Terminologie im Text zu aktualisieren, während Sie URLs und Dateistrukturen beibehalten.