Rédiger un bon document est crucial. Mais le constat est fait régulièrement, et DIGITAM ne dira pas le contraire : les projets dans l’IOT manquent souvent cruellement de documentation. A tel point que ce manque de documentation a été relevé comme le plus grand problème des logiciels libres dans une grande étude menée par GitHub. Pour certains développeurs, rédiger de la documentation est purement et simplement impossible, ou au prix d’un grand effort. Nous présentons ici quelques règles de base que nous enseignons lors de nos ateliers de rédaction documentaires, facilitant la tâche des rédacteurs.

1/ Quels sont les objectifs du document ?

Une question récurrente : « dois-je mettre cette information dans le document ou non ? » Il est essentiel de définir le but du document rédigé. A titre d’exemple, une spécification fonctionnelle doit contenir l’ensemble des besoins et des contraintes exprimés par le client pour réaliser une mission avec l’outil qui va être conçu. Toute information permettant d’atteindre cet objectif doit donc y figurer. Par ailleurs, très tôt dans le document, idéalement en première section, ces objectifs doivent être rappelés de manière explicite. Procéder ainsi permet d’éviter de perdre son temps sur des documents « fourre tout » qui sont au final plus difficiles à écrire que plusieurs documents plus ciblés et donc plus efficaces.

2/ Définir son audience

Quoi de plus démotivant que de se rendre compte que personne ne lit ce que l’on écrit ? Un document est fait pour être lu, l’écriture dans le monde de l’entreprise est un acte de communication. Le style, la teneur du contenu qu’il faudra adopter va dépendre du niveau technique et de la culture des personnes ciblées. Il est donc très important d’identifier les destinataires qui vont être amenés à lire et mettre en application les éléments présentés.

3/ Réaliser un plan détaillé

Comment vaincre le syndrome de la page blanche ? Penser plan détaillé ! A l’aide d’un logiciel de MindMapping comme l’excellent FreePlane, jetez les idées , la structure, les références pêle-mêle et organisez-les jusqu’à obtenir le plan du document. Il sera ensuite possible d’exporter ce plan sous format DOCX si besoin. Procéder ainsi permet d’autre part de rendre cette étape collaborative, donc plus ludique. Oui, rédiger une documentation peut être ludique !

4/ Diviser le fond et la forme

La plupart des débutants dans la rédaction de document « s’empêtrent » avec les éléments de forme (style, police, lettrine …) tout en rédigeant le document proprement dit. Le va-et-vient incessant entre la rédaction, le sélecteur de police, le soulignement est source de perte d’énergie et de motivation. Il est beaucoup plus efficace de procéder par étape en traitant la forme en premier. Les traitements de texte du marché implémentent la notion de style, ce qui permet d’uniformiser la mise en forme des éléments du document (titre, citation, liste, paragraphe, morceau de code…) et donc de définir à l’avance à quoi va ressembler le rendu final. Il existe beaucoup de ressources en ligne présentant ce concept comme OpenClassroom.

5/ Le beau est l’ami du bien

Créer un document que l’on trouve beau et professionnel se fera beaucoup plus facilement que si l’on a l’impression d’écrire sur une feuille de brouillon. En complément du point 4 ci-dessus, créer un ensemble de modèles de document qui « jette » est excellent pour booster la motivation du rédacteur. Faire intervenir dans ce cas un graphiste pour réaliser une charte graphique cohérente est un investissement qui portera autant sur la communication externe que sur la motivation interne.

CONCLUSION

DIGITAM vous souhaite d’excellentes sessions rédactionnelles à travers ces 5 conseils; Si votre organisation est consciente de son manque documentaire, mais peine à savoir comment combler ces lacunes rapidement, nos experts peuvent vous mettre sur la voie via des ateliers de travail spécialisés.

Contactez-nous !