S'organiser! Comment créer un guide de style de base de connaissances

Écrire une base de connaissances est déjà assez difficile. Je m'excuse donc pour ce que je m'apprête à faire dans ce post. Je vais vous dire qu'il ne s'agit pas seulement des idées dans votre base de connaissances, mais aussi de la façon dont vous les présentez.

Voyez, au-delà de ces idées, vous devez vous assurer que vous êtes toujours :

• Utiliser le bon ton
• Formater systématiquement tout de la même manière

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

Pourquoi votre base de connaissances pourrait être un gâchis de styles différents

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

Tout d'abord, si vous faites partie d'une équipe, différentes personnes peuvent rédiger des documents d'assistance. Donc si:

• Jim écrit l'article A
• Sally écrit l'article B

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

Maintenant, 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 !

Et cela pourrait être le cas… si vous écriviez tous les articles de votre base de connaissances en une seule séance.

Mais nous savons tous les deux que ce n'est pas comme ça que les choses fonctionnent habituellement, n'est-ce pas ? Vous avez probablement écrit un tas d'articles de la base de connaissances lorsque vous avez publié votre produit pour la première fois.

Mais ensuite, trois mois plus tard, vous publiez une nouvelle fonctionnalité. Maintenant, vous devez écrire l'entrée de la base de connaissances pour cette nouvelle fonctionnalité et… les souvenirs humains ne sont pas si bons . 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.

Ainsi, que vous soyez seul ou en équipe, il est avantageux de mettre votre guide de style de base de connaissances sur papier.

Les entreprises font-elles réellement cela ? Un guide de style de base de connaissances est-il une vraie chose ?

Ok, je vais vous dire comment créer votre guide de style en une seconde. Mais d'abord, je veux donner quelques exemples d'entreprises qui le font réellement. Cela atteint deux objectifs :

• Cela vous montre que je ne fais pas qu'inventer 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.

Regardons d'abord Mozilla. Mozilla a une entrée entière sur le guide de style pour sa base de connaissances. Parce que Mozilla est open source, il est particulièrement essentiel pour eux d'avoir un guide de style pour, selon leurs propres mots, "rendre la base de connaissances de support Firefox cohérente, résultant en une base de connaissances facile à lire et à laquelle contribuer". Facile à lire? Cela semble être un bon objectif pour votre base de connaissances, non ?

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 axé à 100 % sur les bases de connaissances, il contient un certain nombre d'entrées pour le contenu de la base de connaissances et du didacticiel :

Alors que le guide de style de Mozilla est davantage axé sur le style et la mise en forme, MailChimp choisit de se concentrer davantage sur la voix et le ton que sur la mise en forme concrète.

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 donné de processus pour créer votre propre guide de style de base de connaissances. Alors réparons ça !

Utilisez une personne cohérente

Avez-vous déjà lu un article dans lequel l'auteur alterne entre « je » et « nous » ? J'ai, et nous pouvons vous dire que c'est extrêmement déroutant.

Donc, si vous utilisez la première personne, choisissez-en une et soyez cohérent. Même si vous êtes en solo, vous pouvez toujours choisir d'utiliser "nous". À toi de voir! Utilisez simplement le même.

De plus, vous n'avez même pas besoin d'utiliser la première personne. Vous pouvez choisir d'éviter complètement "je" et "nous".

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

Standardisez votre mise en forme

Si vous lisez notre guide de modèle d'article de base de connaissances ultime, vous savez que les bonnes bases de connaissances utilisent de nombreuses instructions avec de petites étapes. Et ces instructions incluront, à un moment donné, un langage tel que :

Cliquez sur Fichier .

Donc est-il:

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

Et quand vous écrivez réellement vos listes, est-ce :

• Étape 1 : Cliquez ici
• Étape 2 : Cliquez dessus

Ou c'est comme ça :

• Cliquez ici
• Cliquez dessus

Encore une fois - vous pouvez choisir celui que vous préférez - mais quel que soit celui que vous choisissez, utilisez-le de manière cohérente dans l'ensemble de votre base de connaissances.

Vous devez également faire d'autres choix de formatage - le guide de style 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 la phrase ou la casse du titre ?
• Chiffres - est-ce 10 ou dix ?
• Abréviations – pas ou pas ?
• Acronymes – CDN ou réseau de diffusion de contenu ?

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.

Obtenez la bonne voix

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

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

Dans des limites raisonnables, l'un ou l'autre est très bien. Tant que c'est cohérent.

En général, vous devez 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 celui-ci :

• Faites toujours votre première priorité pour répondre aux questions et 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ù stocker votre guide de style ?

Vous ne devriez pas simplement prendre ces décisions. Vous devez également, vous savez, les écrire dans un endroit sûr.

Personnellement, la plupart des guides de style avec lesquels je travaille 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 celle-ci :

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

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