Standardiseret Rememberizer Terminologi¶
Dette dokument giver en reference for den foretrukne terminologi, der skal bruges, når man diskuterer Rememberizer-funktioner og -begreber. At følge disse standarder hjælper med at opretholde konsistens på tværs af dokumentationen.
Foretrukne Termer og Definitioner¶
| Foretrukken Term | Alternative Termer | Definition |
|---|---|---|
| Vektorbutik | Vektordatabasen | Den foretrukne betegnelse for Rememberizers vektordatabasen implementering er "Vektorbutik." Selvom "Vektordatabasen" er teknisk korrekt, bør "Vektorbutik" anvendes for konsistens. |
| Vektorindlejring | Indlejring | Den fulde betegnelse "Vektorindlejring" er foretrukken i uddannelsesindhold, mens "Indlejring" er acceptabel i tekniske sammenhænge og kodeeksempler. |
| Datakilde | Videnskilde, Integration | "Datakilde" er den foretrukne betegnelse for at henvise til oprindelsen af data (Slack, Google Drive osv.). |
| Almindelig Viden | Delt Viden | Brug "Almindelig Viden" når der henvises til funktionen, der tillader deling af viden med andre brugere og applikationer. |
| Memento | Memento Filter | Brug "Memento" som den primære betegnelse, selvom "Memento Filter" er acceptabel i UI-sammenhænge. |
| Hukommelsesintegration | Delt Hukommelse, Hukommelse | "Hukommelsesintegration" er det foretrukne fulde navn på funktionen; "Delt Hukommelse" er acceptabel i brugervenligt indhold. |
| OAuth2 Godkendelse | OAuth | Brug den fulde betegnelse "OAuth2 Godkendelse" i formel dokumentation, selvom "OAuth" er acceptabel i mindre formelle sammenhænge. |
| Søg Din Viden | Søg i Rememberizer | "Søg Din Viden" bør anvendes når der henvises til funktionsnavnet i titler og navigation. |
| Memorere | Gem | Brug "Memorere" til API-endepunktet og funktionsnavnet, mens "Gem" kan anvendes i forklarende sammenhænge. |
| X-API-Key | x-api-key | Brug det store "X-API-Key" i dokumentationen, selvom små bogstaver er acceptabelt i kodeeksempler. |
API Konventioner¶
API Dokumentationsmappe¶
Den officielle API dokumentationssti er /en/developer/api-docs/. Den gamle sti /en/developer/api-documentations/ bør udfases.
API Headers¶
De følgende headerkonventioner skal anvendes konsekvent:
- Authorization Header:
Authorization: Bearer YOUR_JWT_TOKEN - API Key Header:
X-API-Key: YOUR_API_KEY - Content-Type Header:
Content-Type: application/json
API Endpoint Styling¶
API-endepunkter skal styles konsekvent:
- Basis-URL:
https://api.rememberizer.ai/api/v1/ - Endepunktstier i små bogstaver med bindestreger efter behov:
/documents/search/ - Vektorbutikstier med parameterpladsholder:
/vector-stores/{vector_store_id}/documents/search
Funktion Navngivningskonventioner¶
Integrationsnavne¶
Integrationsnavne skal følge mønsteret:
- Rememberizer {Integrationsnavn} integration (f.eks. "Rememberizer Slack integration")
MCP Server Navngivning¶
MCP servertyper skal klart adskilles:
- Rememberizer MCP Server: Generel server
- Rememberizer Vector Store MCP Server: Server specifikt til vektorbutiksoperationer
Dokumenttitel Konventioner¶
Dokumenttitler skal følge disse konventioner:
- Skriv vigtige ord med stort begyndelsesbogstav (Titel Case)
- Brug konsekvent terminologi for funktioner
- Undgå forkortelser i titler medmindre de er bredt anerkendte (f.eks. API)
- Hold titlerne korte og beskrivende
Brug af denne guide¶
Når du opretter eller opdaterer dokumentation, skal du henvise til denne guide for at sikre konsekvent terminologi. Når du støder på varierende termer i dokumentationen, skal du prioritere at opdatere til de foretrukne termer, der er angivet her, når du foretager andre ændringer i disse dokumenter.
Husk, at det er afgørende at opretholde linkintegritet og filnavne, så fokuser på at opdatere terminologi inden for teksten, mens du bevarer URL'er og filstrukturer.