Rédaction de documents techniques : Les fondamentaux

IntroductionObjectifs de la rédaction technique

• Communiquer efficacement des informations techniques
• Régler les problèmes de rédaction classiques

Processus d'écriturePréparation à l'écriture

• Éviter les problèmes de conception qui ralentissent la rédaction technique
• Conception à partir de scénarios
• Se concentrer sur l'objectif du document

Évaluation du lectorat

• Identifier vos objectifs et ceux de votre lectorat
• Ce que le lecteur apporte

Couverture du domaine de connaissances

• Connaissances tacites
• Savoir quand vous en avez fait le tour

Clarté et lisibilitéÉcriture technique

• Organisation de l'information pour répondre aux besoins des lecteurs
• Maintien de la cohérence dans la phrase

Organisation des phrases pour une meilleure communication

• Création de sujets forts
• Variété des structures de phrases
• Problèmes grammaticaux de la rédaction technique
• Utiliser la ponctuation pour plus de clarté

Gestion des styles

• Évaluation de la lisibilité avec la technique Given/New
• Maintien de la cohérence grâce à un guide des styles
• Élimination du reader recycling

Mécanisme de l'écritureOutils du rédacteur technique

• Organisation de l'information avec des tables et des listes
• Choix du bon vocabulaire

Rédaction dans le style approprié

• Officiel
• Élémentaire
• Télégraphique
• Minimaliste
• Choix du style le plus efficace

Retravail du texte et qualité

• Savoir quand et quoi retoucher
• Tri pour correction
• La place du retravail de texte dans le processus de rédaction du document

Structure du document

• Transitions qui fonctionnent
• Utilisation d'en-têtes pour maintenir l'écrêtage visuel

Rédaction pédagogique

• Styles d'écriture possibles
• Général vers spécifique
• Causes et effets
• Problèmes - méthodes - résultats
• Ordre d'importance
• Comparaison et contraste
• Adopter un style de signalisation

Rédaction pour l'environnement web

• Aide au lecteur en « apportant le contexte sur chaque page »
• Création de pages que le lecteur peut survoler

Construction du documentConception en fonction du lectorat

• Lien entre la structure et le lecteur
• Distinguer les différents types de manuels utilisateur
• Développer des manuels de référence et des livres blancs

Choix du type de document

• Document « post-positive » vs. pragmatique
• Utilisation efficace des formats, dont STOP

Construction du document

• Tutoriels et procédures d'opération
• Conception d'ouvrage tutoriel grâce aux formats Minimalist et Playscript
• Structure des phrases et sections
• Gestion de l'introduction et de la conclusion

Prototype du document

• Test de l'efficacité du document
• Styles de prototypes

Aspect du documentMise en page du document

• Processus de lecture du document technique
• Police
• Alignement
• Gris typographique

Utilisation des graphiques

• Découpe du document, utilisation de photos, graphiques et dessins, mise en valeur des graphiques