Base de connaissances
Les agents IA sont aussi performants que le contexte que vous leur fournissez. La base de connaissances stocke les décisions d'architecture, les spécifications d'API et la connaissance métier que les agents consultent pendant l'implémentation. Sans ce contexte documenté, les agents devinent. Avec lui, ils prennent des décisions éclairées fondées sur votre réalité.
La base de connaissances d'Almirant est un système de documentation intégré dans lequel votre équipe peut créer, organiser et rechercher des documents au format Markdown. Les documents sont regroupés dans des catégories hiérarchiques, liés à des projets et des work items, et servent de contexte supplémentaire à l'IA.
Qu'est-ce qu'un document ?
Un document est une page de contenu écrite en Markdown. Il peut s'agir d'une spécification technique, d'un guide de processus, de notes de réunion, de décisions d'architecture ou de toute connaissance que votre équipe doit partager et consulter.
Chaque document appartient à une catégorie et peut être lié à un ou plusieurs projets.
Créer un document
Cliquez sur New document depuis la section Documents. Remplissez les champs :
| Champ | Obligatoire | Description | Exemple |
|---|---|---|---|
| Titre | Oui | Nom descriptif du document | « Guide de déploiement en production » |
| Contenu | Non | Corps du document en Markdown | Texte formaté, listes, tableaux, etc. |
| Catégorie | Non | Catégorie dans l'arborescence hiérarchique | « Guides techniques > Infrastructure » |
| Projet | Non | Projet auquel le document est lié | « App Mobile v2 » |
Éditeur Markdown
L'éditeur prend en charge la syntaxe Markdown complète :
- Les titres (
#,##,###) - Les listes ordonnées et non ordonnées
- Les tableaux
- Les blocs de code avec coloration syntaxique
- Le gras, l'italique et les autres formats inline
- Les liens et les images
Un compteur de mots est affiché en bas de l'éditeur pour indiquer la taille du document.
Catégories hiérarchiques
Les documents sont organisés dans une arborescence de catégories de profondeur illimitée. Vous pouvez ainsi créer des structures aussi détaillées que nécessaire :
Documentation
├── Guides techniques
│ ├── Infrastructure
│ ├── Base de données
│ └── APIs
├── Processus
│ ├── Onboarding
│ └── Release management
├── Décisions d'architecture
└── Notes de réunion
├── Sprint reviews
└── Planification
Créer une catégorie
- Dans l'arborescence latérale des documents, cliquez sur New category.
- Saisissez le nom de la catégorie.
- Facultativement, sélectionnez une catégorie parente pour créer des sous-catégories.
Navigation dans l'arborescence
La barre latérale gauche de la section Documents affiche l'arborescence complète des catégories. Cliquez sur une catégorie pour voir les documents qu'elle contient. Les catégories avec des sous-catégories peuvent être développées et réduites.
Recherche full-text
La recherche de documents permet de trouver du contenu par texte intégral. Elle recherche à la fois dans le titre et le corps du document, puis renvoie les résultats classés par pertinence.
Saisissez votre requête dans la barre de recherche de la section Documents afin de filtrer la liste en temps réel.
Liaison avec les work items
Les documents peuvent être liés de façon bidirectionnelle aux work items. Cela est utile pour :
- Associer une spécification technique à la story qui l'implémente.
- Lier une décision d'architecture à l'epic qui l'a motivée.
- Connecter des notes de réunion aux tâches qui en sont issues.
Lier depuis le document
Dans le détail du document, recherchez la section Linked work items et ajoutez les work items que vous souhaitez associer.
Lier depuis le work item
Depuis le détail d'un work item, vous pouvez lier des documents existants dans la section correspondante.
La liaison est bidirectionnelle : si vous liez un document à un work item, vous verrez aussi la référence au document depuis le work item.
Épinglage (pinning)
Vous pouvez épingler les documents importants afin qu'ils apparaissent en évidence en haut de la liste. Cela est utile pour les documents fréquemment consultés, tels que les guides de style, processus critiques ou documents d'onboarding.
Pour épingler un document, utilisez l'icône d'épingle dans la liste ou dans le détail du document.
Regroupement cross-project
Les documents peuvent être liés à plusieurs projets, ce qui permet de créer une documentation transversale applicable à plusieurs équipes ou initiatives. Par exemple, un document « Standards de code » peut être lié à tous les projets de développement.
Historique des versions
Almirant enregistre automatiquement les versions précédentes de chaque document. Chaque fois que vous enregistrez des modifications, une nouvelle version est créée et stockée dans S3. Vous pouvez :
- Consulter l'historique des versions d'un document.
- Voir le contenu des versions précédentes.
- Identifier quand et quelles modifications ont été effectuées.
Documents comme contexte pour l'IA
Les documents de la base de connaissances peuvent servir de contexte supplémentaire aux agents IA connectés via MCP. Lorsqu'un agent doit comprendre une spécification, un processus ou une décision d'architecture, il peut consulter les documents pertinents du projet.
Cela est particulièrement utile lorsque vous combinez des documents avec des work items : l'IA peut lire la spécification technique liée à un work item avant de l'implémenter.
Les documents sont disponibles via MCP :
| Tool | Description |
|---|---|
list_documents | Liste les documents avec des filtres par projet et catégorie |
list_document_categories | Liste les catégories hiérarchiques disponibles |
Les documents accessibles via MCP permettent à un agent IA de consulter la base de connaissances de l'équipe afin de prendre des décisions plus éclairées pendant l'implémentation. Par exemple, avant d'implémenter un work item, l'agent peut rechercher des spécifications techniques ou décisions d'architecture pertinentes.
Associé : Projets | Work Items