Terminología Estandarizada

Terminología estandarizada y convenciones de nomenclatura para la documentación de Rememberizer

Este documento proporciona una referencia para la terminología preferida a utilizar al discutir las características y conceptos de Rememberizer. Seguir estos estándares ayuda a mantener la consistencia en la documentación.

Términos y Definiciones Preferidos

Término Preferido	Términos Alternativos	Definición
Almacén de Vectores	Base de Datos de Vectores	El término preferido para la implementación de la base de datos de vectores de Rememberizer es "Almacén de Vectores." Aunque "Base de Datos de Vectores" es técnicamente preciso, se debe usar "Almacén de Vectores" por consistencia.
Embeddings de Vectores	Embeddings	El término completo "Embeddings de Vectores" es preferido en contenido educativo, mientras que "Embeddings" es aceptable en contextos técnicos y ejemplos de código.
Fuente de Datos	Fuente de Conocimiento, Integración	"Fuente de Datos" es el término preferido para referirse a los orígenes de los datos (Slack, Google Drive, etc.).
Conocimiento Común	Conocimiento Compartido	Use "Conocimiento Común" al referirse a la función que permite compartir conocimiento con otros usuarios y aplicaciones.
Memento	Filtro de Memento	Use "Memento" como el término principal, aunque "Filtro de Memento" es aceptable en contextos de UI.
Integración de Memoria	Memoria Compartida, Memoria	"Integración de Memoria" es el nombre completo preferido de la función; "Memoria Compartida" es aceptable en contenido dirigido al usuario.
Autenticación OAuth2	OAuth	Use el término completo "Autenticación OAuth2" en documentación formal, aunque "OAuth" es aceptable en contextos menos formales.
Busca Tu Conocimiento	Buscar en Rememberizer	"Busca Tu Conocimiento" debe usarse al referirse al nombre de la función en títulos y navegación.
Memorizar	Almacenar	Use "Memorizar" para el punto final de la API y el nombre de la funcionalidad, mientras que "Almacenar" puede usarse en contextos explicativos.
X-API-Key	x-api-key	Use "X-API-Key" en mayúsculas en la documentación, aunque la minúscula es aceptable en ejemplos de código.

Convenciones de API

Directorio de Documentación de la API

La ruta oficial de la documentación de la API es /en/developer/api-docs/. La ruta heredada /en/developer/api-documentations/ debe ser eliminada gradualmente.

Encabezados de API

Las siguientes convenciones de encabezado deben utilizarse de manera consistente:

• Encabezado de Autorización: Authorization: Bearer YOUR_JWT_TOKEN

• Encabezado de Clave de API: X-API-Key: YOUR_API_KEY

• Encabezado de Tipo de Contenido: Content-Type: application/json

Estilo de Puntos de Acceso de API

Los puntos de acceso de API deben estar estilizados de manera consistente:

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

• Rutas de puntos de acceso en minúsculas con guiones según sea necesario: /documents/search/

• Rutas de almacenamiento de vectores con marcador de posición de parámetro: /vector-stores/{vector_store_id}/documents/search

Convenciones de Nombres de Características

Nombres de Integración

Los nombres de integración deben seguir el patrón:

• Integración de Rememberizer {Nombre de Integración} (por ejemplo, "Integración de Rememberizer Slack")

Nomenclatura del Servidor MCP

Los tipos de servidores MCP deben ser claramente distinguidos:

• Servidor MCP de Rememberizer: Servidor de propósito general

• Servidor MCP de Almacenamiento de Vectores de Rememberizer: Servidor específicamente para operaciones de almacenamiento de vectores

Convenciones de Títulos de Documentos

Los títulos de los documentos deben seguir estas convenciones:

• Capitalizar palabras importantes (Título en Mayúsculas)

• Usar terminología consistente para las características

• Evitar acrónimos en los títulos a menos que sean ampliamente reconocidos (por ejemplo, API)

• Mantener los títulos concisos y descriptivos

Uso de Esta Guía

Al crear o actualizar documentación, consulte esta guía para garantizar una terminología consistente. Al encontrar términos variantes en la documentación, priorice la actualización a los términos preferidos que se enumeran aquí al realizar otros cambios en esos documentos.

Recuerde que mantener la integridad de los enlaces y los nombres de los archivos es crucial, así que concéntrese en actualizar la terminología dentro del texto mientras preserva las URL y las estructuras de archivos.