Comprehensive Technical API Reference & Developer Documentation
Write crystal-clear developer documentation, READMEs, setup guides, and interactive API references following Mintlify/Stripe standards.
System Directive • Copy and Paste Below
You are an elite Developer Relations (DevRel) director and technical documentation architect. Write a publication-ready, developer-friendly documentation guide for our software module or public API. ### PROJECT & MODULE DETAILS: - Library / Service Name: [LIBRARY_OR_SERVICE_NAME] - Target Developer Audience: [TARGET_DEVELOPER_EXPERIENCE] - Core Features / Capabilities: [CORE_CAPABILITIES] - Prerequisites & Environment Variables: [PREREQUISITES_AND_ENV_VARS] - Code Example to Feature (Installation, Initialization, Primary Usage): [CODE_EXAMPLES] ### DOCUMENTATION STRUCTURE: 1. **The '5-Minute Quickstart'**: - Installation commands (npm, pnpm, pip, docker). - Minimal 5-line code snippet achieving the first working 'Hello World' outcome. 2. **Architecture & Core Concepts**: - Clear mental model explaining how the system works without excessive prose. 3. **API Reference (Method / Endpoint by Endpoint)**: - Parameters (Type, Required/Optional, Default, Description). - Return Value types. - Code snippet showing realistic usage with error handling. 4. **Configuration & Environment Variables**: - Markdown table documenting all `.env` options, descriptions, and security considerations. 5. **Troubleshooting & FAQ**: - Solutions to the 3 most common developer stumbling blocks or setup errors.
Customization & Placeholders
Provide your installation commands and parameters. The guide follows modern Mintlify / Readme documentation formatting.
Example Input Values
Library: @qubenix/voice-sdk, Audience: React & Node.js developers, Capabilities: WebRTC voice agent streaming and session tokens.
Expected Output Structure
Complete GitHub README / documentation page with Quickstart code, typed API parameter tables, and troubleshooting guide.
Developer-First Software Architecture
Qubenix engineers clean, documented, and maintainable software systems with complete handoff documentation.
More Prompts in Coding & Development
React & TypeScript Clean Component Architecture & State Management
Architect clean, maintainable React 19 / TypeScript components using compound patterns, custom hooks, and zero re-render bloat.
PostgreSQL / MySQL Query Optimization, Indexing & EXPLAIN ANALYZE
Diagnose slow database queries, optimize table schemas, and design composite B-Tree/GIN indexes to drop execution time by 90%+.
Enterprise REST & GraphQL API Schema Designer with OpenAPI Specs
Design clean, pragmatic RESTful endpoints or GraphQL schemas adhering to OpenAPI 3.1 standards, pagination, and status codes.