Documentation externe : comment publier et partager vos docs

Vous avez passé des semaines à créer et organiser la documentation interne de votre entreprise. Vous devez maintenant en partager une partie avec des clients, des partenaires et des prestataires.

Mais vous êtes coincé avec trois options loin d'être idéales :

1. Exporter les documents en PDF. Sauf que lorsque les instructions changent, vous devez envoyer de nouveaux fichiers alors que les anciennes copies continuent de circuler.
2. Créer une base de connaissances séparée pour les utilisateurs externes. Le problème, c'est que les modifications de vos guides internes doivent être reportées sur leurs copies externes. Oubliez une mise à jour, et les lecteurs risquent de suivre des instructions que votre équipe a déjà remplacées.
3. Donner aux utilisateurs externes accès à votre base de connaissances interne. Mais sans permissions soigneusement délimitées, un prestataire travaillant sur un projet pourrait voir des informations confidentielles ou des documents destinés à un autre.

Il existe pourtant une quatrième voie, meilleure, pour créer une documentation externe : publier des pages sélectionnées de votre base de connaissances existante tout en gardant les documents internes privés.

Nous allons voir quoi publier, comment gérer l'accès pour différents publics et comment garder votre documentation externe à jour.

Points clés

• La documentation externe ne doit exposer que les parties de vos connaissances existantes dont les clients, partenaires ou prestataires ont besoin.
• Les pages publiques conviennent aux guides largement utiles, mais désactiver l'indexation par les moteurs de recherche ne limite pas qui peut ouvrir un lien public.
• Les prestataires et partenaires ne doivent avoir accès qu'aux documents ou canaux nécessaires à leur travail, avec des droits d'édition accordés séparément.
• Publier à partir d'un document maintenu garde les instructions externes alignées sur les mises à jour faites par votre équipe interne.
• Avant de partager un document, vérifiez les fichiers liés, les pages imbriquées, les paramètres de recherche et ce qu'un lecteur non connecté peut réellement ouvrir.
• Utilisez un logiciel dédié quand votre documentation externe a besoin de flux de tickets de support, de références API versionnées ou de tests d'API interactifs.

Qu'est-ce que la documentation externe ?

La documentation externe (ou documentation destinée au public) désigne tout ce qu'une entreprise met à disposition des personnes extérieures à son organisation, des guides aux instructions et documents de référence, y compris pour les prospects, clients, partenaires et prestataires.

Elle permet le self-service : les lecteurs peuvent évaluer un produit, accomplir des tâches ou suivre des procédures sans contacter le personnel pour chaque réponse.

Exemples courants :

• Guides d'onboarding client et instructions de dépannage qui aident les gens à démarrer et à résoudre les problèmes.
• Manuels produit et documentation utilisateur qui expliquent les fonctionnalités, les paramètres et les flux de travail.
• Références API et guides d'intégration que les développeurs peuvent utiliser pour évaluer ou connecter un produit.
• Ressources pour partenaires et prestataires qui expliquent comment réaliser un travail avec votre entreprise.

Comment publier une documentation externe

Un guide produit destiné aux clients, par exemple, peut nécessiter des paramètres de partage différents de ceux d'un brief de projet destiné à un prestataire.

Avant de publier quoi que ce soit, vous devez établir ce que chaque public doit pouvoir voir.

Décidez ce qui doit être public et ce qui doit rester interne

Passez en revue vos documents existants et identifiez les instructions dont un lecteur externe a réellement besoin. Un client qui configure un compte a besoin des étapes et des captures d'écran de cette tâche, mais pas de votre processus d'escalade, de vos notes de compte privées ni de vos plans pour des fonctionnalités non publiées, même si tous ces détails se trouvent dans le même guide interne.

En relisant le contenu, classez-le en trois groupes :

• Public : instructions sur les produits sortis, guides de dépannage généraux et exigences d'intégration publiques qui ne contiennent aucune information restreinte.
• Interne (à revoir) : documentation de processus internes qui mêle des étapes destinées aux clients et des notes réservées aux employés. Retirez les informations internes ou préparez une version publique séparée et approuvée.
• Confidentiel ou restreint : identifiants, données clients identifiables, conditions commerciales confidentielles, fonctionnalités non publiées et décisions internes que les lecteurs extérieurs à l'entreprise ne sont pas autorisés à voir.

Vérifiez aussi les captures d'écran, pièces jointes, liens et sous-documents. Une page peut ne contenir aucun texte confidentiel mais renvoyer vers un fichier qui n'a jamais été destiné à des lecteurs externes.

Associez chaque public au bon niveau d'accès

Une fois que vous avez décidé ce qui peut être partagé, choisissez qui doit pouvoir ouvrir chaque document.

Toute personne disposant du lien doit-elle y accéder, ou les lecteurs doivent-ils se connecter ? Lisent-ils simplement des instructions, ou doivent-ils commenter ou modifier ? Ces réponses déterminent l'option de partage à utiliser.

À ce stade, vous pouvez aussi appliquer le principe du moindre privilège : dans Slite, par exemple, vous pouvez donner aux prestataires et partenaires accès uniquement aux documents dont ils ont besoin, et n'attribuer des droits Rédacteur que lorsqu'ils doivent modifier. Révoquez l'accès quand un projet se termine ou que les responsabilités changent. Vérifiez périodiquement les liens publics et qui est autorisé à les publier.

Publiez depuis une source unique pour que la version externe reste à jour

Quand votre équipe met à jour les instructions de configuration d'un compte, ces changements doivent aussi apparaître dans la documentation que voient les clients. Sinon, les clients risquent de continuer à suivre des étapes obsolètes dans un PDF ou un article de centre d'aide.

Pour l'éviter, publiez directement depuis le document que votre équipe maintient et partagez un lien vivant avec les clients. Ainsi, les mises à jour du document source se reflètent dans la version publiée sans avoir à mettre à jour plusieurs copies.

Par exemple, dans Slite, vous pouvez le faire avec l'option Share to web. Quand vous mettez à jour le document d'origine, la page publiée reflète ces changements, et les clients qui ouvrent le lien voient les dernières instructions. En revanche, les PDF ou captures d'écran qu'ils ont enregistrés ne se mettront pas à jour automatiquement.

Nous utilisons la même approche pour le centre d'aide de Slite. Notre équipe rédige et maintient les articles d'aide dans Slite, puis les publie sur notre site.

Les modifications de la source peuvent devenir visibles immédiatement sur la page publique. Pour les changements à fort impact, nous recommandons un processus de relecture :

• Préparez les instructions révisées dans un brouillon privé si les changements concernent la sécurité, la facturation, la configuration du compte ou un autre flux à fort impact.
• Faites relire et approuver les changements par le propriétaire du document concerné avant de mettre à jour le document partagé publiquement.
• Relisez les documents qui changent souvent selon un calendrier, même si personne n'a signalé d'erreur.

Pour la maintenance au quotidien, Slite Agent peut aider votre équipe à repérer les informations obsolètes en confrontant la documentation aux sources connectées et en signalant les inexactitudes potentielles. Les propriétaires de documents peuvent ensuite examiner ses conclusions et approuver les changements suggérés avant de mettre à jour les instructions publiées.

Configurez et vérifiez l'accès externe

Une fois que vous avez décidé quoi publier et qui doit le voir, configurez les paramètres de partage dans votre plateforme de documentation. Selon l'outil, vous pourrez partager un lien public ou inviter des personnes précises, avec des contrôles séparés pour l'édition, les pages imbriquées et la visibilité dans la recherche. Pour un site de documentation externe à votre marque, vérifiez aussi si la plateforme prend en charge un domaine personnalisé et le branding de l'espace de travail.

Par exemple, dans Slite, ouvrez le document et sélectionnez Share. Vous pouvez inviter des clients, partenaires ou prestataires précis à collaborer, ou utiliser Share to web pour le publier publiquement. Si vous choisissez l'option publique, vérifiez ces paramètres avant de copier le lien :

• Qui peut y accéder : sous Anyone with the link, choisissez si les visiteurs peuvent voir ou modifier la page. L'accès en lecture seule convient généralement aux instructions publiées. Désactiver l'indexation par les moteurs de recherche ne rend pas le lien privé, utilisez donc des invitations quand l'accès doit être restreint.
• Ce qui est inclus : vérifiez Include sub-docs, car l'activer rend aussi les pages imbriquées accessibles via la page publique. Relisez ces pages avant de l'activer.
• Comment les visiteurs trouvent des réponses : activez Search engine indexing si vous voulez que les moteurs de recherche découvrent la page. Vous pouvez aussi activer la recherche assistée par IA (Ask) pour que les visiteurs puissent poser des questions sur la documentation publiée sans accéder aux documents privés de l'espace de travail.
• Si les visiteurs peuvent dupliquer la page : Show duplication button contrôle si les visiteurs peuvent copier le document dans leur propre compte Slite.

Avant de partager le document, vérifiez l'expérience depuis l'extérieur de votre espace de travail. Pour une page publique, ouvrez le lien dans une fenêtre de navigateur non connectée ; pour des collaborateurs invités, confirmez ce que leur compte peut ouvrir :

• Lisez-le comme un visiteur externe : assurez-vous que les instructions ont du sens sans accès à votre espace de travail interne, et testez les liens vers les pièces jointes et les pages associées.
• Vérifiez ce qui est accessible : confirmez que seuls les sous-documents et fichiers approuvés sont disponibles, et que les lecteurs ne sont pas renvoyés vers du contenu interne qu'ils ne peuvent pas ouvrir.
• Testez les fonctionnalités optionnelles : si Ask public est activé, essayez une question client typique et vérifiez la réponse. Confirmez aussi que le bouton de duplication apparaît ou reste masqué comme prévu.

Répétez ces vérifications quand les permissions changent, quand vous ajoutez des sous-documents ou quand vous faites des mises à jour importantes des instructions publiques. Dans Slite, les administrateurs de l'espace de travail peuvent aussi auditer quelles pages sont partagées publiquement et qui est autorisé à les publier.

Quand avez-vous besoin d'un logiciel spécialisé de documentation externe ?

Pour la plupart des guides clients et ressources partenaires, votre base de connaissances existante peut suffire. Mais selon ce que vous publiez et la façon dont les lecteurs doivent l'utiliser, vous pouvez avoir besoin d'outils supplémentaires. Parmi eux :

Logiciel de help desk

Il arrive qu'un client suive un guide de dépannage sans parvenir à résoudre son problème. Il doit alors ouvrir un ticket de support et joindre un agent.

En général, un logiciel de help desk gère la réception, le routage et l'escalade des tickets. Certains outils prennent aussi en charge la déviation des tickets en suggérant des articles utiles avant qu'un client n'envoie sa demande.

Par exemple, Zendesk peut suggérer des articles pertinents d'une base de connaissances pour le service client avant qu'une personne n'ouvre un ticket, tandis qu'Intercom peut recueillir des retours sur les articles pour aider votre équipe à repérer les instructions qui ne répondent pas aux questions des lecteurs.

Avec Slite, votre base de connaissances interne peut aussi soutenir ce flux de travail. Si votre équipe utilise Intercom ou Zendesk, l'extension Chrome de Slite Agent permet aux agents de support d'accéder aux connaissances internes pertinentes pendant qu'ils traitent les demandes des clients. Elle s'appuie sur le contexte de la conversation ou du ticket et sur les sources de connaissances connectées pour suggérer une réponse que les agents peuvent relire avant de l'envoyer.

Logiciel de documentation API versionnée

Les éditeurs de logiciels prennent souvent en charge plusieurs versions d'API en même temps, car tous les clients ne peuvent pas migrer dès qu'une nouvelle version sort. Quelqu'un qui utilise encore une version plus ancienne a besoin d'instructions correspondant à son intégration, même après la sortie de la dernière version.

Un logiciel spécialisé de documentation API peut aider les équipes avec :

• Références versionnées : maintenir la documentation des différentes versions d'API prises en charge.
• Documentation générée depuis OpenAPI : générer des références API à partir des spécifications et les garder alignées sur les évolutions de l'API.
• Bacs à sable API interactifs : permettre aux développeurs de tester des requêtes et d'inspecter les réponses directement depuis la documentation.

Par exemple, chez Slite, nous utilisons Mintlify pour notre référence API, parce qu'il est conçu pour la documentation versionnée destinée aux développeurs.

Portails de documentation pour clients et partenaires

Si votre entreprise travaille avec des dizaines de clients ou de partenaires, chacun avec ses propres guides d'onboarding, instructions de mise en œuvre et documentation de projet, gérer l'accès par invitations individuelles finira par devenir difficile à mesure que les organisations et les utilisateurs s'ajoutent.

Un portail de documentation dédié aux clients ou aux partenaires vous aide à gérer l'accès à grande échelle grâce à l'authentification unique, aux permissions par groupe et à des contrôles qui déterminent quelles ressources chaque organisation peut voir. Chaque client ou partenaire accède ensuite à la documentation qui lui est destinée sans voir les informations d'une autre organisation.

Faites de la documentation externe un prolongement de votre base de connaissances

Vous pouvez partager une documentation utile sans créer un autre jeu de fichiers que votre équipe devra mettre à jour à chaque changement de produit ou de processus. Partez des connaissances que vous maintenez déjà, puis choisissez quelles informations chaque public doit pouvoir voir.

Avec Slite, vous pouvez :

• Publier sur le web des documents sélectionnés de l'espace de travail, avec des contrôles séparés pour l'indexation, les sous-documents inclus et la duplication.
• Inviter des clients, partenaires ou prestataires sur des documents ou canaux précis, avec des droits Lecteur ou Rédacteur.
• Garder les lecteurs externes sur la version actuelle à mesure que votre équipe met à jour un document partagé, sans distribuer un nouveau fichier à chaque fois.
• Attribuer des propriétaires de documents, planifier des vérifications et utiliser Slite Agent pour enquêter sur les informations obsolètes ou contradictoires en vue d'une relecture humaine.
• Proposer une recherche assistée par IA sur le contenu que vous choisissez de publier pour les lecteurs externes.

Si vous prévoyez de partager des guides produit, des supports d'onboarding ou de la documentation partenaire, réservez une démo. Nous vous montrerons comment publier les bons documents, gérer l'accès externe et garder les informations à jour.

FAQ

Que signifie « destiné au public » en documentation ?

La documentation externe, ou destinée au public, est l'information mise à disposition des personnes extérieures à une organisation. Elle peut être ouverte à tous ou partagée uniquement avec des lecteurs externes désignés.

Que sont les documents destinés aux clients ?

Les documents destinés aux clients comprennent les guides d'onboarding, les instructions produit, les références d'intégration, les FAQ et les articles de dépannage qui aident les clients à évaluer, configurer et utiliser un produit.

Les pages de documentation externe ont-elles besoin d'un domaine personnalisé ?

Non. Les documents publics peuvent utiliser l'URL par défaut fournie par la plateforme de documentation. Un domaine personnalisé est optionnel, et Slite le prend en charge sur les forfaits éligibles, avec des options de branding pour les pages publiques.

Les outils d'IA et les moteurs de recherche peuvent-ils utiliser la documentation externe ?

Ils peuvent le faire, selon les paramètres publics du document et le comportement de chaque robot ou outil. Slite dispose de contrôles séparés pour l'indexation par les moteurs de recherche et la recherche assistée par IA sur les documents publics. Ses réponses IA publiques s'appuient sur le contenu publié pour les lecteurs externes.