Documentation Wizard
The Documentation Wizard in Y42 is a powerful tool that leverages AI to help users automatically generate and update descriptions for models and model columns, ensuring high-quality documentation with minimal effort. This guide will walk you through everything you need to know to effectively use this feature.
Enabling the Documentation Wizard
To enable the Documentation Wizard feature:
- Open the space Settings.
- Navigate to Features.
- Locate the Enable GenAI section. Select Enabled from the dropdown to activate it for your workspace.
Documenting Model Columns
Single Column
Go to your model's Columns page in Asset Editor: List mode and hover over the column description box you wish to document. Click on the Wand icon. The Documentation Wizard will analyze the model's code and provide a suggested description which you can accept or discard.
Generating the description for a single column.
All Columns
In the same interface, right click on any row and click on Document all columns. Once all descriptions have been generated you will be prompted to overwrite and Update all column descriptions.
Generating descriptions for all columns.
Generating and Updating Model Descriptions
Open a model asset and locate the asset's metadata sidebar on the right. Hover over the description section and click on Update with AI. The Documentation Wizard will analyze the model's code and provide a suggested description which you can accept or discard.
Generating the asset metadata description.