⚡ doced: Enterprise Autonomous Documentation

Turn complex codebases into board-ready documentation using K2 Think v2 Reasoning.

doced is a state-of-the-art documentation engine that uses a "think-first" multi-AI approach to map architecture, interview developers, and generate high-fidelity technical artifacts.

🚀 The Enterprise Studio

The new doced Studio (v3.1.2) provides a guided, 5-stage linear workflow for a premium documentation experience:

1. ⚡ Splash Setup: Animated initialization and secure API authentication.
2. 🎯 Mission Configuration: Persona-based intent selection (Executive, Architect, Compliance).
3. 🧠 Neural Trace: Watch K2 Think's live reasoning chain as it scans your codebase.
4. 💬 Expert Interview: Interactive Q&A where the AI clarifies architectural ambiguities.
5. 📄 Mission Debrief: Instant generation of Markdown bundles and CEO-level PDF reports.

1. Recommended: Global Install (Stable)

The best way to install doced as a system tool is via pipx. This automatically handles your PATH and isolates dependencies.

# 1. Install pipx (if you don't have it)
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# 2. Install doced globally
pipx install doced

# 3. Reload your terminal, then run:
doced --help

2. Standard Install (Automated Shell Setup)

If you prefer using standard pip, use our built-in configuration tool to fix your PATH automatically:

# 1. Install
pip install doced

# 2. Run the automatic shell config
python3 -m doced setup-path

# 3. Reload your terminal and enjoy!
doced studio

🕹️ Quick Start

Step 1: Initialize

Setup your API keys and branding preferences.

doced init

Step 2: Open doced Studio

Experience the full autonomous wizard in your browser.

doced studio

Step 3: CLI Mode (Optional)

Generate docs directly from your terminal.

doced create

🧠 Supported Intelligence

• K2 Think v2 (Primary): Handle complex reasoning, architectural mapping, and interview generation.
• Gemini 2.0 Flash (Fallback): High-speed analysis and fallback indexing.

📑 Artifacts Generated

• README.md: High-level project summary.
• ARCHITECTURE.md: Deep dive into patterns and data flows.
• TUTORIAL.md: Step-by-step developer onboarding.
• CEO-Level PDFs: Premium, board-room ready reports with compliance gauges.

🛡️ License

MIT License. Created by Qamar Muneer Akbar.