Standardized Terminology

Standardized terminology and naming conventions for Rememberizer documentation

This document provides a reference for the preferred terminology to use when discussing Rememberizer features and concepts. Following these standards helps maintain consistency across documentation.

Preferred Terms and Definitions

Preferred Term	Alternate Terms	Definition
Vector Store	Vector Database	The preferred term for Rememberizer's vector database implementation is "Vector Store." While "Vector Database" is technically accurate, "Vector Store" should be used for consistency.
Vector Embeddings	Embeddings	The full term "Vector Embeddings" is preferred in educational content, while "Embeddings" is acceptable in technical contexts and code examples.
Data Source	Knowledge Source, Integration	"Data Source" is the preferred term for referring to the origins of data (Slack, Google Drive, etc.).
Common Knowledge	Shared Knowledge	Use "Common Knowledge" when referring to the feature that allows sharing knowledge with other users and applications.
Memento	Memento Filter	Use "Memento" as the primary term, though "Memento Filter" is acceptable in UI contexts.
Memory Integration	Shared Memory, Memory	"Memory Integration" is the preferred full name of the feature; "Shared Memory" is acceptable in user-facing content.
OAuth2 Authentication	OAuth	Use the full term "OAuth2 Authentication" in formal documentation, though "OAuth" is acceptable in less formal contexts.
Search Your Knowledge	Search in Rememberizer	"Search Your Knowledge" should be used when referring to the feature name in titles and navigation.
Memorize	Store	Use "Memorize" for the API endpoint and functionality name, while "Store" can be used in explanatory contexts.
X-API-Key	x-api-key	Use capitalized "X-API-Key" in documentation, though lowercase is acceptable in code examples.

API Conventions

API Documentation Directory

The official API documentation path is /en/developer/api-docs/. The legacy path /en/developer/api-documentations/ should be phased out.

API Headers

The following header conventions should be used consistently:

• 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 endpoints should be styled consistently:

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

• Endpoint paths in lowercase with hyphens as needed: /documents/search/

• Vector store paths with parameter placeholder: /vector-stores/{vector_store_id}/documents/search

Feature Naming Conventions

Integration Names

Integration names should follow the pattern:

• Rememberizer {Integration Name} integration (e.g., "Rememberizer Slack integration")

MCP Server Naming

MCP server types should be clearly distinguished:

• Rememberizer MCP Server: General-purpose server

• Rememberizer Vector Store MCP Server: Server specifically for vector store operations

Document Title Conventions

Document titles should follow these conventions:

• Capitalize important words (Title Case)

• Use consistent terminology for features

• Avoid acronyms in titles unless widely recognized (e.g., API)

• Keep titles concise and descriptive

Using This Guide

When creating or updating documentation, refer to this guide to ensure consistent terminology. When encountering variant terms in the documentation, prioritize updating to the preferred terms listed here when making other changes to those documents.

Remember that maintaining link integrity and file names is crucial, so focus on updating terminology within the text while preserving URLs and file structures.