Actions6
Overview
This node, named DocuWriter.ai, is designed to generate AI-powered code documentation and analysis based on provided source code. It supports multiple resources and operations, including generating technical documentation, test cases, UML diagrams, and optimizing code. The node sends the source code and related parameters to an external API service that performs the analysis or generation.
For the Code Documentation - Generate operation specifically, the node takes source code and generates detailed documentation in a chosen language and style. This is useful for developers who want to automate the creation of technical documentation, improve code understanding, or maintain consistent documentation standards without manual effort.
Practical examples:
- Automatically generate comprehensive technical documentation for a new or legacy codebase.
- Produce documentation in different languages to support international teams.
- Quickly create initial documentation drafts to speed up onboarding or code reviews.
Properties
| Name | Meaning |
|---|---|
| Source Code | The actual source code text to analyze and generate documentation from. |
| Filename | The filename associated with the source code (used for context or file-type recognition). |
| Mode | Generation mode: • Faster — prioritizes speed for quick results. • Accurate — prioritizes detailed and thorough analysis. |
| Output Language | The language in which the generated documentation will be written (e.g., English). |
| Documentation Type | The style or type of documentation to generate, e.g., "Technical Documentation". |
Output
The node outputs JSON data containing the generated documentation or analysis result returned by the external API. The structure typically includes fields such as the generated text content describing the code, possibly segmented into sections depending on the documentation type.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authentication with the external DocuWriter.ai service.
- The node makes HTTP requests to the configured base URL of the DocuWriter.ai API.
- Proper network connectivity and valid credentials are necessary for successful execution.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing empty or malformed source code may lead to errors or incomplete documentation.
- Network connectivity problems can prevent API calls from succeeding.
- Selecting incompatible options (e.g., unsupported output language) might cause unexpected results.
Error messages:
- Errors returned from the API are propagated; typical messages include authentication errors, invalid input errors, or rate limiting notices.
- If the node is set to continue on fail, error details are included in the output JSON for each failed item.
Resolutions:
- Verify and configure the API key credential correctly.
- Ensure the source code input is valid and complete.
- Check network access and firewall settings.
- Use supported option values as per the node's property definitions.
Links and References
- DocuWriter.ai Official Website (hypothetical link for reference)
- n8n Documentation on Creating Custom Nodes
- General information on Code Documentation Best Practices