AI Codebase Documentation

Tutorial series

1. Getting Started with AI Code Documentation

The AI Code Documentation tool simplifies the process of creating detailed documentation for codebases. It leverages AI to generate comprehensive descriptions, allowing users to better understand and maintain the code.

Use Cases:

The documented code can be used as a reference for long-term maintenance.
It helps in the onboarding process for new developers with clear and thorough documentation.
Auto-sync feature with GitHub keeps your documentation up-to-date with your latest changes in the repository.

How to Access AI Code Documentation:

Start by creating your project on Workik.
In project Dashboard, navigate to the 'AI code documentation' option in the leftmost panel.
You will be greeted with the main interface where you can begin by clicking on 'Create Document Set'.

2. Creating Document Sets

Document Sets serve as organized repositories for storing your code files along with descriptions of your code's functionality and purpose.

How to Create a Document Set:

Here's how you create your Document Set:
1. Once you click on 'Create Document Set', a pop-up will appear. Here, you can name your document set.
2. Next, you can add your code files that needs to be documented in three ways:
  1. Code Integration
  2. Code Snippets
  3. Upload files and folders
Note: To know more on How to add your Code Files, Click Here
Accessing Code Files in a Document Set:
1. Once uploaded, code files appear in the 'Directory' panel.
2. To view the code, simply click on the relevant file. This will prompt the code panel to appear with your code.
Note: Workik provides you with 'Bulk Document Generator' – a handy feature that allows to generate documentation of multiple code files in one go. You can learn more about it in the sections below.

3. Generating Documentation with AI and More

The Workik Documentation tool simplifies the process of creating detailed documentation for each code file with AI. This allows developers to focus on innovation while maintaining clear and comprehensive documentation.

Steps to Generate AI-Powered Documentation:
1. Next to the 'Code' panel there is 'Document' panel, where you have two options:
  1. Generate with AI: Let the AI create documentation for you.
  2. Create Manually: Write your documentation from scratch.
2. Click on 'Generate with AI'.
3. A 'Choose Layout' pop-up will appear.
4. While the 'default' layout is pre-selected, you can also add your preferred layouts for documentation. Click on 'Add Layout' or select pre-saved layouts if any.
  
  Note: You can learn more about layouts in the section below.
5. You can also add any additional text context necessary to help AI generate more desired output. You can define your constraints, preferences, and more.
6. Once done, click on 'Create Document' to have the AI generate the documentation for you.
7. Finally, AI generates documentation of the selected file using the layout provided.
Bulk Document Generation with AI

Workik allows users to generate documentation for multiple code files at once with its bulk generation feature. This feature helps in saving time significantly and ensuring consistency across your project's documentation.

By following these steps, you can create comprehensive documentation for a batch of code files, ensuring consistency and saving time:
1. Go to the 'Directory' panel on the left side of your screen.
2. Click on the 'Bulk Document Generator' button.
3. Select the code files you wish to document by checking their corresponding boxes.
4. After selecting the files, click on the 'Next' button.
  
  Note: You can learn more about layouts in the section below.
5. A pop-up will appear, prompting you to choose layouts for each type of file extension you are documenting. Select the desired layout for each file type.
6. Click on 'Next'. Another pop-up will provide you with a space to add additional context.
7. Fill in the additional context as needed, then click on 'Create Document'. This information helps generate the necessary AI documentation tailored to your requirements.
8. The AI will process the information and generate the documentation for the selected code files.
How to Edit a Document:
1. Use the editing tools to modify your documentation directly in the 'Document' panel.
How to Download a Documentation Generated:
1. Use the editing tools to modify your documentation directly in the 'Document' panel.
How to Delete a Document:
1. Locate the delete icon within the interface to clear the generated document.

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 "Code 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’.
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 in a document set 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 Extensions:
You can set specific layout formats for each file extension, ensuring documentation is tailored to the unique needs of different file types like .html, .css, .js, or .py. This customization enhances the clarity and effectiveness of your project's documentation.
Adding Custom Layouts:
1. For adding layouts specific to other file extensions, click on the extension you want to add layout, from the 'Code Extensions' list.
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 project’s document set needs.

6. Additional Tips

Customize layouts to adapt documentation standards to your company guidelines.
Use the 'Bulk Document Generator' for efficient documentation of multiple files.
Engage with the 'Code Chat' feature to clarify or discuss documentation details with AI.

AI Codebase Documentation

1. Getting Started with AI Code Documentation

Use Cases:

How to Access AI Code Documentation:

2. Creating Document Sets

How to Create a Document Set:

Accessing Code Files in a Document Set:

3. Generating Documentation with AI and More

Steps to Generate AI-Powered Documentation:

Bulk Document Generation with AI

How to Edit a Document:

How to Download a Documentation Generated:

How to Delete a Document:

4. Chat With AI Feature

5. Layouts for Documentation

Initiate Layout Customization:

Adding Custom Layouts:

6. Additional Tips