DocuWriter.ai — Tree Documentation Generator

1 · Why Use It?

The Tree Documentation Generator builds a multi-page, book-style Space that explains your entire project — architecture, installation, API, usage, and more. The primary path uses a connected Git repository; a secondary one-time ZIP upload is available when a provider connection is not possible.

Key difference: other generators work file-by-file; Tree gives you a curated bird's-eye view.

2 · Prerequisites

Requirement Details
Project source Connect GitHub, Bitbucket, GitLab, or Azure DevOps (primary), or upload a project ZIP as a secondary one-time option.
Connected repository Add it through Git Connections and choose a branch.
ZIP snapshot Use a .zip archive up to 20 GB. No provider account or repository connection is required.

3 · Wizard Steps

  1. Project Source ✓ — choose a connected repository and branch, or upload a one-time project ZIP.
  2. Documentation Structure 🗂️ — review and refine the generated outline.
  3. Start Process 🚀 — launch the build.

4 · Selecting Your Project Source

Connected repository (primary)

  1. Open Full Tree Documentation.
  2. Select a connected repository and branch.
  3. Continue to generate and review the documentation structure.

A connected repository supports later provider-driven workflows such as fresh imports, webhooks, Autopilot suggestions, and change detection.

Project ZIP (secondary one-time option)

  1. Open Full Tree Documentation.
  2. Select Can't connect a repository? Upload a ZIP instead.
  3. Drag and drop or choose a .zip archive up to 20 GB.
  4. Select Upload Project ZIP.
  5. Wait while DocuWriter validates and imports the snapshot, then review the generated documentation structure.

Use this option when security rules prevent provider authorization, the repository is hosted by an unsupported provider, or no provider account is available.

One-time snapshot: ZIP projects do not receive webhooks, automatic code-change detection, Autopilot repository sync, pull-request comments, or branch-based release notes. To document newer code, upload a new ZIP and run Full Tree Documentation again.

5 · Choosing Your Documentation Type

Your documentation type shapes how the AI writes and structures every page. Choose the one that matches your audience:

Type Best for What the AI focuses on
End User Documentation User-facing guides and tutorials How to use features, UI walkthroughs, getting started flows. Avoids internal code details.
Open Source Project Public repositories Installation, contributing guidelines, architecture overview, and API reference.
Internal Technical Docs Team-facing documentation How things work under the hood — architecture, data flows, service boundaries, design decisions.
Internal API Documentation Backend teams Endpoint reference, request/response schemas, auth flows, and integration patterns for internal services.
External API Documentation Third-party developers Public API reference with authentication guides, rate limits, error codes, and integration examples.

Tip: You can always change the documentation type later by running Update Documentation Gaps with a different audience setting on the same Space.

6 · Designing the Documentation Structure

This screen defines every page & subsection that will be generated inside the final Space.

6.1 Generate Tree (Automatic)

  • Click Generate Tree (Automatically).
  • The wizard scans your codebase and proposes a sensible outline based on your repository's actual features, modules, and structure.

6.2 Manual Editing

  • Add to documentation — create top-level sections.
  • Add to sub-sections — nest deeper pages.
  • Drag-and-drop rows to reorder.
  • Each node has a Content textarea → provide context sentences that seed the AI.

7 · Project Description Box

A brief description of the project. This will add some context to the documentation process.

8 · Starting the Build

When satisfied, click Next Step ➜ → Start Process.

  • Progress bar shows status for each section.
  • Generation time scales with repo size.

9 · Where the Output Lives

  • A new Space appears under Spaces.
  • Side-nav = your section tree.
  • Each page is editable like any other Space doc (AI-assist, manual Markdown, etc.).

10 · Best Practices

Focus on the Structure → The depth and clarity of the final Space depend almost entirely on the outline you create in the Documentation Structure step. Treat this tree as the AI's blueprint: refine the section names, drag them into a logical order, and write concise Content prompts for context. A carefully-crafted structure yields richer pages and saves huge amounts of post-generation editing.

Match the audience → The documentation type you choose in step 5 has a big impact on tone and content. End user docs skip internal implementation details, while internal technical docs dive deep into architecture. Pick the right type upfront to avoid rewriting later.

Set up AI Preferences first → If you have a preferred writing style, terminology, or page structure, configure your AI Preferences before generating. Your guidelines and template will be applied to every generated page automatically.

11 · What's Next?

Your initial documentation is just the starting point. As your project evolves, use Update Documentation Gaps from the Space overview or sidebar to let AI find missing topics and generate new sections — without regenerating everything from scratch.

If you used a connected repository, pair the Space with Repository Sync for automatic maintenance. ZIP imports are one-time snapshots, so upload a newer archive and run the workflow again when the code changes.

Need Help?

Email [email protected]