Comprehensive Technical Documentation Generator

Create comprehensive technical documentation for the following project:

Project Information

• Project Name: [Project name]
• Project Type: [API / Library / Framework / Application / CLI tool]
• Tech Stack: [e.g., Node.js, TypeScript, React, PostgreSQL]
• Target Audience: [Backend developers / Frontend developers / DevOps / etc.]
• Current Version: [e.g., 1.0.0]

Documentation Requirements

Generate the following documentation types:

1. README.md

Create a comprehensive README covering:

• Project overview and purpose (what problem does it solve?)
• Key features (3-5 main features)
• Quick start guide with installation steps
• Basic usage example with code
• Link to full documentation
• Contribution guidelines
• License information

2. API Reference Documentation

Document all API endpoints/public methods including:

For REST APIs:

• Endpoint URL and HTTP method
• Request parameters (path, query, body)
• Request/response examples in JSON
• Authentication requirements
• Status codes and error responses
• Rate limiting information (if applicable)

For Libraries:

• Function/class signatures with TypeScript types
• Parameter descriptions with types and defaults
• Return value types
• Code examples showing real usage
• Common patterns and best practices

3. Getting Started Guide

Create a step-by-step tutorial covering:

• System requirements and prerequisites
• Installation process (package manager, environment setup)
• Configuration (environment variables, config files)
• First "Hello World" example
• Explanation of the example code
• Next steps and links to advanced guides

4. Architecture Documentation

Explain the system design including:

• High-level architecture overview
• Main components and their responsibilities
• Data flow between components
• Database schema (if applicable)
• Technology choices and rationale
• Deployment architecture

5. How-To Guides (2-3 common tasks)

For each guide, include:

• Clear goal statement ("How to integrate OAuth authentication")
• Prerequisites needed
• Step-by-step instructions with code examples
• Expected output/verification steps
• Common troubleshooting issues and solutions

6. Configuration Reference

Document all configuration options:

• Environment variables with types and defaults
• Configuration file format and location
• All available options in a table format (Name, Type, Default, Description)
• Examples of common configurations

Documentation Structure

Organize files in this structure:

docs/
├── README.md
├── getting-started.md
├── api-reference.md
├── architecture.md
├── configuration.md
└── guides/
    ├── authentication.md
    ├── deployment.md
    └── testing.md

Writing Style Requirements

• Write in clear, concise language (avoid jargon unless necessary)
• Use present tense and active voice
• Include code examples for all concepts
• Use proper syntax highlighting in code blocks
• Make content scannable with headings, bullet points, and tables
• Include practical, real-world examples
• Add troubleshooting tips where relevant
• Keep paragraphs short (3-4 sentences max)

Code Example Requirements

• All code examples must be complete and runnable
• Use TypeScript for type safety where applicable
• Include imports and setup code
• Show expected output or results
• Highlight important lines or concepts
• Use realistic variable names and data

Generate all documentation files with professional formatting, ready to be added to a documentation site (Docusaurus, VitePress, etc.) or GitHub repository.