Pour la mise en œuvre
La documentation doit aider les équipes à comprendre l'ordre de configuration, la structure des données, l'accès des acheteurs et les routines opérationnelles au quotidien.
Documentation
Documentation BrandGate pour les équipes et les développeurs
Documentation de référence pour la prise en main, les produits, les distributeurs, les commandes, la facturation, les boutiques, le traitement des commandes, les intégrations et les flux de travail des développeurs.
Pour la passation technique
Les notes destinées aux développeurs couvrent l'API, les intégrations, les exports et la planification d'un déploiement sécurisé.
Prise en main
Configuration de l'entreprise, accès de l'équipe, import de produits, invitations de distributeurs et flux de la première commande.
Opérations
Produits, commandes, factures, traitement des commandes, rapports, paramètres et flux de travail auditables.
Boutique
Éditeur de boutique, identité visuelle, pages, publication, boutique en ligne, paiement et espaces de compte acheteur.
Notes pour les développeurs
Concepts d'API, intégrations, exports, flux de type webhook et planification de la mise en œuvre.
Documentation
La documentation doit répondre à la question : que faire ensuite ?
Une page de documentation claire allège la charge du support et donne au produit un aspect plus abouti.
Séquence de configuration
Les équipes doivent savoir quelle configuration effectuer en premier.
Contexte par rôle
Les tâches d'administrateur, d'acheteur, de finance, de traitement des commandes et de développeur doivent être clairement identifiables.
Tests en toute sécurité
La documentation doit indiquer aux utilisateurs quand une action peut affecter de vrais acheteurs ou des systèmes externes.
Dépannage
Les états vides, de déconnexion et de validation courants nécessitent des conseils pratiques.
Documentation
Carte de la documentation
Commencez par la prise en main, puis passez à la zone que vous configurez ou testez.
01
Configurer l'espace de travail
Entreprise, équipe, catalogue de produits, accès des distributeurs et paramètres de la boutique.
02
Exécuter les flux de travail
Commandes, factures, rapports, traitement des commandes, paiement des acheteurs et publication de la boutique.
03
Connecter les systèmes
Paiements, comptabilité, domaines, API, exports et escalade du support.
Documentation pour publics variés
La documentation BrandGate doit être utile aux opérateurs et aux développeurs.
Utilisateurs métier
Instructions claires pour les flux de travail produit visibles.
Administrateurs
Conseils sur la configuration, les permissions et les paramètres.
Développeurs
Concepts d'intégration et bonnes pratiques d'implémentation.
Questions sur la documentation
La documentation est-elle disponible en suédois ?
Les routes de documentation publique sont préparées pour le suédois et l'anglais via la structure i18n locale.
Où puis-je trouver les détails de l'API ?
Commencez par la page API, puis contactez BrandGate pour un accès ou la planification d'une intégration sur mesure.
La documentation peut-elle couvrir mon flux de travail spécifique ?
Contactez-nous avec votre flux de travail et nous identifierons le support ou le parcours de documentation adapté.
Besoin d'aide pour trouver la bonne documentation ?
Indiquez-nous le flux de travail que vous configurez et nous vous orienterons vers la bonne ressource.
Contacter le support