AI Database Documentation

Tutorial series

Welcome to our quick guide, where we'll walk you through how to use the AI Database Documentation feature. It simplifies and automates the process of creating comprehensive documentation for database structures with AI.

Now, let's explore how you can document your database structure through the sections outlined below.

1. Accessing the Tool

Here's how you can acces the DB Documentation tool:

After creating a project on workik, navigate to the left side panel and click on AI DB Documentation to open the documentation interface.

Note: To know more on How to add your Code Files, Click Here

2. Creating a New DB Document

Here's how you can create a new DB Document:

In the AI DB Documentation interface, click on the ‘Create DB Documentation’ button.
A pop-up will appear, where you have two options for adding your database:
1. Add Custom Database Structure: Manually upload or specify the structure of your existing database. To know more click here .
2. Create Workik Database with AI: Use AI assistance to generate a working database structure based on your needs. To know more click here .

Note: To know more on How to add your Code Files, Click Here

3. Generating Column Descriptions, Documentation and More

Generating Column Descriptions with AI

By following these steps, you can generate Column Descriptions with AI in Workik:
1. After uploading/creating your database, all the tables will be listed in the left panel under Table.
2. Click on the table you want to document. The columns of your selected table will be displayed.
3. Click on "Generate AI Descriptions". The system will then automatically analyze each column in your table and generate short descriptions for each table column.
Generating AI-Powered Documentation for a Table:

By following these steps, you can generate Documentation for desired table with AI:
1. Under the documentation section, locate and click the ‘Generate Document’ button.
2. A pop-up window will show up, where you can choose your preferred layout for the document. Then click on 'Generate Document' to create the document with the selected layout.
  Note: If you don't have any layout preference, you can click on "Skip and Generate" .
  
  Note: If you wish to customize the layout further, click on Add Layout to adjust the documentation layout to your preferences. To know more about layouts, please refer to the subsequent ‘Section-5’ in the tutorial ahead.
3. The AI processes your inputs and generates documentation for the selected table.
Bulk Document Generation with AI

By following these steps, you can Bulk generate Documentation for desired tables:
1. In the Table panel, click on the Bulk Document Generator button.
2. Select the tables you wish to document by checking their boxes. Then Click ‘Next’.
3. Click ‘Next’ to choose the layout for the database and add ‘additional context’ if any for an precise AI output. Then click on 'Generate Document' to create the document.
  Note: You can learn more about layouts in the section below.
4. The AI processes your inputs and generates documentation for the selected tables.
How to Edit a Document:
1. Use the editing tools to modify your documentation directly in the 'Documentation' section.

4. Chat With AI Feature

Additionally, a feature to chat with AI is available post-documentation generation for any further assistance or queries.

Click on the ‘AI’ button in the toolbar.
Upon clicking, a side panel should appear on your screen. This is the AI "Database chat" interface.
Enter your query into the text box. Be as specific as possible to get the best results from the AI and click on ‘Get AI Response’.
Note: Note that the table tdetails is passed in the context of AI.
The AI will generate the required output. Also You can continue the conversation with the AI by typing follow-up questions or new queries into the chat interface.

5. Layouts for Documentation

A layout acts as a blueprint which guides AI in generating documentation. It defines the structure and format in which the information will be organized and presented, ensuring consistency and clarity across all generated documents.

Initiate Layout Customization:
1. To begin, click on the 'Layout' button located in the top right corner of the interface.
Default Layout:
The Default Layout is a predefined structure that Workik provides for your initial documentation, which you can use as it is or customize if needed.

Note: You can always customize the Default Layout!

Layouts for Different Database Types:
You can set specific layout formats for each database type supported by workik, ensuring documentation is tailored to the unique needs of different database types This customization enhances the clarity and effectiveness of your Database documentation.
Adding Layouts for preferred Database Type:
1. For adding layouts specific to certain Database Type, click on the DB type you want to add layout for.
2. Click on 'Add new Layout', a pop-up window titled 'Create Layout' will appear.
3. In the pop-up, start by entering a name for your new layout in the 'Name' field.
4. Use the provided text and formatting tools to design the structure of your document. You can define headings, sections, and any specific information fields that you need. Then click on 'Save' to finalize your custom layout.
  
  Note: You can design multiple layouts for each file extension to best suit your database documentation needs.