documentation minimaliste Archives

Catégorie : documentation minimaliste

Sur les traces de l’utilisateur-type

Pourquoi organiser la chasse à l’utilisateur ? L’utilisateur de nos produits est le lecteur de nos documentations techniques. Pour lui fournir une documentation adaptée et efficace, il faut comprendre ses besoins et donc aller à sa rencontre. Comment intégrer l’utilisateur dans notre activité de rédaction ? Pour augmenter l’efficacité de notre documentation, nous… Lire la suite …

Minimalism vs brevity

In its online courses, STC is offering a certification in minimalism writing which is introduced as follows: « Session 1: What is Minimalism? Minimalist writing isn’t just deleting content, it is writing to deliver a lot of value in as few words as possible. It is the conjunction between clarity and brevity. » What do we mean… Lire la suite …

Universities working in silos?

… No! Sharing knowledge cross-country, yes! Time when universities were performing and disseminating research in restricted areas is OVER! Adhering to University Rennes 2 ‘s initiative, a good bunch of universities and « Hochschulen » join forces to disseminate technical documentation research to Master students. On Feb 4, 2016 European universities are video-conferencing (live) from Rennes to… Lire la suite …

Cachez cette Short Description que je ne saurais voir !…

Eliminons et nettoyons est le mot d’ordre de nombreux rédacteurs sur le point de migrer leur documentation vers la norme DITA. C’est ainsi qu’à la conférence DITA Europe 2014 à Munich une participante expliquait que, pour réduire le volume de leur documentation, ses clients désireux de passer au minimalisme… commençaient par éliminer la « Short Description »… Lire la suite …

Section « Troubleshooting » …Comment faire ?

Un chapitre « Troubleshooting » dans ma documentation ? Reprise sur erreur avez-vous dit ?… C’est le principe n° 3 du minimalisme : « Support error recognition and recovery ». Il s’agit d’aider l’utilisateur à retomber sur ses pieds, alors qu’il a fait une erreur. Pour faciliter le retour sur la bonne voie, le rédacteur a deux options: … Lire la suite …

Combien d’argent ai-je jeté par les fenêtres aujourd’hui ?

En matière de documentation produits, voici trois pistes pour brasser de l’air et dépenser à tour de bras : produire un Pdf de 400 pages que personne ne lit noircir 180 pages pour décrire les fonctionnalités du produit, en incluant 2 copies d’écran par page, dont plusieurs affichent le bouton OK. Ou alors préciser que l’onglet d’annotation sert… Lire la suite …

Minimalisme: principe n° 2 « L’outil intégré dans la tâche »

Oui, mais, … qu’est-ce que cela veut dire au moment de la conception de la documentation ? Anchor the tool in the task domain Disons : « l‘outil doit être considéré par rapport à la tâche » Dr. Hans van der Meij nous l’explique : « For most users, an application is a tool they want to use to achieve… Lire la suite …

La documentation minimaliste ?… un mauvais plan !

La documentation dite minimaliste ne m’intéresse pas parce que : je n’y connais rien ça n’a pas été inventé chez nous c’est du mauvais travail. Il faut TOUT dire à l’utilisateur mon boss ADORE les gros manuels. Je suis payé à la page… le département de documentation n’a pas de problèmes de budget les utilisateurs… Lire la suite …

Minimalisme ? pas chez nous !

« Nous fournissons un travail sérieux, nous ! Nous ne rechignons pas devant l’ampleur de la tâche : nous fournissons la totalité de l’information ! Un travail vraiment complet… sinon rien !Le minimalisme est réservé aux rédacteurs à mi-temps, ceux qui veulent un travail « quick and dirty » ! Alors, vous préférez l’infobésité ? …disons un beau… Lire la suite …

Jeter aux orties les Vues d’ensemble et Introductions ?

Savez-vous ce que pensent les utilisateurs de vos sections « Vue d’ensemble« , « Généralités » ou « Introduction » ?RIEN ! Ils négligent, ils rejettent, ils ignorent… Ils ne lisent PAS toutes ces formes de préambules (les ingrats !)Alors, pourquoi les inclure ? Pourquoi obliger les utilisateurs à feuilleter une dizaine de pages avant d’arriver à l’essentiel : « comment faire… Lire la suite …