Generating documentation with Spreading.ai

4 min readOct 18, 2023

Writing documentation for your project just got much easier and more accessible to all developer. Who dont want to include proper documentation for their project, I always want to but time is the curse. we dont get enough time to write it.

Now this will change with the introduction of spreading.ai

Spreading.ai is an all-in-one AI-powered knowledge base platform for developers, which makes it easy to build a self-service knowledge base for your customers and developers . Working with a huge team, it’s a very crucial part of developers to write proper docs about the large codebase they handle on a daily basis to maintain the readability and acceptability by other developers also. Here this tool comes into the picture and allows developers to generate docs from product descriptions & code.

The best part is that, it’s 100% free tool and anyone can use it without having any prior experience of writing documentation.

Whether you are a beginner or an experienced developer, this tutorial will provide you with all the necessary tools and knowledge to get started with Spreading.ai

Be it API references, code guidelines, product overviews and everything in between. It helps you help your users with easy-to-publish, intuitive to use, highly searchable docs.

Let’s get started

Let’s create docs of a simple calculator application using this AI tool.

Creating a project

Go to the spreading.ai and sign up with your Google account. You will be redirected to the homepage. At the left section click on the option Team Project and create a project with your preferred name. For example, here I’m using a simple Calculator App made with Flutter.

Generate directory with AI

After creating the project open it and you will see a main folder, where you have to put directories and files for particular sections of the project. You will see an option to Generate directory with AI. Simply you have to select the Documentation type and write sentences along with project description within 100 characters each. Click on to the generate button and it will create folder structure automatically with proper naming conventions. You can either regenerate the response for better results or you can accept it.

Docs Editing

Moving further with next steps, clicking on the file under a particular sub-directory, you will an option to generate outline and generate docs with AI. Choose according to your choice. If you want to generate brief outline, simply tap on Generate outline and select documentation type, audience type along with product description in the textbox. Click on the Generate button, it’ll generate entire outline of project. It allows you to add more content under outlines from + icons.

If you choose Generate doc from code option, you have to simply select context from documentation type with programming language and put the code snippet there, click on the generate button and it’ll create entire documentation with a detailed explanation of code and form it in a proper structural manner. You can either save your work or put it down for preview.

Platform features

Invite Members

This platform allows developers to collaborate with others by sharing an invitation link from Invite Members section. Like any social media post, any one can opens up your work contribute in it within 7 days of validity.

Private Space

If you want to create docs for your personal project, you can click to the Private Space section and create your own page. Write docs about your personal project and also you can copy that text to put them into README.md in github

Custom Sharing Option

Also you can share your work using your custom site and domain name. Simply fill the configuration section by adding icon and favicon with their respective URLs. For hosting there are options of custom domain and proxy settings. And you will be ready to share your work with world.