# Autodoc
## Create Documentation with Autodoc
Autodoc turns captured evidence and lineage into audit-ready documents. Choose one of three paths depending on your goal and inputs.
> **You’ll use this when creating complete model documents such as** Model Development / Validation Documents (MDD/MVD), internal technical reports, or standardized model cards.
***
### Prerequisites
* Access to the **Project** you want to document
* Iterations and metadata containing the evidence to include in your documentation
**Optional:**
* A reference document if you want to imitate the structure and content of an existing report
* A custom template if you want to follow a predefined structure and scripted content
***
### Path 1 — Ask Vectice to build a technical report with Ask AI
**Best for:**
* To generate technical documentation from your current project with minimal manual setup.
* You don't have a strict documentation format to follow.
* Get from no documentation to complete project documentation in minutes.
**Steps:**
* Capture your work in one or multiple Iterations e.g. Runs, datasets/schemas, parameters, metrics, model versions, validation results, lineage, code snippets (from [Autolog](/introduction/readme/autolog.md) )
* Open: *Your Project* **→ Reports → Generate Report → With Ask AI**
* Select the list of iterations that are going to be relevant to document your project and the target model version
* Click on "**Start generating**"
After generation completes, you’ll have a full project report with details on the model, chosen algorithms, data preparation, validation, and more.
\
You can then edit the document using [AskAI](/introduction/readme/askai.md) for final touches.
### Path 2 — From an Existing Document
**Best for:** updating legacy docs or reusing past reports as templates for new reports. Vectice will respect the documentation structure and content and apply it to the newly generated documents
**Steps:**
Steps are similar to **path 1** but you will also select either an existing Vectice document or import a new document as reference.
* Capture your work in one or multiple Iterations e.g. Runs, datasets/schemas, parameters, metrics, model versions, validation results, lineage, code snippets (from [Autolog](/introduction/readme/autolog.md) )
* Open: *Your Project* **→ Reports → Generate Report → With Ask AI**
* Select the list of iterations that are going to be relevant to document your project and the target model version
* Select an existing report to use as template or import a word document
* Click on "**Start generating**"
**Import tips**
* TBD...
***
### Path 3 — From a Vectice Custom Template
**Best for:** highly standardized docs and repeatable generation process ; enforce structure and content generation with [Vectice custom templates](/introduction/readme/vectice-custom-templates.md). You will need a predefined template or can use the default ones provided by Vectice.
**Steps**
* Capture your work in one or multiple Iterations e.g. Runs, datasets/schemas, parameters, metrics, model versions, validation results, lineage, code snippets (from [Autolog](/introduction/readme/autolog.md) )
* Open: *Your Project* **→ Reports → Generate Report → From template**
* Select the template corresponding to your project and click **"Use template"**
* Select the model version to document and click **"create"**
**Notes**
* Templates include reusable sections, macros, and Ask AI prompts; they pull tables/figures from evidence and ensure a highly repeatable documentation generation process.
* Admins manage templates in **Settings → Templates** and can update template content.
***
### Which path should I choose?
| Goal / Constraint | From Custom Template | From Existing Doc | Ask Vectice (AI-first) |
| ----------------------------------------- | -------------------- | ------------------------- | ---------------------- |
| Enforce consistency at scale | ★★★ | ★★★ (depends on coverage) | ★ |
| Migrate legacy content | ★ | ★★★ | ★★ |
| Fastest first draft from current evidence | ★ | ★★★ | ★★★ |
| Minimal manual editing | ★★★ | ★★ | ★★ |
| No Preparation Work | ★ | ★★★ | ★★★ |
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.vectice.com/introduction/readme/autodoc.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.