877 422 7381
support@ibaset.com

7 conseils pratiques pour une documentation efficace

iBASEtblog Manufacturing Execution System7 conseils pratiques pour une documentation efficace

Apr

18

7 conseils pratiques pour une documentation efficace

[FR] Guidelines for DocumentationLa partie la plus complexe d’une implantation logicielle est la documentation. Dans un monde encerclé de règles, la documentation est un élément obligatoire, sur lequel nous devons exercer un contrôle précis et efficace. Personne ne semble vraiment le réaliser, mais c’est pourtant la réalité. Même avec Wikis, SharePoint, la collaboration en ligne et les nombreux outils de documentation à notre disposition, créer et maintenir une documentation bien construite reste une tâche difficile. Je crois que Le plus compliqué est de savoir COMMENT documenter les informations relatives au projet. Il est bien plus facile de débuter avec un modèle, mais le problème est que vous risquez de vite tomber à court d’idées. Alors : comment rendre le processus de documentation agréable et efficace?

1. Restez informé des dernières nouveautés

Peu importe votre niveau de culture générale; aujourd’hui, tout le monde peut se spécialiser et s’informer au moyen des ressources disponibles en ligne. Tenez-vous informé de l’actualité et restez connecté pour être au courant de ce qui se passe autour de vous.

2. Utilisez les bons outils

Les documents Microsoft Word des dossiers Windows ne comptent pas. Utilisez un outil de gestion adapté, ou votre système de Gestion de Données Personnelles (PDM).

3. Ne vous laissez pas tromper par les modèles

Les modèles proposés comme référents sont parfois trop « figés » et ne veulent finalement rien dire. Mieux vaut rédiger votre propre contenu vous-même.

4. Intégrez des éléments visuels

Qui a dit que les documents ne doivent contenir que du texte ? N’hésitez pas à faire usage de cartes, diagrammes et images pour rendre votre document plus facile d’accès et plus ludique.

5. Déterminez le bon moment pour écrire

Pour éviter la procrastination, prévoyez des horaires précis dédiés à l’écriture, même si cela ne doit durer qu’une heure.

6. Définissez un objectif

Une fois que vous aurez établi l’objectif de votre document, il sera plus simple pour vous de développer le contenu. Pensez à créer une structure précise pour votre document pour ne pas être tenté de le modifier à chaque page, ni à chaque fois que vous y intégrez un nouvel élément. Lorsque vous rédigez le contenu de votre document, restez fidèle à l’objectif que vous vous êtes fixé au départ. Aussi, posez –vous les bonnes questions : à qui est destiné le document? Par où commencer ? Devez-vous laisser place à d’éventuelles questions ? Enfin, mettez-vous dans la peau du lecteur : le contenu est-il clair et répond-t-il à vos attentes ?

7. Restez simple

Si vous devez céder les droits d’auteur de votre document, vous avez la possibilité de former le nouveau propriétaire du document à son utilisation, en seulement vingt minutes.
Malheureusement, la documentation s’avère parfois complexe. Les documents vivent et évoluent avec le temps. Suivez toujours les règles de base et faites toujours de votre mieux pour produire un document agréable, efficace et utile.

Si vous avez tendance à procrastiner, essayez d’identifier les raisons qui vous poussent à retarder votre travail : avez-vous défini des règles claires, et parvenez-vous à les respecter ? Dites-le nous dans les commentaires suivants.

Add Comment

Your email address will not be published. Required fields are marked *