Zum Hauptinhalt springen

Wissensdatenbank

KI-Agenten sind nur so gut wie der Kontext, den du ihnen gibst. In der Wissensdatenbank speicherst du Architekturentscheidungen, API-Spezifikationen und Domänenwissen, auf das Agenten bei der Implementierung verweisen. Ohne diesen dokumentierten Kontext raten Agenten. Mit ihm treffen sie fundierte Entscheidungen, die auf deiner Realität beruhen.

Die Wissensdatenbank von Almirant ist ein integriertes Dokumentationssystem, in dem dein Team Dokumente im Markdown-Format erstellen, organisieren und durchsuchen kann. Die Dokumente werden in hierarchischen Kategorien gruppiert, mit Projekten und Work Items verknüpft und dienen der KI als zusätzlicher Kontext.

Was ist ein Dokument

Ein Dokument ist eine in Markdown geschriebene Inhaltsseite. Es kann eine technische Spezifikation, ein Prozessleitfaden, Besprechungsnotizen, Architekturentscheidungen oder jedes Wissen sein, das dein Team teilen und nachschlagen muss.

Jedes Dokument gehört zu einer Kategorie und kann mit einem oder mehreren Projekten verknüpft sein.

Dokument erstellen

Klicke im Dokumentbereich auf Neues Dokument. Fülle die Felder aus:

FeldErforderlichBeschreibungBeispiel
TitelJaAussagekräftiger Name des Dokuments"Leitfaden für das Produktions-Deployment"
InhaltNeinText des Dokuments in MarkdownFormatierter Text, Listen, Tabellen usw.
KategorieNeinKategorie innerhalb des hierarchischen Baums"Technische Leitfäden > Infrastruktur"
ProjektNeinProjekt, mit dem das Dokument verknüpft wird"Mobile App v2"

Markdown-Editor

Der Editor unterstützt die vollständige Markdown-Syntax:

  • Überschriften (#, ##, ###)
  • Geordnete und ungeordnete Listen
  • Tabellen
  • Codeblöcke mit Syntaxhervorhebung
  • Fettdruck, Kursivschrift und andere Inline-Formate
  • Links und Bilder

Am unteren Rand des Editors wird ein Wortzähler angezeigt, um eine Referenz für den Umfang des Dokuments zu haben.

Hierarchische Kategorien

Dokumente werden in einem Kategorienbaum mit unbegrenzter Tiefe organisiert. So kannst du so detaillierte Strukturen erstellen, wie du benötigst:

Dokumentation
├── Technische Leitfäden
│ ├── Infrastruktur
│ ├── Datenbank
│ └── APIs
├── Prozesse
│ ├── Onboarding
│ └── Release-Management
├── Architekturentscheidungen
└── Besprechungsnotizen
├── Sprint-Reviews
└── Planung

Kategorie erstellen

  1. Klicke im seitlichen Dokumentbaum auf Neue Kategorie.
  2. Gib den Namen der Kategorie ein.
  3. Wähle optional eine übergeordnete Kategorie, um Unterkategorien zu erstellen.

Baumnavigation

Die linke Seitenleiste des Dokumentbereichs zeigt den vollständigen Kategorienbaum. Klicke auf eine Kategorie, um die darin enthaltenen Dokumente zu sehen. Kategorien mit Unterkategorien können ausgeklappt und eingeklappt werden.

Volltextsuche

Die Dokumentensuche ermöglicht es, Inhalte per Volltext zu finden. Sie durchsucht sowohl Titel als auch Dokumentinhalt und gibt die Ergebnisse nach Relevanz sortiert zurück.

Gib deine Abfrage in die Suchleiste des Dokumentbereichs ein, um die Liste in Echtzeit zu filtern.

Verknüpfung mit Work Items

Dokumente können bidirektional mit Work Items verknüpft werden. Das ist nützlich, um:

  • Eine technische Spezifikation der Story zuzuordnen, die sie umsetzt.
  • Eine Architekturentscheidung mit dem Epic zu verknüpfen, das sie ausgelöst hat.
  • Besprechungsnotizen mit den daraus entstandenen Aufgaben zu verbinden.

Vom Dokument aus verknüpfen

Suche in der Dokumentdetailansicht den Abschnitt Verknüpfte Work Items und füge die Work Items hinzu, die du zuordnen möchtest.

Vom Work Item aus verknüpfen

In der Detailansicht eines Work Items kannst du im entsprechenden Abschnitt vorhandene Dokumente verknüpfen.

Die Verknüpfung ist bidirektional: Wenn du ein Dokument mit einem Work Item verknüpfst, siehst du auch vom Work Item aus den Verweis auf das Dokument.

Anheften (pinning)

Du kannst wichtige Dokumente anheften, damit sie oben in der Liste hervorgehoben erscheinen. Das ist nützlich für häufig verwendete Referenzdokumente wie Styleguides, kritische Prozesse oder Onboarding-Dokumente.

Um ein Dokument anzuheften, verwende das Pin-Symbol in der Liste oder in der Dokumentdetailansicht.

Projektübergreifende Gruppierung

Dokumente können mehreren Projekten zugeordnet werden. Dadurch lässt sich projektübergreifende Dokumentation erstellen, die für mehrere Teams oder Initiativen gilt. Ein Dokument mit "Codestandards" kann beispielsweise allen Entwicklungsprojekten zugeordnet werden.

Versionsverlauf

Almirant speichert frühere Versionen jedes Dokuments automatisch. Jedes Mal, wenn du Änderungen speicherst, wird eine neue Version in S3 erstellt. Du kannst:

  • Den Versionsverlauf eines Dokuments ansehen.
  • Den Inhalt früherer Versionen einsehen.
  • Erkennen, wann und welche Änderungen vorgenommen wurden.

Dokumente als Kontext für KI

Dokumente aus der Wissensdatenbank können als zusätzlicher Kontext für über MCP verbundene KI-Agenten dienen. Wenn ein Agent eine Spezifikation, einen Prozess oder eine Architekturentscheidung verstehen muss, kann er die relevanten Projektdokumente abfragen.

Das ist besonders wirkungsvoll, wenn du Dokumente mit Work Items kombinierst: Die KI kann die technische Spezifikation lesen, die mit einem Work Item verknüpft ist, bevor sie es implementiert.

Für Entwickler

Dokumente sind über MCP verfügbar:

ToolBeschreibung
list_documentsListet Dokumente mit Filtern nach Projekt und Kategorie auf
list_document_categoriesListet die verfügbaren hierarchischen Kategorien auf

Die über MCP zugänglichen Dokumente ermöglichen einem KI-Agenten, die Wissensdatenbank des Teams abzufragen, um bei der Implementierung fundiertere Entscheidungen zu treffen. Vor der Implementierung eines Work Items kann der Agent beispielsweise nach relevanten technischen Spezifikationen oder Architekturentscheidungen suchen.


Verwandt: Projekte | Work Items