Autodocument FAQs

Question 1

What kind of files does Autodocument generate?

Accepted Answer

Autodocument generates `documentation.md`, `testplan.md`, and `review.md` files within each directory of your repository. It also creates fallback files (e.g., `undocumented.md`) when size limits are exceeded.

Question 2

How does Autodocument work?

Accepted Answer

Autodocument recursively analyzes your code repository, respecting `.gitignore` rules. It uses the OpenRouter API to generate documentation, test plans, and code reviews based on the code's content and structure, creating markdown files in each directory.

Question 3

Can I customize the generated documentation and reviews?

Accepted Answer

Yes, you can customize the prompts used by Autodocument by editing the `src/prompt-config.ts` file. This allows you to adjust the tone, style, and specific instructions for your project's documentation needs.

Question 4

What is Autodocument?

Accepted Answer

Autodocument is a tool that automatically generates documentation, test plans, and code reviews for your code repositories using AI. It analyzes your code and creates comprehensive documentation, test plans with edge cases, and senior developer-level code reviews.

Question 5

How do I configure Autodocument?

Accepted Answer

Autodocument can be configured using environment variables (like `OPENROUTER_API_KEY`), command-line arguments, or an MCP configuration file for integration with tools like Roo and Cline. You can customize file extensions, size limits, models, and prompts.

Autodocument

Autodocument

Key Features

Use Cases

Key Features

Use Cases