Skip to main content

Summarization Scripts-AI

Business Opportunity

The problem is the manual creation of documentation for automation assets, which can be a time-consuming and error-prone process.People need to know the code or language to create documentation for the code files, which takes a lot of time to study the old languages and to prepare a documentation.

Link to Summarization Scripts-AI Canvas Dashboard: Summarization Scripts-AI

Solution / Approach

The proposed solution is to automate the creation of documentation for automation assets by analyzing the source code using an LLM model (Azure OpenAI). Users will upload the file, and the data will be passed to the LLM model with a prompt to extract the summary, techspecs, dependencies, prerequisites, functions, and variables. The extracted data will be presented in a table format, with the summary displayed as a paragraph and the functions displayed in a flowchart. Users will be able to download the generated documentation in PDF or DOCX format

Architecture

archdiagram

Key Metrics

  • The ability for users to download the generated documentation in either PDF or DOCX format will be provided, allowing them to choose the format that best suits their needs.
  • The generated documentation will include a visual flow chart that illustrates how the function works, as well as a table view that provides information on the code's tech specs, dependencies, prerequisites, and function variables.

Tech Stack

  • React JS
  • Open AI
  • Flask

React Js Open AI Flask

Resource Links

Next Steps

As this is phase 1 of the project, the focus is on generating documentation for a single code file. However, in the next steps, the project could be extended to generate full documentation for a GitHub repository by providing the link or asking relevant questions. This would make it easier for developers to document their code and keep it up-to-date. Additionally, the system could be enhanced to automatically update the documentation when changes are made to the source code. This would ensure that the documentation is always accurate and up-to-date. Overall, the goal is to make it as easy as possible for developers to document their code and maintain their automation assets.

Feedback

We appreciate your feedback! Please provide us with any suggestions or improvements you have for our product.Please provide feedback on this product by clicking the following Link: