LogoLogo
  • Welcome to Kodesage
    • Introduction
    • The Kodesage engine
  • Key Features
    • Ask Kodesage
    • Automatic Documentation
    • Issue Analysis
  • Integrations
    • Git
    • Jira and Redmine
    • Confluence
  • Deploy Kodesage
    • Installation guide
    • Self-hosted LLM installation
    • Self-hosted Embedder installation
Powered by GitBook
On this page
Export as PDF
  1. Key Features

Automatic Documentation

Documentation feature overview

PreviousAsk KodesageNextIssue Analysis

Last updated 4 months ago

Kodesage generates and updates comprehensive documentation across the codebase, significantly improving onboarding times and easing transitions between vendors. As Kodesage is synced with the codebase, issues, wikis, and other sources in real time, documents will always be up to date as systems evolve.

We will provide various documentation templates that you can choose from, to ensure that your systems are documented in a consistent format, and that they also meet the relevant legal requirements. Documents will include diagrams to improve explanations, and describe system dependencies.

One the first draft is generated, data sources can be fine tuned on a section level within each sub chapter.

Getting started with Automatic Documentation

Step 1: Select the documentation template

Step 2: Select data sources

Step 3: Create documentation

After you have selected the data sources, you can click on "Create", and Kodesage will generate the documents for you according to the selected template

Step 4: Review documentation

Once the documentation has been generated, you will be able to select it from the list of documentations to review the content by clicking on the relevant documentation name.

Once you have selected the relevant document, you will be able to review, approve and modify the content.

Select data sources for document generation
Select the relevant documentation from the list
Review documentation