Docxa 📄

Docxa is an AI-powered documentation intelligence system that helps teams maintain up-to-date business and technical documentation effortlessly. It bridges the gap between stakeholder intent and technical reality by synthesizing knowledge from interviews and source code analysis.

⚡ The Vision

To make software documentation a living, breathing artifact that evolves with your codebase, requiring zero manual formatting while maintaining 100% accuracy.

🚀 Delivery Channels

Choose your preferred way to interact with Docxa:

| Channel | Best For | Status | | :--- | :--- | :--- | | Claude Code Skill | Interactive & Guided AI | ✅ Available | | CLI (npx/npm) | CI/CD & Developers | ✅ Available | | VS Code Extension | In-IDE Documentation | 🛠️ Coming Soon | | Teams Copilot | Stakeholder Interviews | 🛠️ Coming Soon |

⚙️ Configuration & Requirements

Docxa features a lazy-initialized AI runtime, meaning you can run many workspace commands completely locally without an API key.

Local Commands (No API Key Required)

• docxa init - Initializes the local .docxa/ workspace state.
• docxa list-documents - Lists documents.
• docxa generate --plan <doc> - Checks template and evidence readiness locally.
• docxa validate - Validates document consistency locally.

AI-Powered Commands (Requires Configuration)

Commands that analyze code or generate documentation require LLM access:

• docxa discover
• docxa generate <doc>

Environment Variables: You must set a provider and an API key:

• DOCXA_PROVIDER="openai" | "anthropic" | "google-gemini" | "ollama"
• OPENAI_API_KEY, ANTHROPIC_API_KEY, or GEMINI_API_KEY. (Alternatively, use a generic DOCXA_API_KEY).
• (Optional) DOCXA_MODEL

Environment File Priority: Docxa resolves variables in the following order:

1. Exact file explicitly passed via --env-file path/to/file
2. .env.local in the working directory
3. .env in the working directory

📂 Workspace Structure

Docxa relies on specific directories to manage its lifecycle:

• State & Evidence: The .docxa/ directory holds all auto-generated planning metadata, analyses, and generated documents.
• Templates: To use custom templates, place them in the following canonical directories at the root of your project:
  • templates/documents/ — Override default document templates (e.g. PRD.json).
  • templates/interviews/ — Define custom interview strategies.

🏗️ Core Architecture

Docxa is built for enterprise-grade automation. Our architecture is decoupled into specialized engines to support complex, multi-source evidence gathering.

Technical Architecture Deep Dive

• Architecture Proposal: Our core design principles (Evidence-Driven, Role-Aware, Local-First).
• High Level Design (HLD): Detailed C4 diagrams and system flows for the generation pipeline.
• Business Value Analysis: ROI and productivity impact research.

📖 Quick Links

• Full Documentation
• Getting Started Guide
• Evidence-Based Planning Concepts
• Contributing Guidelines

Built by The Logic Atelier