Initiation à la rédaction technique

Objectifs fondamentaux

• Les objectifs :
  
  • Pourquoi documenter ?
  • Quand documenter ?
  • Quoi documenter ?

• Les enjeux de la documentation :
  
  • Techniques, commerciaux et économiques

• Les buts recherchés pour une documentation efficace

Conception documentaire

• Stratégie d’ensemble de l’approche documentaire vis-à-vis d’un produit ou d’un équipement :
  
  • Quelles informations ?
  • Pourquoi ?
  • Pour qui ?
  • Comment ?

• Types de documents, caractéristiques, types d’utilisateurs...

Définition du contenu

• Plan documentaire
• Dossier de spécifications techniques, politique de maintenance
• Critères de valeur documentaire :
  
  • Contenu, Structure, Lisibilité, Consultabilité
• Séquence de conception et de mise à jour
• Les normes : plan type normatif (ATA, MAT, IT, AIR, AVE, GEE...)
• Notions sur le découpage d’un produit, d’un équipement...

Règles de rédaction

• La recherche du mot juste
• Conjugaison : temps et mode à utiliser
• Terminologie
• Style, syntaxe
• Ponctuation, relecture, orthographe

Travaux pratiques

• Rédaction technique
• Description, Fonctionnement, Utilisation / Exploitation, Maintenance et Catalogue de pièces de rechange