Terminologia Standardizzata

Terminologia standardizzata e convenzioni di denominazione per la documentazione di Rememberizer

Questo documento fornisce un riferimento per la terminologia preferita da utilizzare quando si discutono le funzionalità e i concetti di Rememberizer. Seguire questi standard aiuta a mantenere la coerenza nella documentazione.

Termini e Definizioni Preferiti

Termine Preferito	Termini Alternativi	Definizione
Vector Store	Database Vettoriale	Il termine preferito per l'implementazione del database vettoriale di Rememberizer è "Vector Store". Sebbene "Database Vettoriale" sia tecnicamente accurato, "Vector Store" dovrebbe essere utilizzato per coerenza.
Vector Embeddings	Embeddings	Il termine completo "Vector Embeddings" è preferito nei contenuti educativi, mentre "Embeddings" è accettabile in contesti tecnici e esempi di codice.
Data Source	Fonte di Dati, Integrazione	"Data Source" è il termine preferito per riferirsi alle origini dei dati (Slack, Google Drive, ecc.).
Common Knowledge	Conoscenza Condivisa	Utilizzare "Common Knowledge" quando ci si riferisce alla funzionalità che consente di condividere conoscenze con altri utenti e applicazioni.
Memento	Filtro Memento	Utilizzare "Memento" come termine principale, sebbene "Filtro Memento" sia accettabile nei contesti UI.
Memory Integration	Memoria Condivisa, Memoria	"Memory Integration" è il nome completo preferito della funzionalità; "Memoria Condivisa" è accettabile nei contenuti rivolti agli utenti.
OAuth2 Authentication	OAuth	Utilizzare il termine completo "OAuth2 Authentication" nella documentazione formale, sebbene "OAuth" sia accettabile in contesti meno formali.
Search Your Knowledge	Cerca in Rememberizer	"Search Your Knowledge" dovrebbe essere utilizzato quando ci si riferisce al nome della funzionalità nei titoli e nella navigazione.
Memorize	Memorizza	Utilizzare "Memorize" per il punto finale API e il nome della funzionalità, mentre "Memorizza" può essere utilizzato in contesti esplicativi.
X-API-Key	x-api-key	Utilizzare "X-API-Key" in maiuscolo nella documentazione, sebbene il minuscolo sia accettabile negli esempi di codice.

Convenzioni API

Directory della Documentazione API

Il percorso ufficiale della documentazione API è /en/developer/api-docs/. Il percorso legacy /en/developer/api-documentations/ dovrebbe essere dismesso.

Intestazioni API

Le seguenti convenzioni per le intestazioni devono essere utilizzate in modo coerente:

• Intestazione di autorizzazione: Authorization: Bearer YOUR_JWT_TOKEN

• Intestazione della chiave API: X-API-Key: YOUR_API_KEY

• Intestazione Content-Type: Content-Type: application/json

Stile degli Endpoint API

Gli endpoint API devono essere stilizzati in modo coerente:

• URL di base: https://api.rememberizer.ai/api/v1/

• Percorsi degli endpoint in minuscolo con trattini se necessario: /documents/search/

• Percorsi del negozio vettoriale con segnaposto per i parametri: /vector-stores/{vector_store_id}/documents/search

Convenzioni di Nomenclatura delle Funzionalità

Nomi delle integrazioni

I nomi delle integrazioni devono seguire il modello:

• Integrazione {Nome dell'integrazione} di Rememberizer (ad es., "Integrazione Slack di Rememberizer")

Nominazione del Server MCP

I tipi di server MCP devono essere chiaramente distinti:

• Server MCP Rememberizer: Server di uso generale

• Server MCP Rememberizer Vector Store: Server specificamente per operazioni di archiviazione vettoriale

Convenzioni sui Titoli dei Documenti

I titoli dei documenti devono seguire queste convenzioni:

• Capitalizzare le parole importanti (Title Case)

• Utilizzare una terminologia coerente per le funzionalità

• Evitare acronimi nei titoli a meno che non siano ampiamente riconosciuti (ad es., API)

• Mantenere i titoli concisi e descrittivi

Utilizzare Questa Guida

Quando si crea o si aggiorna la documentazione, fare riferimento a questa guida per garantire una terminologia coerente. Quando si incontrano termini varianti nella documentazione, dare priorità all'aggiornamento ai termini preferiti elencati qui quando si apportano altre modifiche a quei documenti.

Ricordare che mantenere l'integrità dei link e dei nomi dei file è fondamentale, quindi concentrarsi sull'aggiornamento della terminologia all'interno del testo preservando gli URL e le strutture dei file.