---
title: "Document Generator"
canonical: "https://docs.getxray.app/space/XRAY/160235683/Document%20Generator"
format: markdown
---
## What is the Xray Document Generator?

Xray Document Generator is a feature that allows you to customize your own templates and generate documents regarding your Jira data, mainly, **Xray issues**, **requirements**, and **defects**. It's easy to set up and start creating your documents.


Your end-to-end flow with Document Generator would look like this:

1. Work with your Jira admins to evaluate the template collection already available (at the instance and/or the project level).
2. If needed, add more templates. There are 2 sources: the store and your customization.
  1. While you can build a template from scratch, we recommend editing one of the existing assets from the store.
  2. You would leverage the [Template Building](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/301504485) section of this documentation alongside code customization examples in [Document Generator and Xporter code snippets](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/301471547)
  3. Please check [Curated list of Document Generator Templates](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/337641824) to see some concrete examples of available templates (from the default package or the store) and their possible edits.
3. Select the scope you want to analyze and choose the corresponding menu option for Document Generator
4. Export

### [Template Management](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/159908575)

![image](media://f26fd498-2f70-4e5a-ac5d-12b0f9ed1d94)

<span style="color: #172B4D">Administrators can add, edit, delete, and download the templates that will be available to users.</span>

### [Template Building](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/301504485)

![image](media://7c596ae0-22a3-4a27-9592-795766db70e6)

<span style="color: #172B4D">Templates are documents in DOCX (Microsoft Word) or XLSX (Microsoft Excel) formats.</span><span style="color: #172B4D"> </span><span style="color: #172B4D">Along with the document content, it is possible to specify mappings that will be replaced by the </span><span style="color: #172B4D">issue</span><span style="color: #172B4D"> fields,</span><span style="color: #172B4D"> </span><span style="color: #172B4D">custom fields, and other data such as comments, work logs, attachments, and many other types of data.</span>

### [Exporting](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/160235887)

![image](media://25412710-b8b5-4350-9488-ad3b02ca0c80)


<span style="color: #172B4D">You can export Single or Multiple Issues using the</span><span style="color: #172B4D"> </span>**Xray - Document Generator**<span style="color: #172B4D"> button. This option will be available on the </span>**<span style="color: #172B4D">Issue Navigator</span>**<span style="color: #172B4D">.</span>


Please check [Curated list of Document Generator Templates](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/337641824) to see some concrete examples of templates available out-of-the-box, ready to use or to customize.

There are also some useful [<span style="color: #172B4D">Tutorials, Tips & Tricks for Document Generator and Xporter</span>](https://getxraydocs.atlassian.net/wiki/spaces/X710/pages/45187095)<span style="color: #172B4D">.</span>