• Articles
• admin

Alrighty! Qui est ravi de parler des manuels d’utilisation?

Écoute, j’ai compris. Mais si vous êtes comme moi, vous convenez que la documentation des systèmes process & est essentielle pour tout organisme à but non lucratif. C’est juste une question de trouver le temps de le faire.

Et pourquoi ne le ferions-nous pas ? La documentation nous fait gagner du temps à long terme. Cela nous évite les réunions inutiles & de dépannage, en permettant au personnel de trouver ses propres réponses.

Sans oublier, c’est une sacrée bonne compétence à avoir. Et c’est crucial pour soutenir votre travail, si vous & votre organisation se sépare.

Essayez de réserver du temps pour ce faire. Les étapes ci-dessous devraient aider à rendre cela aussi indolore que possible – et sinon, il y a un « cadeau » vers la fin que vous voudrez saisir.

Commencez par un contour.

Avant de taper les procédures et les définitions, considérez la structure de votre document. Quels sont les sujets qui seront faciles à suivre pour le personnel? Et quelle structure sera facile à mettre à jour avec le temps?

Spoiler : cela devient votre Table des matières !

Pour example…my le manuel Salesforce de l’équipe est divisé principalement par des objets. Mais selon votre configuration, diviser les sujets par département ou fonction peut avoir plus de sens.

Commencez large. Puis, étroit.

Votre manuel doit contenir des détails spécifiques et des instructions étape par étape. En gros, toutes les choses que nos collègues oublient sans cesse.

Mais une bonne documentation donnera également une vue d’ensemble utile de l’organisation de votre système & pourquoi. Gardez cela à l’esprit lorsque vous planifiez votre plan à l’étape 1.

p.s. Je recommande fortement de schématiser votre modèle de données. Vous pouvez utiliser un outil gratuit comme Google Drawings, ou créer quelque chose dans un document Word ou Powerpoint (en utilisant des formes & lignes). Pas besoin d’être chic!

Définissez toutes vos données.

Chaque actif technologique de votre base de données est la manifestation d’une « chose » réelle : qu’il s’agisse d’une personne (donateurs, bénévoles, etc.), d’une transaction (don, subvention, etc..), ou de partenariat (exécution du programme).

Une bonne documentation comblera le fossé entre le réel et le technique, en définissant ce que vos champs d’objets & représentent dans le monde réel.

Méta, je sais.

Informez vos utilisateurs.

Votre manuel d’utilisation doit faire deux choses: définir et instruire.

Si le personnel a besoin d’effectuer des tâches dans votre base de données – saisie des données, mises à jour des données, même recherche – aidez-les en incluant des instructions étape par étape pour ces choses.

Astuce: Les listes numérotées & les phrases courtes sont votre ami ici.

Écrivez tout une fois. Puis coupez, à plusieurs reprises.

Nous connaissons tous la douleur de lire un manuel long, verbeux et étouffé de texte. Épargnez vos collègues. Sortez ce premier brouillon et prévoyez de passer beaucoup de temps à le réduire.

Pourquoi? Parce que moins c’est plus. Et il faut du temps pour rassembler une documentation complète et efficace, tout en restant concise.

p.s. Je ne dis pas de couper les choses par souci de concision. Je dis que la documentation concise est un art – un art qui n’atterrit pas du premier coup.

Utilisez des espaces blancs.

Pensez à cela en termes d’UX (expérience utilisateur). De la même manière que vous vous souciez de la convivialité de votre base de données, vous souhaitez également que votre manuel soit facile à parcourir.

Plus il y a d’espace blanc – l’espacement entre / autour de votre texte – mieux c’est. Considérez également la taille de la police, la hauteur de la ligne et l’espacement des balles.

Utilisez uniquement des captures d’écran là où vous devez le faire.

Les captures d’écran sont fantastiques. Pourquoi expliquer quelque chose à quelqu’un quand vous pouvez lui montrer aussi?

Mais je pense personnellement qu’ils sont un peu un piège. Au moins en ce qui concerne la documentation.

Pensez-y. Si quelque chose change dans l’interface de votre système, vous devrez récupérer et remplacer ces images. Ils peuvent également détourner l’attention de vos instructions écrites, surtout si vous vous laissez emporter.

C’est pourquoi je les utilise principalement pour mettre en évidence quelque chose que mes utilisateurs pourraient manquer autrement.

🌟 Encore une chose qui pourrait aider ….

Maintenant que nous avons nos pas, il est temps de commencer à construire! Pour vous aider, j’ai créé un modèle de manuel d’utilisation que je partage avec tous ceux qui le souhaitent – pour Microsoft Word ou Google Docs!

Tout ce dont vous avez besoin est une adresse e-mail. Pour le vérifier et récupérer votre copie, suivez ce lien.

Comme il s’agit d’un blog de base de données, une note rapide! En vous inscrivant pour recevoir le modèle, vous serez également ajouté à la liste de diffusion de mon blog (que je ne partage jamais avec des tiers). J’envoie des mises à jour bimensuelles et des annonces occasionnelles, auxquelles vous pouvez vous désinscrire à tout moment.