Catégorie : documentation technique

Comment (bien) démarrer un projet de documentation ?

Que vous optiez pour une documentation minimaliste ou plus simplement structurée, il vous faut DE-MA-RRER ! S’asseoir devant une page blanche ou copier/coller le vieux manuel de 2001, n’est PAS la bonne solution !       De la méthode & de la norme (ISO 26 514)!  Pour envisager des processus plus efficaces et économiques,… Lire la suite …

Utiliser mon DIF pour un atelier « Documentation minimaliste » ?

 … Non, mais et puis quoi encore ?   _______________________________________ Quel contenu ? D’abord, que contient un atelier « minimalisme et documentation »  et où trouver un exemple de ré-écriture en version « minimaliste » Au cours de l’atelier, vous vous familiarisez avec les 4 principes du minimalisme, puis vous les mettez en application à partir de VOTRE documentation.… Lire la suite …

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 degrammaire, 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… Lire la suite …

Découvrir l’intérêt des tests utilisateurs…

… ou lorsque la poule découvre l’oeufDans un article paru dans le N° 1 de la revue DOCUMENTALISTE – Sciences de l’information, on trouve un article « Communication et rédaction technique : test et oralité.« Oralité et documentation techniqueComme l’oralité en documentation technique relève du mystère, on poursuit la lecture. « Les cursus devraient …proposer des enseignements sur… Lire la suite …

Booster l’efficacité de votre documentation !

Vous souhaitez actualiser, au sein d’un groupe de collègues, votre savoir-faire pour optimiser votre documentation produits en créant une documentation ciblée utilisateur et structurée ?  Faites-le savoir ! N’hésitez pas à vous joindre aux discussions sur le démarrage d’un projet de documentation, son volume, son coût, son utilité et le feedback de vos utilisateurs. Avant-goût… Lire la suite …

Minimalisme, qualité et lisibilité (…foutaises ?)

En parlant minimalisme, on entend souvent : c’est réduire la longueur des mots ! Et bien non, ce n’est absolument pas cela. Tous les mots, à partir du moment où ils sont compris et utilisés par l’utilisateur final sont utilisables dans une documentation technique. En matière de longueur des mots, quelques esprits qui s’autorisent à… Lire la suite …

Ma documentation est de qualité ! Nul doute, puisque vous y avez apporté toute l’attention et les compétences nécessaires. Par exemple, le formatage, la mise en page, le choix des caractères, l’outil d’aide à la rédaction, le correcteur orthographique (non, vous êtes au point et n’en avez pas besoin…), les notes des développeurs, le logiciel… Lire la suite …

Utilisateurs stupides et rédacteurs idiots ?

Les utilisateurs sont stupides ?  Dans son article, Stephen Turbek pense surtout qu’il sont  « Stressed, Tired, Untrained, Passive, Independent, Distracted ».Oui, mais comment concevoir une documentation pour ce genre d’utilisateurs ?________________________La documentation du 21e siècle ? Dans son article « The power of free manuals« , Kyle Wiens conclut en recommandant :  « Rethinking documentation – …Manual and guides… Lire la suite …

Minimalisme : action et réaction …

Dans son excellente présentation « Designing instructions that work, using the 4 Components Model« , Dr. Hans van der Meij  -un des pères du minimalisme- nous rappelle d’emblée, que les instructions doivent être : Effective  –  enable the user to successfully complete a taskEfficient  –  consume as little time and effort as possibleSatisficing  –  stimulate the user… Lire la suite …

Les idées fausses sur le minimalisme

Documentation figée ? Dans un article bien détaillé, Joe Pairman reprend les points avancés par Mark Baker qui, lui, prétend que le minimalisme conduit à une documentation inerte ou figée. La discussion se déroule sous forme de duel très, très webien qui vaut vraiment plusieurs minutes de notre attention. Première salve : le rédacteur ajoute-t-il… Lire la suite …

ERIKSON
GSX
COHERIS
SCHLUM
EFFICIENT
OPTIS
INTERSEC
NMJ
TALEND
LYRA
HILL
HORIBA
ERIKSON
GSX
COHERIS
SCHLUM
EFFICIENT
OPTIS
INTERSEC
NMJ
TALEND
LYRA
HILL
HORIBA

logo-bleu

Établissement de formation à la documentation technique

Formatrice : Marie-Louise Flacke

Graduate of the American
University of Paris
Tel. 06 03 20 50 10

… mais que signifie Awel-A-Ben ?

Contact

BLOG

blog-icon

 

PRESS

press-icon