Guide de style de la base de connaissances : Conseils utiles et comment créer

Rédiger une base de connaissances est déjà assez difficile. Je m'excuse donc pour ce que je m'apprête à faire dans ce billet. Je vais vous dire qu'il ne s'agit pas seulement des idées contenues dans votre base de connaissances, mais aussi de la manière dont vous les présentez.

Au-delà de ces idées, il faut s'assurer que l'on est toujours dans la course :

• Utiliser le bon ton
• Formatage uniforme de tous les éléments

Ce qui, pour des raisons que j'éluciderai dans la section suivante, est en fait étonnamment difficile. C'est là que le guide de style d'une base de connaissances entre en jeu.

Pourquoi votre base de connaissances peut-elle être un mélange de styles différents ?

Ne vous inquiétez pas trop si votre base de connaissances est un amalgame de styles différents. Cela arrive à un grand nombre d'entreprises, généralement pour l'une des deux raisons suivantes (ou parfois les deux !).

Tout d'abord, si vous faites partie d'une équipe, il se peut que plusieurs personnes rédigent des documents d'assistance. Ainsi, si :

• Jim rédige l'article A
• Sally rédige l'article B

Ces articles auront probablement des styles et des mises en forme très différents... à moins que vous n'ayez mis en place un guide de style prédéfini.

Si vous ne faites pas partie d'une équipe, vous vous dites probablement : "Je suis un loup solitaire - j'écris tout moi-même. Je n'ai donc pas besoin de mettre quoi que ce soit sur papier - c'est tout moi !".

C'est peut-être le cas... si vous rédigez tous les articles de votre base de connaissances en une seule fois.

Mais nous savons tous les deux que ce n'est pas ainsi que les choses fonctionnent habituellement, n'est-ce pas ? Vous avez probablement rédigé un grand nombre d'articles dans la base de connaissances lorsque vous avez lancé votre produit.

Puis, trois mois plus tard, vous lancez une nouvelle fonctionnalité. Vous devez maintenant rédiger l'entrée de la base de connaissances pour cette nouvelle fonctionnalité et... lamémoire humaine n'est pas si bonne que cela. Il y a de fortes chances que vous finissiez par faire quelque chose de différent, même si vous n'essayez pas de le faire.

Que vous soyez seul ou que vous fassiez partie d'une équipe, il est donc utile de mettre sur papier votre guide de style pour la base de connaissances.

Les entreprises le font-elles vraiment ? Le guide de style d'une base de connaissances est-il une réalité ?

Ok, je vais vous expliquer comment créer votre guide de style dans une seconde. Mais d'abord, j'aimerais vous donner quelques exemples d'entreprises qui le font. Cela permet d'atteindre deux objectifs :

• Cela vous montre que je n'invente pas des choses pour créer plus de contenu de blog 😉 .
• Il vous donne un exemple concret dont vous pouvez vous inspirer pour votre propre guide de style.

Commençons par Mozilla. Mozilla a une entrée entière sur le guide de style pour leur base de connaissances. Mozilla étant un logiciel libre, il est particulièrement essentiel pour eux d'avoir un guide de style pour, selon leurs propres termes, "rendre la base de connaissances du support de Firefox cohérente, résultant en une base de connaissances qui est facile à lire et à laquelle on peut contribuer". Facile à lire ? Cela semble être un bon objectif pour votre base de connaissances, n'est-ce pas ?

Le guide va en profondeur, vous expliquant tout, des majuscules aux espaces blancs, en passant par les virgules en série.

Ensuite, Voice & Tone de MailChimp est une autre lecture intéressante. Bien qu'il ne soit pas centré à 100 % sur les bases de connaissances, il contient un certain nombre d'entrées pour le contenu des bases de connaissances et des didacticiels :

Alors que le guide de Mozilla est plus axé sur le style et la mise en forme, MailChimp choisit de se concentrer davantage sur la voix et le ton que sur les détails de la mise en forme.

Comment créer un guide de style pour votre base de connaissances ?

Je vous ai donné quelques exemples, mais je ne vous ai pas encore expliqué comment créer votre propre guide de style pour votre base de connaissances. Alors, corrigeons cela !

Utiliser une personne cohérente

Avez-vous déjà lu un article dans lequel l'auteur passait du "je" au "nous" ? Moi oui, et nous pouvons vous dire que c'est extrêmement déroutant.

Par conséquent, si vous devez utiliser la première personne, choisissez-en une et soyez cohérent. Même si vous êtes seul, vous pouvez opter pour le "nous". À vous de voir ! Utilisez simplement la même personne.

En outre, il n'est même pas nécessaire d'utiliser la première personne. Vous pouvez choisir de ne pas utiliser les mots "je" et "nous".

Il n'y a pas vraiment de bonne réponse ici - c'est juste une question de cohérence.

Uniformisez votre formatage

Si vous avez lu notre guide du modèle ultime d'article de base de connaissances, vous savez que les bonnes bases de connaissances utilisent beaucoup d'instructions avec de petites étapes. Et ces instructions incluront, à un moment ou à un autre, des termes tels que :

Cliquez sur Fichier.

C'est donc le cas :

• Cliquez sur Fichier
• Cliquez sur "Fichier"
• Cliquez sur Fichier

Et lorsque vous rédigez vos listes, c'est le cas :

• Étape 1 : Cliquez sur ce lien
• Étape 2 : Cliquez sur ce lien

Ou bien est-ce ainsi :

• Cliquez ici
• Cliquez sur ce lien

Là encore, vous pouvez choisir celui qui vous convient le mieux, mais quel que soit votre choix, utilisez-le de manière cohérente dans l'ensemble de votre base de connaissances.

Le guide de style de Mozilla vous donne une bonne idée de tout ce qu'il faut couvrir, mais voici quelques idées de départ :

• Capitalisation des titres - utiliserez-vous la casse de phrase ou la casse de titre ?
• Nombres - est-ce 10 ou dix ?
• Abréviations - ne pas ou ne pas ?
• Acronymes - CDN ou content delivery network ?

Si vous utilisez l'un de nos thèmes ou plugins WordPress de base de connaissances, nos shortcodes intégrés et nos options de formatage peuvent vous aider à rester cohérent en matière de formatage.

Une voix juste

Enfin, vous devez aller au-delà du formatage et normaliser votre voix.

Êtes-vous l'ami de votre client ? Ou êtes-vous Spock de Star Trek, dispensant sans passion une sagesse froide et dure ?

Dans les limites du raisonnable, l'un ou l'autre est acceptable. Tant que c'est cohérent.

En général, vous devriez vous assurer de suivre les conseils du guide de la base de connaissances de MailChimp. Je les suggère non seulement parce que MailChimp a publié son guide, mais aussi parce que je pense que MailChimp possède l'une des meilleures bases de connaissances.

Leur conseil est le suivant :

• Votre première priorité est toujours de répondre aux questions et d'informer vos lecteurs. Les blagues sont parfois acceptables, mais pas si elles détournent l'attention de cet objectif essentiel.
• Évitez de parler comme un spécialiste du marketing - vous essayez simplement d'aider.

Où ranger votre guide de style ?

Vous ne devez pas vous contenter de prendre ces décisions. Il faut aussi les écrire dans un endroit sûr.

Personnellement, la plupart des guides de style que j'utilise sont des documents Google Docs. De cette façon, vous pouvez facilement partager votre guide de style et y accéder à partir de différents ordinateurs.

Mais si vous préférez une autre méthode, optez pour celle qui vous est familière. La seule chose vraiment importante est la suivante :

Vous avez une copie du guide de style de votre base de connaissances dans un endroit sûr où vous, ou d'autres, pouvez y accéder lorsque vous avez besoin d'une mise à jour sur la façon de formater votre base de connaissances.

Alors, mettez-les sur papier et commencez à créer des articles de base de connaissances plus cohérents !