Pratiques exemplaires en matière d’écriture modulaire

Avec Draft Space, vous écrivez votre contenu dans des rubriques, ce qui le rend optimisé pour la réutilisation. Cette méthode d’écriture modulaire nécessite d’adopter certaines nouvelles habitudes par rapport à l’écriture classique.

Perfectionner l’écriture modulaire peut prendre beaucoup de temps et de pratique. Toutefois, suivre un petit ensemble de règles de base peut vous aider à contribuer au document sans créer de travail supplémentaire pour les auteurs.

Avantages de l’écriture modulaire

Diviser le contenu en rubriques à but unique facilite la réutilisation et la réorganisation :
  • Les rubriques peuvent être incluses dans de nombreux documents différents et peuvent également être reproduites dans un seul document.
  • Vous n’avez à mettre à jour une rubrique qu’une fois, peu importe le nombre d’endroits où elle est utilisée.
  • De nombreux auteurs et contributeurs peuvent travailler en parallèle sur le contenu sans avoir à se soucier de la façon dont il sera organisé.

Ces avantages ne peuvent être obtenus que si le contenu est rédigé d’une manière qui le rend indépendant de tout changement de structure et de séquence.

Rubriques à but unique

Écrivez une rubrique pour une seule chose. S’il semble que vous deviez décrire plusieurs choses, n’hésitez pas à créer plusieurs rubriques. Ces rubriques pourront ensuite être répertoriées sous une rubrique parente qui agira en tant que tête de chapitre.

Titre et description courte appropriés

Les lecteurs voient d’abord le titre et quelques mots du début d’une rubrique, puis choisissent s’ils veulent ou non sélectionner le lien et voir le contenu complet de la rubrique. Par conséquent, le titre et le premier paragraphe devraient faciliter cette décision.

Le titre doit couvrir l’intégralité de la rubrique et uniquement cette rubrique (ce qui est bien sûr plus facile lorsque vous créez des rubriques à but unique).

La courte description (shortdesc) fournit le premier paragraphe d’une rubrique, et nous vous recommandons de toujours en créer une. La courte description est souvent affichée dans une infobulle lorsque le lecteur survole le titre, ce qui aide le lecteur à déterminer si la rubrique vaut la peine d’être lue. Elle ne résume pas le contenu; elle sert d’introduction au contenu. Nous vous recommandons également de garder sous 300 caractères la description courte.

Indépendant

Les rubriques peuvent être déplacées de part et d’autres au sein d’un document. Certaines peuvent être ajoutées, d’autres retirées, et d’autres encore peuvent être réarrangées. Par conséquent, il est essentiel de ne pas faire référence, dans un contenu, à ce qui vient avant et après. Idéalement, une rubrique devrait être écrite comme si elle ne faisait pas partie d’un ensemble plus grand. Ce d’autant plus qu’une rubrique est généralement affichée seule par elle-même.