Glossary

Une fonctionnalité ou un module additionnel pouvant être intégré à Archbee pour améliorer ses capacités, comme le AI Addon pour des fonctionnalités avancées d’IA.

Documentez vos points de terminaison API avec clarté, en fournissant les détails essentiels tant pour les développeurs que pour les utilisateurs.

Des blocs de construction pour vos documents. Pensez-y comme à des Legos pour votre contenu. Vous pouvez les utiliser pour créer des titres, des tableaux, des images, des extraits de code et plus encore. Il existe des blocs de base, des blocs multimédias, des blocs pour développeurs et des blocs intégrés.

Des boutons interactifs qui mènent à d’autres pages internes ou externes, guidant les utilisateurs à travers votre documentation ou votre contenu à l’extérieur de celle-ci.

Mettez en évidence des notes importantes, des conseils ou des avertissements à l’aide d’encadrés visuellement distincts afin d’attirer l’attention sur l’information clé.

Informez vos utilisateurs grâce à un bloc de journal des modifications qui documente les mises à jour et les changements apportés à votre projet.

Un éditeur de code multilingue permettant de présenter des extraits de code, idéal pour les développeurs.

Organisez vos extraits de code dans des tiroirs et affichez-les côte à côte avec votre contenu, afin de garder votre documentation ordonnée et conviviale.

Créez des blocs de contenu réutilisables pouvant être insérés dans plusieurs documents, assurant ainsi la cohérence et économisant du temps.

Votre espace de référence pour créer et modifier du contenu. C’est comme un espace de travail numérique où vous pouvez utiliser des raccourcis, ajouter différents types de blocs de contenu et formater votre texte à l’aide de Markdown ou du menu WYSIWYG. Vous pouvez même intégrer du contenu provenant d’autres outils et créer des liens vers d’autres documents. Considérez-le comme votre point de départ unique pour tout ce qui touche à la création de contenu!

Intégrez du contenu provenant d’outils populaires comme Loom, Figma et Miro directement dans votre documentation pour une expérience cohérente.

Sections pouvant être développées ou réduites, ce qui facilite la navigation dans des sujets complexes.

Téléversez et créez des liens vers des fichiers directement dans votre documentation, afin de rendre les ressources facilement accessibles aux utilisateurs.

Organisez et gérez tous vos fichiers dans un emplacement central, ce qui facilite le téléversement, l’accès et la création de liens vers des ressources dans votre documentation.

Documentez efficacement les APIs GraphQL, en fournissant aux utilisateurs l’information dont ils ont besoin pour interagir avec vos services.

Utilisés pour créer des titres et des sous-titres afin d’organiser le contenu de façon hiérarchique.

Les séparateurs horizontaux vous aident à créer des coupures visuelles entre des sections, améliorant ainsi le flux de votre documentation.

Enrichissez votre documentation avec des images, ajoutant un contexte visuel et renforçant l’engagement envers votre contenu

Créez des liens dynamiques vers d’autres documents ou des ressources externes, facilitant une navigation aisée dans votre contenu.

Utilisez des listes ordonnées et non ordonnées pour présenter l’information sous forme de points faciles à assimiler, améliorant ainsi la lisibilité.

Intégrez des cartes pour afficher de l’information basée sur la localisation, améliorant ainsi la pertinence de votre contenu.

Créez des organigrammes et des diagrammes à l’aide de la syntaxe Mermaid, ajoutant ainsi des éléments visuels à votre documentation.

Organisez des tâches en sous-tâches gérables avec Minitaskers, inspiré de Trello, pour garder vos projets sur la bonne voie.

Créez et gérez des blocs de contenu réutilisables pouvant être insérés dans plusieurs documents, assurant ainsi la cohérence et vous faisant gagner du temps dans l’ensemble de votre documentation.

Conteneurs pour des documents organisés par équipe ou par projet. Chaque compte possède un espace personnel, et les organisations peuvent en créer des personnalisés avec un contrôle d’accès.

Considérez-les comme des dossiers pour vos Espaces. Vous commencez avec un appelé « Espaces ». Créez d’autres dossiers si nécessaire. Vous pouvez ajouter, renommer ou supprimer des dossiers (mais seulement s’ils sont vides). Pour placer un Espace dans un dossier, glissez-le simplement, utilisez l’action de déplacement ou créez-le directement dans le dossier.

Reliez plusieurs Espaces publiés pour une navigation facile entre les documents (par exemple, guides d’utilisation, API docs). Ajoutez des liens dans les paramètres de l’Espace, étiquetez-les et publiez. Les modifications apportées aux liens se mettent automatiquement à jour dans les Espaces connectés.

Intégrez sans heurt des spécifications OpenAPI pour améliorer votre documentation API.

Utilisez un bloc tableau pour présenter les données de manière claire et organisée, idéal pour les comparaisons et l’information structurée.

Organisez le contenu en plusieurs onglets pour une navigation propre et efficace, permettant aux utilisateurs de passer facilement d’un sujet à l’autre.

Rendez des équations mathématiques complexes à l’aide de TeX, rendant votre documentation adaptée aux sujets techniques.

Sont comme des départements pour vos utilisateurs. Vous pouvez créer différents groupes (comme Ingénieurs, Marketing ou Direction) et y attribuer des utilisateurs. Cela vous aide à organiser vos utilisateurs et à leur accorder différents niveaux d’accès à différentes parties de votre organisation.

Présentez du contenu côte à côte avec le bloc de séparation verticale, idéal pour les comparaisons ou l’information connexe.

Intégrez des vidéos depuis Youtube et LoomLoom afin de fournir du contenu dynamique et des tutoriels directement dans votre documentation.

Visualisez des processus et des flux de travail avec ce bloc, aidant les utilisateurs à comprendre clairement les étapes et les séquences.

Un menu convivial « What You See Is What You Get » qui vous permet de formater votre contenu visuellement, rendant la création de documents intuitive et simple.