background preloader

Rédaction technique

Facebook Twitter

Accueil. Le blog de la rédaction technique, des outils du rédacteur et de la formation des rédacteurs. Création et réalisation d'une notice d'instructions. La notice d'instructions d'une machine ou plusieurs machines ou d'une installation ou d'un produit, regroupe plusieurs notices ou manuels : La partie utilisation (manuel d'utilisation, manuel utilisateur ou notice utilisateur) destinée aux opérateurs qui utilisent ou pilotent la machine, l'installation ou se servent du produit.

Création et réalisation d'une notice d'instructions

La partie réglage et paramétrage (généralement ajoutée à la partie utilisation) destinée aux personnes ayant reçu une formation plus spécique. La partie entretien ou maintenance destinée au personnes qui ont en charge le suivi et le dépannage. La notice d'instructions est un produit à part entière et un élément indispensable de vos offres commerciales. Comment utiliser Word pour travailler sur de longs documents.

Dans ce tutoriel, nous allons aborder quelques méthodes pour vous permettre de travailler avec Word sur de longs documents.

Comment utiliser Word pour travailler sur de longs documents

Lorsque vous utilisez Word pour des documents de petite taille, Word est très à l'aise. Les problèmes apparaissent lorsque vos documents dépassent les 50 pages et plus le nombre de pages augmente, plus les problèmes sont nombreux. Si vous désirez utiliser Word pour un travail collaboratif, vous allez devoir faire usage de certains mécanismes afin de permettre à plusieurs personnes de travailler simultanément sur le même document. Nous allons aborder deux méthodes : l'insertion de documents avec liens et le document maître. Je vous laisse juge pour trouver la meilleure de ces deux méthodes. Conseil des rédacteurs techniques. Nous avons défini une charte que nous nous engageons à respecter.

Conseil des rédacteurs techniques

Article 1 : maîtrise de la langue Les rédacteurs écrivent dans une langue qu’ils maîtrisent parfaitement sur les plans de l’orthographe, de la grammaire et de la syntaxe. Le style et le niveau de langage qu’ils emploient sont adaptés au type de document et au type de lecteurs concernés par le message écrit. Article 2 : maîtrise de la terminologie Les termes techniques employés sont conformes à l’usage dans la profession (ou dans l’entreprise cliente, à condition que celle-ci ait fourni son vocabulaire) et compréhensibles par les lecteurs concernés.

Rédaction Web et technique: L'Abc de la rédaction technique en 6 règles (manuels aux utilisateurs) Conseils pratiques: Livrez l’information la plus importante au débutÉvaluez d’éliminer l’information secondaire ou repoussez-la à la fin d’une section ou du manuelConcentrez-vous sur les faits utiles au service ou au produitNe dépassez pas 24 mots par phraseDivisez une phrase en deux phrases plus courtes aussitôt que possibleUtilisez un langage simple, orienté vers le lecteurRemplacez le jargon par des mots courants aussi souvent que possible Les paragraphes courts sont la clé Les lecteurs aiment les paragraphes courts.

Rédaction Web et technique: L'Abc de la rédaction technique en 6 règles (manuels aux utilisateurs)

Leur cerveau également. Tenez-vous en à cinq phrases par paragraphe. L'analyse fonctionnelle expliquée. Création et réalisation d'une notice d'instructions. Comment utiliser Word pour travailler sur de longs documents. Sans titre. Le guide se propose de vous aider en suggérant une méthode d’organisation des documents et en déterminant le temps de conservation pour ceux-ci.

sans titre

Ce guide pratique et simple d’utilisation permet de classer les documents personnels et familiaux en fonction des activités quotidiennes. De plus, des durées de conservation sont suggérées en regard des lois en vigueur et des besoins pressentis par les utilisateurs. Ce manuel s’adresse autant au grand public qu’aux archivistes pour le traitement de fonds privés non organisés.

Balise alt : Optimiser le référencement des images. Qu’est-ce qu’une image ?

Balise alt : Optimiser le référencement des images

Une image est une représentation visuelle de quelque chose, ça pourrait être une photographie, un graphique, un dessin… Il existe plusieurs formats d’images utilisés sur les sites Web : JPEG (extension .jpg), GIF (extension .gif), PNG (extension .png) Dans l’optimisation de votre site, ne négligez pas la balise alt et le poids des images qui peuvent contribuer au référencement de vos pages. Guidepresentation flsh. Rédaction technique. Un article de Wikipédia, l'encyclopédie libre.

Rédaction technique

La rédaction technique est la conception de documents écrits accessoires à l'utilisation ou la maintenance de machines, instruments, logiciels, pièces détachées, sur support imprimé ou informatique. Les rédacteurs techniques préparent, par exemple, des modes d'emploi, des notices d'utilisation, des aides en ligne (Mallender 2002), aussi bien pour du matériel informatique que des logiciels, de l'électroménager, des pièces d’aéronautique et d’astronautique, à l'intention d'utilisateurs de toute sorte de compétences techniques.

Aperçu[modifier | modifier le code] La rédaction technique est la forme de communication technique qui utilise l'écriture. La STC (Society for Technical Communication) définit la communication technique comme un domaine qui inclut toute forme de communication présentant une au moins des caractéristiques suivantes[1] : Outils de conception d'une aide en ligne. Un article de Wikipédia, l'encyclopédie libre.

Outils de conception d'une aide en ligne

Un Outil de conception d'une aide en ligne est un logiciel utilisé pour créer des manuels d'aide en ligne. Fonctions[modifier | modifier le code] Les fonctions basiques d'un outil de conception d'une aide en ligne peuvent être divisées en plusieurs catégories. Import de fichier[modifier | modifier le code] Export de l'aide[modifier | modifier le code] Qu'est-ce qu'un outil de création d'aide ? Rédiger une documentation d'aide est un travail pénible, un rédacteur technique doit expliquer clairement chaque fonction du produit et la documentation doit être écrite pour un large panel d'utilisateurs du produit, dont tous n'approcherons pas le produit avec les mêmes attentes ou le même niveau d'expertise technique.

Qu'est-ce qu'un outil de création d'aide ?

Malgré ces considérations, dans de nombreux cas les auteurs techniques découvrent qu'écrire la documentation d'aide n'est que la partie la plus facile du processus. Une fois qu'ils ont rédigé tout ce qu'ils ont à dire pour couvrir le sujet correctement, ils doivent ensuite le formater pour qu'il soit accessible et facile à lire dans une variété de formats.