> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/devops/devops-de/code/code-tools/ki-code-dokumenter-verwenden.md).

# KI-Code-Dokumenter verwenden

{% hint style="warning" %}

#### Geschrieben für die alte Benutzeroberfläche

Dieser Artikel wurde für die alte Benutzeroberfläche geschrieben. Die Anweisungen sind weiterhin verwendbar, aber die Screenshots sind veraltet. In einigen Fällen wurden die in den Anweisungen genannten Elemente verschoben oder geändert. Wenn Sie ein Element nicht finden können, siehe den [Wo ist es hin](/devops/devops-de/ubergang-zur-neuen-ui-ux/wo-ist-es-hin.md) Artikel.
{% endhint %}

## ![](https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FG5ZbxX918xOHwbAwAJ4n%2FSummary2-Small-Icon.svg?alt=media\&token=da26a67f-ff7f-47b3-8669-06be960dc2d7) Überblick

Dieser Artikel erklärt, wie der AI Code Documenter verwendet wird, um automatisch Dokumentation für eine ausgewählte Komponente zu generieren. Er hilft Teams dabei, klare, gut strukturierte Code-Dokumentation zu erstellen, die Sie in den Branch committen können.

{% hint style="info" %}

#### Standardmäßige KI-Einschränkungen

Standardmäßig stellt Flosum über die API von DeepSeek ein kostenloses gemeinsam genutztes DeepSeek-KI-Modell für DevOps bereit. Da es mandantenübergreifend gemeinsam genutzt wird, hängen Leistung und Verfügbarkeit von der Systemauslastung und der Token-Kapazität ab. Bei hoher Nutzung kann es zu höherer Latenz oder vorübergehenden Fehlern kommen. Um dies zu vermeiden, können Sie Ihr eigenes benutzerdefiniertes KI-Modell hinzufügen. Siehe den folgenden Artikel.

* [Ein benutzerdefiniertes KI-Modell hinzufügen](/devops/devops-de/einstellungen/ki-einstellungen/ein-benutzerdefiniertes-ki-modell-hinzufugen.md)
  {% endhint %}

{% hint style="info" %}

#### Bewährte Vorgehensweisen

* Führen Sie AI Code Documenter auf stabilem Code aus, um zu vermeiden, dass Kommentare wiederholt neu generiert werden.
* Überprüfen Sie AI-Kommentare immer vor dem Commit, um Genauigkeit und die korrekte Terminologie sicherzustellen.
* Committen Sie in kleinen, logischen Blöcken, damit Überprüfung und Rollback einfach bleiben.
  {% endhint %}

## Verwendung von AI Code Documenter

{% stepper %}
{% step %}

### Branch und Komponente auswählen

1. Klicken Sie auf **Code** über das Menü in der linken Seitenleiste.
2. Klicken Sie auf den Branch, der die Komponente enthält, die Sie dokumentieren möchten.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2F6BzOyFRxWUmCMo2l6oqX%2FUsingAiCodeDocumenter-S01-01.png?alt=media&amp;token=45147edb-dce8-43c2-8363-0026e0ea0e75" alt="" width="563"><figcaption></figcaption></figure></div>
3. Klicken Sie auf die Komponente, die Sie dokumentieren möchten.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FbACIdtJEKsFKAbOzLGya%2FUsingAiCodeDocumenter-S01-02.png?alt=media&amp;token=6059fd06-4a29-4ba4-9bfb-1d3b06c3319c" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Dokumentation erstellen

1. Klicken Sie auf **KI-Tools** neben **Bearbeiten**.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2Fdoy4RFvG41k7BUW8PW0l%2FUsingAiCodeDocumenter-S02-01.png?alt=media&amp;token=e907df18-b638-41f7-851c-e9e02a26da53" alt="" width="563"><figcaption></figcaption></figure></div>
2. Klicken Sie auf **AI Code Documenter** im Dropdown-Menü aus.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2F1SmvnqItxXChdTI1dHW7%2FUsingAiCodeDocumenter-S02-02.png?alt=media&amp;token=20f5838e-7fb2-49c0-859d-4e46c3aa2f69" alt="" width="563"><figcaption></figcaption></figure></div>
3. Während die Dokumentation generiert wird, **KI wird generiert...** angezeigt.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FqXbSTdANEjNUJ42toBR8%2FUsingAiCodeDocumenter-S02-03.png?alt=media&amp;token=c4c3a173-595f-47e9-829d-d1168c23bca2" alt="" width="563"><figcaption></figcaption></figure></div>
4. Wenn AI Code Documenter fertig ist, öffnet sich die Diff-Ansicht, mit dem Original links und den KI-Änderungen rechts.
5. Überprüfen Sie die Änderungen und nehmen Sie gegebenenfalls erforderliche Bearbeitungen vor.
6. Klicken Sie auf **Änderungen übernehmen**.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FsVAccDOWzK4WVUtpA8Z3%2FUsingAiCodeDocumenter-S02-04.png?alt=media&amp;token=55c2927b-d75a-4b7f-907a-850c6f2d0466" alt="" width="563"><figcaption></figcaption></figure></div>
7. Geben Sie eine **Übermittlungsnachricht**.
8. Klicken Sie auf **Übernehmen**.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FnQ5nleu5HFSzzbfEVVQG%2FUsingAiCodeDocumenter-S02-05.png?alt=media&amp;token=75d392c3-c1b6-42c0-99d2-7d6ee85b8d8e" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flosum.com/devops/devops-de/code/code-tools/ki-code-dokumenter-verwenden.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
