Skip to main content
Glama
Teradata

Teradata MCP Server

Official
by Teradata
DOCUMENTATION_STRATEGY.mdβ€’3.53 kB
# Documentation Strategy for Teradata MCP Server > **πŸ“ Navigation:** [Documentation Home](../README.md) | [Server Guide](../README.md#-server-guide) | [Getting started](../server_guide/GETTING_STARTED.md) | [Architecture](../server_guide/ARCHITECTURE.md) | [Installation](../server_guide/INSTALLATION.md) | [Configuration](../server_guide/CONFIGURATION.md) | [Security](../server_guide/SECURITY.md) | [Customization](../server_guide/CUSTOMIZING.md) | [Client Guide](../client_guide/CLIENT_GUIDE.md) ## 🎯 Documentation Overview The documentation follows a **progressive disclosure design** with clear user journey optimization.Users should be guided through layered complexity: Quick Start (5 minutes) β†’ Detailed Setup β†’ Advanced Configuration β†’ Development. Each document has a single responsibility and provides clear navigation to related topics, reducing cognitive load and time-to-success. ### πŸ“ Structure ``` docs/ β”œβ”€β”€ README.md # 🏠 Main documentation hub β”œβ”€β”€ VIDEO_LIBRARY.md # 🎬 Video tutorials β”œβ”€β”€ server_guide/ # πŸ›  For server operators β”‚ β”œβ”€β”€ GETTING_STARTED.md # Quick start guide β”‚ β”œβ”€β”€ CUSTOMIZING.md # Business customization β”‚ └── SECURITY.md # Authentication & RBAC β”œβ”€β”€ client_guide/ # πŸ‘₯ For end users β”‚ β”œβ”€β”€ CLIENT_GUIDE.md # Overview β”‚ β”œβ”€β”€ Claude_desktop.md # Most popular client β”‚ β”œβ”€β”€ Visual_Studio_Code.md β”‚ └── [other clients...] └── developer_guide/ # πŸ”§ For contributors β”œβ”€β”€ DEVELOPER_GUIDE.md β”œβ”€β”€ CONTRIBUTING.md └── [technical guides...] ``` ## 🎨 Documentation Strategy ### 1. **Progressive Disclosure Design** - **Layer 1**: Quick start (5-minute setup) β†’ Most users stop here - **Layer 2**: Detailed configuration β†’ Power users continue - **Layer 3**: Advanced customization β†’ Technical users explore - **Layer 4**: Development/contribution β†’ Developers engage ### 2. **User Journey** ``` New User Journey: docs/README.md β†’ server_guide/GETTING_STARTED.md β†’ client_guide/Claude_desktop.md βœ… Admin Journey: docs/README.md β†’ server_guide/SECURITY.md β†’ server_guide/CUSTOMIZING.md βœ… Developer Journey: docs/README.md β†’ developer_guide/DEVELOPER_GUIDE.md β†’ CONTRIBUTING.md βœ… ``` ### 3. **UX Principles** #### **Visual Hierarchy** - βœ… **Clear headings**: H1 for page title, H2 for sections - βœ… **Emoji navigation**: πŸ“ breadcrumbs, πŸš€ quick start sections - βœ… **Callout blocks**: `> **πŸ“ Navigation:**` for wayfinding - βœ… **Section grouping**: Related content grouped with clear headings #### **Scannable Content** - βœ… **TL;DR sections**: Quick start boxes at top of long guides - βœ… **Use case routing**: "For X users, go here" in main README - βœ… **Progressive headers**: H2 β†’ H3 β†’ H4 hierarchy maintained - βœ… **Code block consistency**: All examples properly formatted #### **Cognitive Load Reduction** - βœ… **Single responsibility**: Each doc has one clear purpose - βœ… **Cross-references**: Related links clearly marked - βœ… **Context awareness**: Breadcrumbs show where you are - βœ… **Next steps**: Each doc suggests logical next actions ## πŸ“Š Objectives ### User Experience Indicators - **Time to first success**: < 10 minutes from README to working setup - **Issues reduction**: Reduce "how do I..." questions and issues originating from misleading documentation.

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Teradata/teradata-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server