Terminologie standardisée

Terminologie normalisée et conventions de nommage pour la documentation de Rememberizer

Ce document fournit une référence pour la terminologie préférée à utiliser lors de la discussion des fonctionnalités et concepts de Rememberizer. Suivre ces normes aide à maintenir la cohérence dans la documentation.

Termes et Définitions Préférés

Terme Préféré	Termes Alternatifs	Définition
Vector Store	Base de Données Vectorielle	Le terme préféré pour l'implémentation de la base de données vectorielle de Rememberizer est "Vector Store." Bien que "Base de Données Vectorielle" soit techniquement exact, "Vector Store" doit être utilisé pour des raisons de cohérence.
Vector Embeddings	Embeddings	Le terme complet "Vector Embeddings" est préféré dans le contenu éducatif, tandis que "Embeddings" est acceptable dans des contextes techniques et des exemples de code.
Data Source	Source de Données, Intégration	"Data Source" est le terme préféré pour désigner les origines des données (Slack, Google Drive, etc.).
Common Knowledge	Connaissance Partagée	Utilisez "Common Knowledge" lorsque vous faites référence à la fonctionnalité qui permet de partager des connaissances avec d'autres utilisateurs et applications.
Memento	Filtre Memento	Utilisez "Memento" comme terme principal, bien que "Filtre Memento" soit acceptable dans les contextes d'interface utilisateur.
Memory Integration	Mémoire Partagée, Mémoire	"Memory Integration" est le nom complet préféré de la fonctionnalité ; "Mémoire Partagée" est acceptable dans le contenu destiné aux utilisateurs.
OAuth2 Authentication	OAuth	Utilisez le terme complet "OAuth2 Authentication" dans la documentation formelle, bien que "OAuth" soit acceptable dans des contextes moins formels.
Search Your Knowledge	Rechercher dans Rememberizer	"Search Your Knowledge" doit être utilisé lorsque vous faites référence au nom de la fonctionnalité dans les titres et la navigation.
Memorize	Stocker	Utilisez "Memorize" pour le point de terminaison de l'API et le nom de la fonctionnalité, tandis que "Stocker" peut être utilisé dans des contextes explicatifs.
X-API-Key	x-api-key	Utilisez "X-API-Key" en majuscules dans la documentation, bien que la version en minuscules soit acceptable dans les exemples de code.

Conventions API

Répertoire de Documentation de l'API

Le chemin officiel de la documentation de l'API est /en/developer/api-docs/. Le chemin hérité /en/developer/api-documentations/ doit être progressivement abandonné.

En-têtes API

Les conventions d'en-tête suivantes doivent être utilisées de manière cohérente :

• En-tête d'autorisation : Authorization: Bearer YOUR_JWT_TOKEN

• En-tête de clé API : X-API-Key: YOUR_API_KEY

• En-tête de type de contenu : Content-Type: application/json

Style des points de terminaison API

Les points de terminaison API doivent être stylés de manière cohérente :

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

• Chemins des points de terminaison en minuscules avec des tirets si nécessaire : /documents/search/

• Chemins de la boutique de vecteurs avec un espace réservé pour le paramètre : /vector-stores/{vector_store_id}/documents/search

Conventions de Nommage des Fonctionnalités

Noms d'intégration

Les noms d'intégration doivent suivre le modèle :

• Intégration {Nom de l'intégration} Rememberizer (par exemple, "Intégration Rememberizer Slack")

Nommage du serveur MCP

Les types de serveurs MCP doivent être clairement distingués :

• Serveur MCP Rememberizer : Serveur à usage général

• Serveur MCP de stockage de vecteurs Rememberizer : Serveur spécifiquement pour les opérations de stockage de vecteurs

Conventions de titre de document

Les titres de documents doivent suivre ces conventions :

• Mettez en majuscule les mots importants (Titre en majuscules)

• Utilisez une terminologie cohérente pour les fonctionnalités

• Évitez les acronymes dans les titres sauf s'ils sont largement reconnus (par exemple, API)

• Gardez les titres concis et descriptifs

Utiliser ce guide

Lors de la création ou de la mise à jour de la documentation, référez-vous à ce guide pour garantir une terminologie cohérente. Lorsque vous rencontrez des termes variants dans la documentation, privilégiez la mise à jour vers les termes préférés énumérés ici lors de l'apport d'autres modifications à ces documents.

N'oubliez pas que le maintien de l'intégrité des liens et des noms de fichiers est crucial, alors concentrez-vous sur la mise à jour de la terminologie dans le texte tout en préservant les URL et les structures de fichiers.