How to Use DocuWriter.ai

Getting started with DocuWriter.ai

In this guide, you will learn how to set up DocuWriter.ai and generate technical documentation for your software projects. You’ll be able to create code docs, API specs, and UML diagrams in no time.

Step 1: Sign up and set up

1. Visit DocuWriter.ai.
2. Click on the “Sign Up” button in the top right corner.
3. Fill in your details (name, email, password) and click “Create Account”.
4. Check your email for a verification link and click it to activate your account.
5. Log in to the platform.

Step 2: Your first documentation

1. Once logged in, navigate to the “New Project” button on your dashboard.
2. Enter your project's name and a brief description, then click “Create”.
3. Select the type of documentation you want to generate (e.g., API Specification).
4. Click “Generate” and follow the prompts to input your code or API details.
5. Review the generated documentation and make any necessary adjustments using the “Edit” button.

Step 3: Get better results

1. Use the “Integrations” menu to connect your version control system (e.g., GitHub or GitLab) for automatic documentation updates.
2. Experiment with different templates available in the “Templates” section for UML diagrams and code documentation.
3. For API specs, provide detailed comments in your code to enhance the output quality. The AI utilises these comments to generate more accurate documentation.

Pro tip

Use the “Preview” feature before finalising your documentation. This allows you to see how the document will look and make any adjustments without having to go back and forth.

Common mistake to avoid

Avoid skipping the detailed comments in your code. The more context you provide, the better the AI can generate useful documentation. Many users underestimate the importance of this step, leading to less effective documentation.