Automate software documentation using AI (Gemini & K2 Think).
Project description
⚡ 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:
- ⚡ Splash Setup: Animated initialization and secure API authentication.
- 🎯 Mission Configuration: Persona-based intent selection (Executive, Architect, Compliance).
- 🧠 Neural Trace: Watch K2 Think's live reasoning chain as it scans your codebase.
- 💬 Expert Interview: Interactive Q&A where the AI clarifies architectural ambiguities.
- 📄 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file doced-3.1.3.tar.gz.
File metadata
- Download URL: doced-3.1.3.tar.gz
- Upload date:
- Size: 24.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1b73f3afe985fb4aa552495798f566caa18d26fa26b80f7a7bc60e6da5e46e87
|
|
| MD5 |
078e76699eb582fb7fd62d8cd2b4968c
|
|
| BLAKE2b-256 |
2ea70c3bf42dc04ef9f925f1553a08bb5542acfe3d9cf52018fc03e3a857cbb0
|
File details
Details for the file doced-3.1.3-py3-none-any.whl.
File metadata
- Download URL: doced-3.1.3-py3-none-any.whl
- Upload date:
- Size: 25.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
54d50c1b4217d73c6b743b91d639c5e131da1c3092a8f27b150d3c84e7a06fdf
|
|
| MD5 |
49fbbb26998a4cd89ec7063390048f6f
|
|
| BLAKE2b-256 |
2da246696d96471bb31d110f4de14f4295a2e907407528f39367968aeacc00ca
|