Minimalism authoring: some resources

“The essence of the minimalist approach is to obstruct as little as possible the learner’s selfinitiated efforts to find meaning in the activities of learning.” (John M. Carroll)

Basics by John M. Carroll and Hans van der Meij

•  Minimalism Beyond the Nurnberg Funnel

• First Minimalist Manual 

• Minimalism principles  

Applications

• An application of the Principles of Minimalism to the Design of Human-Computer Interfaces

•  Minimalism updated 2012 

•  Minimalism and DITA enable significant cost savings for Avaya Telephone manuals

• What make minimalism so popular today?

•  Scenarios and Minimalism, by Bill Gearhart

• Minimalism: a cereal killer

•  List of references

Academic research

•  The minimalist Approach to Online Instructional Videos, by EH Pflugfelder, published in Volume 60, Number 2, May 2013 l Technical Communication

•  John Carroll's The Nurnberg Funnel and Minimalist Documentation,  by David Farkas in IEEE Transactions on Professionnal Communication, vol.33, No 4, December 1990

•  Ten misconceptions about minimalism, by Dr. Hans van der Meij 

• Applying Minimalist Principles, Strategies, and Techniques, by Susan M.J. Lester

• Goal-orientation, goal setting and goal-driven behavior in (minimalist) user instructions,  by  Dr. Hans van der Meij, IEEE Transactions on Professional Communications, 50 (4) 295-205

Complementary reading

•  Content Curation: Building bridges between web writing and DITA Authoring

• User scenarios - A Center Point for User Learning
• Structured authoring 
• Why Don't People read the manual?
• Why users don't  read that f... manual? (video)

Se former aux techniques du minimalisme 

Le prochain atelier "documentation minimaliste" aura lieu les 29 et 30 septembre 2014 à Liège. Qu'on se le dise ;-)

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 ? Je m'en fiche ! Ils n'ont qu'à lire le manuel de A à Z

• il est hors de question de changer de méthode de rédaction. On a toujours fait comme ça

• vous parlez DITA ?
  
  Publication sur tablette ? Responsive design...? Foutaises ! Il n'y a qu'une seule doc, c'est la documentation papier !

• vous voulez mixer Twitter et la documentation technique ?...  Profonde aberration ! 

On ne se la joue pas "Première Dame", chez nous !

• l'overdose d'avertissements et de notes vous gène ? 

C'est inévitable, parce que l'utilisateur est un crétin !

Il faut tout lui répéter !

Pour plus d'information sur le montage d'un atelier "minimaliste", contactez [flacke@orange.fr]

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 manuel de 800 pages ?

Mais vous, cher rédacteur, quand avez-vous ouvert et utilisé un manuel de 800 pages ?

Rappelez-vous l'excellent sketch de Dany Boon qui tente de lire -en première mondiale- un manuel utilisateur en entier ...

Complète votre documentation ?

 ... mais est-elle utile ?
Effectivement, 400 pages seulement pour votre guide opérateur paraissent bien digestes. C'est bien ! Mais savez-vous comment votre utilisateur va chercher (et trouver) l'information qu'il recherche ? 

Avez-vous remarqué que Nokia produit la totalité de sa documentation selon les 4 principes du minimalisme ?

...à votre avis, vos utilisateurs ne méritent pas la qualité Nokia ?

 Secteur réglementé

Vous rejetez le minimalisme parce que vous intervenez dans le nucléaire ? dans le médical ? dans l'aéronautique ? ... Vous souvenez-vous QUI vous a démontré que les règles du minimalisme étaient incompatibles avec votre secteur ?


Branchez-vous sur l'enregistrement du  webinaire organisé par la STC France le mardi 27 mai 2014 ! Vous aurez la présentation et les échanges.

Formation par atelier interactif

Le prochain atelier aura lieu les 29 et 30 septembre 2014 à Liège (BE)

Grammaire, conjugaison, phraséologie... Quel ennui !

Dans un raccourci fulgurant, certains rédacteurs pensent qu'en implémentant les règles du minimalisme, ils peuvent passer rapidement sur ces scories que sont les règles de
grammaire, de conjugaison et autre horreurs comme l'orthographe.

Puisque le minimalisme cherche à éliminer le superflu, éliminons les rigidités grammaticales !

 La conjugaison ? quelle abomination !

Et pourtant, parmi les principes de base de la rédaction "minimaliste", on trouve :  "Rédiger au présent" (jamais au futur). 
En effet, l'utilisateur veut savoir ce qui va se passer s'il appuie sur ce bouton vert MAINTENANT, pas dans 30 minutes.

• Appuyez sur CRTL+ALT+XXX                                                                      L'enregistrement démarre. 

        (et non pas "L'enregistrement va démarrer" ou "L'enregistrement démarrera")

Dans une présentation disponible en ligne, notre collègue Sharon B.  recommande, dans sa diapo n° 25, de rédiger à la voix active et au temps présent.

Dans sa colonne de droite, elle indique donc "Present tense" et donne des exemples dont :

 "Your email is automatically sent the next time a network is found"

... oui, un abysse s'ouvre devant nous  !

Si cette phrase est au présent (et accessoirement à la voix active), je veux bien être condamnée à nettoyer la place de la Concorde à la brosse à dents !

Dans les temps antédiluviens, on faisait la différence entre le présent et le passé composé : "Votre e-mail est envoyé automatiquement dès que le système trouve un réseau" (passé composé)
-et-
"Le logiciel envoie votre e-mail" c'est du présent (et de la voie active).

Pour les hésitations en conjugaison, voici de quoi vous rattraper aux branches...

Voix passive ...quelle dérive !

Tous nos grands maîtres en documentation technique s'accordent pour nous recommander : "N'écrivez jamais à la voix passive". Tout simplement parce qu'on ne sait jamais, dans ce cas, QUI fait l'action.

Comme par exemple :
"Le logiciel est démarré en appuyant sur le bouton"   -ou- "L'alarme est neutralisée après le déclenchement du levier vert".

D'accord, mais qui appuie sur le bouton ? le perroquet ? la musaraigne qui passait par là ? ou alors est-ce que le logiciel est programmé pour déclencher un appui sur le bouton ?

De mauvaises langues rapportent que, lorsque certains rédacteurs tournent leurs phrases au passif, c'est parce qu'ils n'ont pas compris le fonctionnement du système (et ne veulent pas trop se fatiguer à chercher)... des mauvaises langues, je vous le dis !   

En minimalisme, une seule voix : la VOIX ACTIVE !

                  Dès que vous appuyez sur le bouton XXX, le logiciel démarre
Malheureusement, notre collègue californienne n'a pas été touchée par la grâce de la voix active (vu qu'elle ne fait pas la différence entre les deux voix...)

Allons, l'essentiel est que la collègue Sharon B. puisse continuer à organiser ses séminaires, ses brassages d'air et son "manque-pas-d'air" (voir ses commentaires, sous sa présentation Slideshare, lorsqu'on lui fait remarquer ses dérapages...)

Cours particulier pour la chère Sharon :

(a) les phrases au futur :
- The Widget will print the report
- The Widget will save the file
- The email will be sent if a network is found (futur composé)

 (b) les phrases au présent (et à la voix active) :
- These steps may prevent the brake pedal from functionning
- Your report prints
- During these steps, the brake pedal does not work
(c) Phrases au passé composé (et au passif)
- Your email is automatically sent the next time a network is found
- The file is saved
                                                                                                                      

Conclusion, le minimalisme ne consiste pas à minimaliser l'application des règles de

grammaire et de conjugaison, mais à bien veiller que tout ce qui est écrit est grammaticalement correct.


Il faut que l'utilisateur comprenne facilement ce qui est indiqué, mais aussi que le traducteur n'ait pas à DEVINER ce que l'on a voulu dire...