DocuWriter Documentation

DocuWriter Documentation

  • Start here
    3
    • What is DocuWriter?
    • Create your first documentation Space
    • Repositories, Spaces, pages and generations
  • Connect your code
    8
    • Connect a Git repository
    • Connect GitHub
    • Connect GitLab
    • Connect self-hosted GitLab
    • Connect Bitbucket
    • Connect Azure DevOps
    • Document a one-time project ZIP
    • Troubleshoot repository connections
  • Generate documentation
    8
    • Focused generators
      5
      • Use focused generators
      • Generate a per-file reference
      • Generate a README
      • Generate release notes from a branch comparison
      • Write a focused guide from selected source files
    • Generate complete codebase documentation
    • Choose your documentation audience
    • Review and customize the outline
    • Apply writing guidelines and templates
    • Find and fill documentation gaps
    • Manage saved generations and versions
    • Troubleshoot documentation generation
  • Manage and share Spaces
    7
    • Organize pages and folders
    • Edit and review documentation pages
    • Document an endpoint with an API block
    • Search documentation and ask questions
    • Publish a public documentation Space
    • Export and download documentation
    • Copy pages into AI tools
  • Keep documentation current
    8
    • How Autopilot keeps documentation current
    • Connect a Space to Autopilot
    • Choose branches, triggers and path filters
    • Review and apply documentation suggestions
    • Configure optional auto-apply
    • Configure Autopilot notifications
    • Review activity and audit history
    • Troubleshoot missing Autopilot updates
  • Integrations and AI assistants
    5
    • MCP assistants
      6
      • Connect an AI assistant to DocuWriter
      • Connect ChatGPT or Codex
      • Connect Claude Code
      • Connect Cursor
      • Connect VS Code
      • MCP capabilities and task reference
    • Platform Agent
      4
      • Use the Platform Agent
      • Practical Agent workflows
      • Review Agent actions and approvals
      • Use DocuWriter in Slack
    • n8n
      3
      • Connect n8n and run your first workflow
      • Build CI/CD, team, and code-quality workflows
      • Prepare an n8n workflow template for sharing
    • Export a Space to Confluence
    • Receive outgoing DocuWriter webhooks
  • Account and billing
    4
    • Invite teammates and manage access
    • Understand credits and usage
    • Manage your account and subscription
    • Get support and report a documentation problem
  • API reference
    7
    • Start with the API
      5
      • Public API quickstart
      • Bearer authentication and token management
      • Errors, limits and retry behavior
      • Get the authenticated user
      • Get account and credit information
    • Spaces and documents
      8
      • List Spaces
      • Create a Space
      • List documents in a Space
      • Read a document
      • Create a document
      • Update a document
      • Delete a document
      • Export documents and Spaces
    • Search
      2
      • Search a Space
      • Search across accessible Spaces
    • Generations
      11
      • List generations
      • Get a generation
      • List and filter my generations
      • Generate code documentation
      • Generate code tests
      • Generate code optimization
      • Generate code comments
      • Generate a UML diagram
      • Convert code between languages
      • Generate multi-file documentation
      • Generate Swagger / OpenAPI documentation
    • Repositories
      1
      • List connected repositories
    • Webhooks
      3
      • Manage webhook subscriptions
      • Verify webhook signatures
      • Webhook event payloads and delivery
    • Autopilot
      2
      • Read and review Autopilot suggestions
      • Manage Autopilot repository links
  • Previous guides
    4
    • Capabilities
    • N8N User Guide Team Workflows
    • N8N User Guide Getting Started
    • N8N User Guide Code Quality

Powered by

Capabilities

This guide is now part of Use the Platform Agent. Open the updated guide for the current instructions.

Updated September 28, 2026

PreviousManage Autopilot repository links
NextN8N User Guide Team Workflows
​