Glossaire

Une fonctionnalité ou un module supplémentaire pouvant être intégré dans Archbee pour en améliorer les capacités, comme l’AI Addon pour des fonctionnalités d’IA avancées.

Documentez vos points de terminaison API avec clarté, en fournissant les informations essentielles aux développeurs et aux 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, tableaux, images, extraits de code et plus encore. Il existe des blocs de base, média, développeur et intégrés.

Des boutons interactifs qui renvoient vers d’autres pages internes ou externes, guidant les utilisateurs à travers votre documentation ou votre contenu externe.

Mettez en avant des notes importantes, des conseils ou des avertissements grâce à des encadrés visuellement distincts pour attirer l’attention sur les informations clés.

Tenez vos utilisateurs informés grâce à un bloc Changelog qui documente les mises à jour et les modifications de votre projet.

Un éditeur de code multi-langage pour 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, garantissant la cohérence tout en é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 en utilisant Markdown ou le 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 guichet unique pour tout ce qui concerne 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, facilitant la navigation dans des sujets complexes.

Téléversez et liez des fichiers directement dans votre documentation, rendant les ressources facilement accessibles pour les utilisateurs.

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

Documentez efficacement les APIs GraphQL, en fournissant aux utilisateurs les informations 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 hiérarchiquement.

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

Enrichissez votre documentation avec des images, ajoutant un contexte visuel et un meilleur engagement à votre contenu

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

Utilisez des listes ordonnées et non ordonnées pour décomposer l’information en points digestes, améliorant ainsi la lisibilité.

Intégrez des cartes pour afficher des informations basées sur l’emplacement, renforçant la pertinence de votre contenu.

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

Organisez des tâches en sous-tâches gérables avec Minitaskers, inspiré par Trello, pour maintenir 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, garantissant la cohérence et faisant gagner du temps dans l’ensemble de votre documentation.

Conteneurs pour des documents organisés par équipes ou projets. Chaque compte dispose d’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 davantage de dossiers si vous en avez besoin. Vous pouvez ajouter, renommer ou supprimer des dossiers (mais uniquement lorsqu’ils sont vides). Pour placer un Espace dans un dossier, faites-le simplement glisser, utilisez l’action de déplacement ou créez-le directement dans le dossier.

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

Intégrez de manière transparente des spécifications OpenAPI pour améliorer votre documentation API.

Utilisez le bloc tableau pour présenter des données de manière claire et organisée, idéal pour des comparaisons et des informations structurées.

Organisez le contenu en plusieurs onglets pour une navigation propre et efficace, permettant aux utilisateurs de basculer facilement entre différents sujets.

Affichez 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énierie, Marketing ou Gestion) et leur attribuer des utilisateurs. Cela vous aide à organiser vos utilisateurs et à leur donner différents niveaux d’accès aux différentes parties de votre organisation.

Présentez du contenu côte à côte avec le bloc de fractionnement vertical, idéal pour des comparaisons ou des informations liées.

Intégrez des vidéos depuis Youtube  et la plateforme LoomLoom pour fournir du contenu dynamique et des tutoriels directement au sein de votre documentation.

Visualisez des processus et des workflows 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.