Introduction

Welcome to the user guide for AllAi Doc! This powerful documentation generator is specifically designed for Salesforce and Salesforce Commerce Cloud projects.

We understand that creating and maintaining documentation can be a challenging and time-consuming task for teams and organizations. Outdated and incomplete documentation can lead to confusion and delays in the future, as well as difficulties for new team members to align with the project.

AllAi Doc is here to revolutionize the documentation process by harnessing the power of AI. With its intelligent capabilities, AllAi Doc automates the generation of documentation for various supported metadata types in your projects. Say goodbye to the tedious manual process of documenting your Salesforce and Salesforce Commerce Cloud projects.

In this user guide, we will walk you through the features and functionalities of AllAi Doc, providing you with step-by-step instructions on how to make the most out of this powerful tool. Whether you are a developer, project manager, or a member of the functional team, AllAi Doc is here to simplify and streamline your documentation workflow.

Let's dive in and discover how AllAi Doc can help you create comprehensive and up-to-date documentation effortlessly.

Let’s start with some preparations.

Preparations before Using AllAi Doc

In order to generate documentation for your Salesforce project, the first step is to export it to your local machine.

Please select your project type and follow the steps.

• Exporting the SFDC Project

• Exporting the SFCC Project

After the project has been exported, we can proceed with the documentation process.

Create a New Project

Please visit https://doc.allai.digital/projects , enter your credentials to login.
Once you're logged in, you will be greeted by the Projects workspace. This workspace allows users to generate documentation for multiple projects.

Open

From the Projects workspace, you have the ability to create new projects, view your existing projects, and manage them accordingly.

To create a new project, simply click on the "+ New Project" button.

Open

1. Provide a name for the project.

2. Select the type of project from the available options: Salesforce Core (SFDC) or Salesforce Commerce Cloud (SFCC).

3. Optionally, add the GitHub repository URL.

4. Optionally, add the JIRA project URL.

5. Optionally, provide a description for the project.

6. To finalize the project creation, click on the "Create" button.

Create a New Documentation Version

After creating the project, you will be redirected to the project's versions page. Here, you can create multiple versions of documentation, view existing versions, download documentation versions, and use the AI-powered chat to discuss and gain a better understanding of the project.

Open

Having multiple versions can be highly beneficial, especially when the development is ongoing and users want to create a new version of the documentation that includes the latest changes made in the project.

To create a new version, simply click on the "+ New Version" button.

Open

You will need to provide the following information for the new version.

1. Version Name: Enter a name for the version of the documentation.

2. Version Number: Specify a version number for the documentation.

3. Description (optional): You can add a brief description for the version if desired.

4. Project Upload: The most important step is to export your project, compress it, and upload it to the documentation platform. Please follow the steps provided in step 2.

Click the “Create” button to initiate the new documentation version creation.

Download the Documentation Version

Open

Parsing the project, generating explanations and descriptions may take a few hours, depending on the size of your project.

Open

Once the project documentation process is complete, you can download the output by clicking on the save icon 💾 located under the actions section.

Use Chat to Understand More about your Project

You can utilize the AllAi powered chat functionality to interact with your project documentation. This feature allows you to gain a better understanding of the project, its components, and search for specific information about any component instantly. Feel free to ask any questions or seek clarification using the chat functionality provided.

Open

To access the chat functionality for a specific version, click on the version name that you would like to chat with. This will open up the chat interface where you can engage in a conversation and obtain more information about the project and its components.

Open

View the Generated Documentation

The output of AllAi Doc will be in the form of a markdown structure, with each metadata documentation placed in its own folder.

Please see How can I preview the output of AllAi Doc? to learn more.

Documentation Structure for SFDC Projects

Example structure for a Salesforce core project:

• index.md → Homepage of the documentation, consist of overall object relationship diagram.

• aura → Consist of all the available aura components in the project

• classes → Consists of Apex classes available in the project.

• flexipages → Consists of available flexipages in your project.

• flows → Consists of available flows in your project.

• lwc → Consists of available LWC components in your project.

• objects → Consists of available standard, custom objects as well as custom settings and custom metadata types available in your project.

• permissionsets → Consists of available Permission Sets in your project.

Documentation Structure for SFCC Projects

Example structure for a Salesforce Commerce Cloud project:

• index.md → Homepage of the documentation contains information about the available metadata and the technologies that are being used.

• controllers → Consists of available controllers in the project.

• jobs → Consists of available jobs in the project.

• page_designer → Consists of available page designer components in the project.

• services → Consists of available services in the project.

• sites → Consists of available sites in the project.