Help Center

Frequently Asked Questions

Everything you need to know about DocCrafter and how it can help you create professional documentation

What is DocCrafter?

DocCrafter is a modern documentation generation platform that uses AI to transform project information into professional documents. It's a Next.js-powered web application that streamlines the process of creating comprehensive project documentation. By answering guided questions about your project, the platform generates professional documentation with well-structured chapters that you can export to multiple formats.

What are the key features of DocCrafter?
  • AI-Powered Document Generation: Transform project information into professional documentation using Google Gemini AI
  • Interactive Questionnaire: Guide users through structured information gathering with AI assistance
  • Chapter-Based Organization: Automatically organize content into logical chapters with customizable outlines
  • Multiple Export Options: Export to DOCX, HTML, and Markdown formats with image support
  • Project Dashboard: Manage all your documentation projects in one place with progress tracking
  • Real-time Preview: View your documentation as you build it with live editing capabilities
  • Image Integration: Upload and manage images with automatic placeholder replacement
  • Background Processing: Intelligent background job processing with Inngest for scalable content generation
What technologies does DocCrafter use?

DocCrafter uses a modern, enterprise-grade technology stack including:

  • Frontend: Next.js 15, React 19, Tailwind CSS 4, DaisyUI
  • Backend: Next.js API Routes with RESTful architecture
  • Database: MongoDB with Mongoose ODM
  • Authentication: Clerk (secure user management)
  • AI Integration: Google Gemini 2.0 Flash model for content generation
  • Background Processing: Inngest (distributed job processing)
  • Cloud Storage: Azure Storage Blob (encrypted file storage with SAS URLs)
  • Document Generation: DOCX, HTML, and Markdown export with image bundling
  • Security: Encrypted API key storage with AES encryption
How do I get started with DocCrafter?

Getting started with DocCrafter is simple:

  1. 1
    Sign Up/Login: Create an account or log in
  2. 2
    Add API Key: Securely add your Google Gemini API key
  3. 3
    Create Project: Start a new documentation project
  4. 4
    Answer Questions: Provide information about your project with AI assistance
  5. 5
    Review Chapters: Review and edit generated chapter structure
  6. 6
    Generate Content: AI generates detailed content for each chapter
  7. 7
    Preview & Export: Review the final document and export to your preferred format
Do I need to provide my own API key?

Yes, DocCrafter requires your own Google Gemini API key to power the AI documentation generation. This ensures you have full control over your API usage and costs. Your API key is:

  • Encrypted and stored securely in our database
  • Only used for your documentation generation
  • Never shared with third parties
  • Removable at any time through your account settings
  • Under your complete control - you can update or delete it anytime
What export formats does DocCrafter support?

DocCrafter supports multiple professional export formats to meet different needs:

  • DOCX (Microsoft Word): Full formatting with embedded images, table of contents, and professional styling
  • HTML: Responsive web format with proper image references and CSS styling
  • Markdown: Clean format with organized image folders for easy sharing and version control
  • Batch Export: ZIP files with organized folder structures for projects with images

All formats support image integration and can be exported with complete folder structures for seamless sharing.

How does image management work in DocCrafter?

DocCrafter includes a comprehensive image management system:

  • Drag-and-Drop Upload: Easily upload images with instant preview
  • Smart Placeholders: AI-generated image placeholders with automatic replacement
  • Export Integration: Images are properly embedded in all export formats
  • Organized Downloads: ZIP exports include organized image folders
What real-time features does DocCrafter offer?

DocCrafter provides several real-time features for a smooth user experience:

  • Live Progress Updates: See real-time updates as your content is being generated
  • Background Processing: Scalable content generation using distributed job processing
  • Status Monitoring: Comprehensive project status tracking with detailed progress indicators
  • Multiple View Modes: Switch between preview, markdown, and HTML views in real-time
  • Live Editing: See changes instantly as you modify your content