# DocuWriter.ai

> DocuWriter is an AI-powered platform for creating and managing complete, structured documentation for entire codebases. Teams can connect repositories and generate documentation covering architecture, modules, services, classes, functions, dependencies, APIs, diagrams, READMEs, and other technical components. It supports both individual repositories and larger multi-repository systems.

DocuWriter turns connected repositories into one centralized documentation system rather than a collection of isolated outputs. Complete documentation is generated in context, organized in collaborative Knowledge Spaces, searchable through semantic search and the Platform AI Agent, and kept aligned with the code through Repository Sync and Documentation on Autopilot. Teams can access the same system through the web platform, REST API, or MCP integrations for Claude Code, Cursor, ChatGPT, and VSCode. Your code is processed in-memory only and never stored or used for AI training.

## Getting Started

- [Platform Getting Started](https://docs.docuwriter.ai/docuwriterai-platform-docs/106552): How to sign up, navigate the dashboard, and generate your first documentation
- [Credits & Usage](https://docs.docuwriter.ai/docuwriterai-platform-docs/284913): How credits work, usage tracking, plan limits, and generator access checks
- [Generations Page Guide](https://docs.docuwriter.ai/docuwriterai-platform-docs/106555): Managing your generated documentation outputs
- [Documentation on Autopilot](https://docs.docuwriter.ai/docuwriterai-platform-docs/277526): Set up automatic documentation generation from your repositories, including public webhook notification endpoints
- [Teams](https://docs.docuwriter.ai/docuwriterai-platform-docs/106553): Team management, roles (admin, editor, viewer), and collaboration

## Full Codebase Documentation

Full-codebase documentation is the primary product workflow. DocuWriter analyzes a repository, proposes a structured documentation tree, and creates a connected, multi-page Space covering the system as a whole. Focused generators remain available as supporting capabilities when a team needs a specific artifact; they are not separate products.

- [Code Documentation Generator](https://docs.docuwriter.ai/docuwriterai-platform-docs/106527): Generate technical docs from source code with function/class explanations and usage examples
- [Swagger API Documentation Generator](https://docs.docuwriter.ai/docuwriterai-platform-docs/106529): Generate OpenAPI 3.1 compliant API docs from REST controllers
- [UML Diagram Generator](https://docs.docuwriter.ai/docuwriterai-platform-docs/106528): Create class diagrams, sequence diagrams in PlantUML format (SVG/PNG export)
- [Tree Documentation Generator](https://docs.docuwriter.ai/docuwriterai-platform-docs/106518): Preview, review, accept, and generate a multi-page, book-style Space covering your entire repository (architecture, installation, API, usage)
- [Codebase Documentation Generator](https://docs.docuwriter.ai/docuwriterai-platform-docs/106521): Generate exhaustive file-level documentation for every source file in one sweep
- [Custom Prompts Generator](https://docs.docuwriter.ai/docuwriterai-platform-docs/106519): Use custom instructions to generate documentation tailored to your needs

## Knowledge Spaces

- [Spaces Overview](https://docs.docuwriter.ai/docuwriterai-platform-docs/106554): Organize documentation in collaborative spaces with hierarchical structure
- [Repository Sync](https://docs.docuwriter.ai/docuwriterai-platform-docs/222049): Automatic detection of code changes with reviewable documentation update suggestions
- [Update Documentation Gaps](https://docs.docuwriter.ai/docuwriterai-platform-docs/386174): AI finds what's missing in your docs and fills the gaps automatically
- [Export to Confluence](https://docs.docuwriter.ai/docuwriterai-platform-docs/230701): One-click export to Atlassian Confluence
- [API Blocks Guide](https://docs.docuwriter.ai/docuwriterai-platform-docs/106551): Using API blocks within documentation pages

## Platform AI Agent

- [Agent Overview](https://docs.docuwriter.ai/docuwriterai-platform-docs/408853): Built-in AI assistant that searches docs, reads pages, creates and updates content, and answers questions
- [Agent Capabilities](https://docs.docuwriter.ai/docuwriterai-platform-docs/408880): Search documentation, create pages, update content, answer questions about your codebase
- [Examples & Tutorials](https://docs.docuwriter.ai/docuwriterai-platform-docs/408881): Practical walkthroughs showing what the Platform AI Agent can do

## AI Preferences

- [AI Preferences](https://docs.docuwriter.ai/docuwriterai-platform-docs/423380): Set custom guidelines and documentation templates so every AI generator follows your team's writing style and terminology

## MCP (Model Context Protocol)

- [MCP Overview](https://docs.docuwriter.ai/docuwriterai-platform-docs/118972): Use DocuWriter.ai tools from AI coding assistants via MCP
- [Connect Claude Code](https://docs.docuwriter.ai/docuwriterai-platform-docs/284545): Set up DocuWriter.ai MCP server with Claude Code CLI
- [Connect Cursor](https://docs.docuwriter.ai/docuwriterai-platform-docs/284546): Set up DocuWriter.ai MCP server with Cursor IDE
- [Connect ChatGPT](https://docs.docuwriter.ai/docuwriterai-platform-docs/119390): Set up DocuWriter.ai MCP server with ChatGPT
- [VSCode MCP Tutorial](https://docs.docuwriter.ai/docuwriterai-platform-docs/184474): Set up DocuWriter.ai MCP server in VSCode
- [MCP Tool Reference](https://docs.docuwriter.ai/docuwriterai-platform-docs/184551): Complete reference for MCP tools that generate documentation, API docs, UML diagrams, manage spaces, search, audit logs, repository sync suggestions, webhooks, teams, AI preferences, and generator history

### MCP behavior notes

- Full-tree documentation through MCP is a two-step flow: first preview the repository tree, then submit the accepted preview using the returned `accepted_tree_hash`. Raw tree payload overrides are not accepted.
- Generator tools check plan access, team role, selected-file limits, and credits before starting a run.

## Integrations

- [Git Connections & Repository Sync](https://docs.docuwriter.ai/docuwriterai-platform-docs/106540): Connect GitHub, GitLab, Bitbucket, or Azure DevOps repositories
- [Self-Hosted GitLab](https://docs.docuwriter.ai/docuwriterai-platform-docs/224565): Integration guide for self-hosted GitLab instances
- [n8n Integration](https://docs.docuwriter.ai/docuwriterai-platform-docs/106542): Workflow automation with n8n community nodes and public HTTP/HTTPS webhook endpoints
- [n8n CI/CD Integration](https://docs.docuwriter.ai/docuwriterai-platform-docs/106544): Automate documentation in CI/CD pipelines with n8n
- [n8n Team Workflows](https://docs.docuwriter.ai/docuwriterai-platform-docs/106545): Team documentation workflows with n8n

## API Reference

- [API Overview](https://docs.docuwriter.ai/docuwriterai-api-docs/92073): Authentication, base URL, and getting started with the REST API
- [Bearer Authentication](https://docs.docuwriter.ai/docuwriterai-api-docs/92072): Auth setup and common errors
- [POST /api/generate-code-documentation](https://docs.docuwriter.ai/docuwriterai-api-docs/92064): Generate code documentation via API
- [POST /api/generate-multi-file-documentation](https://docs.docuwriter.ai/docuwriterai-api-docs/92069): Generate documentation from multiple files
- [POST /api/generate-swagger-api](https://docs.docuwriter.ai/docuwriterai-api-docs/92065): Generate Swagger/OpenAPI documentation via API
- [POST /api/generate-uml-diagram](https://docs.docuwriter.ai/docuwriterai-api-docs/92070): Generate UML diagrams via API
- [GET /api/generations](https://docs.docuwriter.ai/docuwriterai-api-docs/92060): List all generations
- [GET /api/generations/{id}](https://docs.docuwriter.ai/docuwriterai-api-docs/92066): Get a specific generation
- [GET /api/spaces](https://docs.docuwriter.ai/docuwriterai-api-docs/92058): List all spaces
- [POST /api/spaces](https://docs.docuwriter.ai/docuwriterai-api-docs/358013): Create a new space
- [POST /api/spaces/{space}/documents](https://docs.docuwriter.ai/docuwriterai-api-docs/92056): Create a document in a space
- [GET /api/spaces/{space}/documents](https://docs.docuwriter.ai/docuwriterai-api-docs/118761): List documents in a space
- [GET /api/spaces/{space}/documents/{id}](https://docs.docuwriter.ai/docuwriterai-api-docs/92054): Get a specific document
- [PUT /api/spaces/{space}/documents/{id}](https://docs.docuwriter.ai/docuwriterai-api-docs/92059): Update a document
- [DELETE /api/spaces/{space}/documents/{id}](https://docs.docuwriter.ai/docuwriterai-api-docs/92057): Delete a document
- [POST /api/spaces/{space}/search](https://docs.docuwriter.ai/docuwriterai-api-docs/92055): Search documents within a space
- [GET /api/repositories](https://docs.docuwriter.ai/docuwriterai-api-docs/92075): List connected repositories
- [POST /api/my-generations](https://docs.docuwriter.ai/docuwriterai-api-docs/92071): List your generations with filters
- [Webhook Authentication](https://docs.docuwriter.ai/docuwriterai-api-docs/92061): Webhook setup and signature verification
- [Webhook Event Payloads](https://docs.docuwriter.ai/docuwriterai-api-docs/92063): Event types, payload schemas, public endpoint requirements, and bounded delivery log details

### API behavior notes

- Generator endpoints check plan access, team role, selected-file limits, and available credits before starting a run.
- Webhook callback URLs and Autopilot notification webhook URLs must be public HTTP/HTTPS endpoints. Localhost, private network hosts, reserved network hosts, and single-label hostnames are rejected.
- Webhook delivery log response and error bodies are bounded for display.

## Optional

- [Platform](https://www.docuwriter.ai/platform): The complete DocuWriter workflow for connecting repositories, generating structured codebase documentation, managing it in Spaces, and keeping it current with Autopilot
- [Solutions](https://www.docuwriter.ai/solutions): Outcome-focused paths for engineering teams adopting DocuWriter across onboarding, handover, modernization, diligence, and compliance workflows
- [Developer Onboarding](https://www.docuwriter.ai/solutions/developer-onboarding): Use complete, connected codebase documentation to help engineers understand architecture, implementation, dependencies, and team workflows faster
- [Resources](https://www.docuwriter.ai/resources): Documentation guides, examples, comparisons, cheat sheets, templates, and practical learning resources
- [Blog](https://www.docuwriter.ai/posts): Technical content, best practices, and documentation guides
- [Documentation Quality](https://www.docuwriter.ai/documentation-quality): Plain-language quality scores, page improvements, evaluation history, scoring method, minimum passing scores, and limitations
- [Features Overview](https://www.docuwriter.ai/features): Full feature list and platform capabilities
- [Enterprise](https://www.docuwriter.ai/enterprise): Enterprise features, security, and compliance
- [Compare with Alternatives](https://www.docuwriter.ai/compare): Side-by-side comparisons with GitBook, Mintlify, Swimm, and others
- [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=docuwriter-ai.docuwriter-ai): Generate documentation directly from your IDE
- [Platform Access](https://app.docuwriter.ai): Web application and dashboard