Rédaction d'une notice technique

Références



Une notice technique doit comporter quatre volumes

Constitution du Volume description

  • Qu’est-ce que le produit
  • À quoi sert le produit
  • Quelles sont les normes, recommandations, avis que doit respecter le produit
  • Quels sont les domaines d’utilisation
  • Quels sont les principes ou lois utilisés
  • Aspect général du produit
    • Dimensions
    • Poids
    • Couleurs
    • Description des faces
      • Les voyants
      • Les boutons
      • Interrupteurs
    • Les tensions d’alimentation
  • En cas de liaison
    • Modulation utilisée
    • Fréquences utilisées
    • Type de liaison
    • Distance de la liaison
    • Calcul du bilan de la liaison
    • Description et principe de fonctionnement du support de transmission
    • Les entrées et sorties
    • Les précautions d’emploi
    • Les câbles ou nappes utilisés
      • Longueurs
      • Brochage
      • Normes à respecter
      • Précautions CEM
  • Liste des pièces
    • Liste des cartes
    • Liste des éléments externes et par carte
      • Valeurs des éléments
      • Les paramètres ( puissance , isolement,tension,courant)
    • Nomenclature des éléments avec le nom du fabriquant
  • Montage et démontage
    • Liste des outils nécessaires
    • Planches de montage avec figures et numérotation des pièces
    • Planches de démontage avec figures et numérotation des pièces
    • Précautions à prendre

Retour en haut

Volume fonctionnement

Partie matériel
  • Situation du produit dans l’environnement
    • Intéraction avec d’autres produits
    • Fonctionnement global
  • rôle des éléments externes
    • type de signal reçu/émis(analogique, numérique)
      • les paramètres (amplitude , fréquence)
      • la (les) modulation(s)
      • les normes ou avis
      • si le signal est une trame
        • description de la trame
        • énumération/description et fonction de chaque champ
    • quel évènement produit le signal ou les signaux
    • à quel moment un évènement se produit
    • que signifie l’évènement en cours
  • Rôle de chaque carte
  • Synoptique de chaque carte
  • Rôle des circuits ce chaque carte
    • Notice technique jointe
    • Liste des éléments de la carte
    • Principe utilisé
  • Fonctionnement détaillé des cartes
    • Alimentation (valeurs – fonctionnement)
    • Les signaux d’entrées|sorties
      • Le protocole utilisé
        • Détails du protocole
      • Les niveaux de tension, les fréquences
      • En cas de trame
        • Constitution de la trame
        • Détail des différents champs de la trame
    • Fonctionnement détaillé de chaque circuit
      • Tables de vérité
      • Étude des cas particuliers
  • *en cas d’émetteur|récepteur
      • La (les) modulation(s) utilisée(s)
      • Les fréquences d’émission|réceptionj
      • Étude du protocole de transmission |réception
      • Calculs du bilan de liaison
  • Les mesures
    • Liste des appareils de mesures
    • Liste des mesures effectuées
      • Schéma de la mesure
      • Conditions de mesure
      • Tableau des valeurs mesurées
        • Tolérances
        • Paramètres ( température, pression ect…)
  • Le dépannage
    • Les précautions à prendre (règles de sécurité)
    • Les appareils de mesure utilisés
    • Les points tests
    • Signal ou valeur obtenus à chaque points
    • Ordinogramme de dépannage

Retour en haut

Volume fonctionnement logiciel
  • Description de l’ordinateur utilisé
    • Type d’ordinateur( PC, MAC..)
    • Les entrées |sorties
    • Les protocoles ( RS232- USB etc..)
    • Système d’exploitation utilisé
      • version
    • Mémoires système
      • Disque dur
      • Mémoire vive
  • Description des outils logiciels utilisés
    • Logiciels utilisés avec versions
    • Compilateur utilisé avec version
    • Langage utilisé
      • Description du langage et des instructions
      • syntaxe
  • Liste des modules( ou fonctions)
  • Ordinogramme général
  • Pour chaque module
    • Rôle du module
      • Explications du fonctionnement du module
      • Principe utilisé
      • Explication des astuces utilisées
    • Liste des variables et constantes
      • Utilisation
      • valeurs
    • Liste des entrées|sorties utilisées
      • Type d’entrées|sorties ( numériques, analogiques)
      • Type de signaux, codes
      • Niveaux de tension, front de commande
      • Le brochage
    • Les adresses utilisées
    • Les registres utilisés(Description des registres)
      • Fonction de chaque bit
    • La (les )mémoire(s) utilisée(s)(description des mémoires)
    • Liste des variables et constantes
      • Nom
      • Rôle
      • brochage
  • Les interruptions
    • niveau d’interruption
    • quel évènement produit l’interruption?( activation|désactivation)
    • fonctionnement
    • vecteur d’interruption
    • action
    • gestion de la pile
  • Les timers
    • timers utilisés
    • fonctionnement
    • calculs
  • Le(s) programme(s)
    • ordinogramme pour chaque module
    • commentaires
    • explication globale du logiciel
    • détails sur les variables , constantes, entrées , sorties

Retour en haut

Le volume notice de l’utilisateur

  • La notice de l’utilisateur reprend une partie du volume description.
  • La notice décrit :
    • l’emballage et le contenu du paquet
    • l’aspect externe du produit
    • la fonction de chaque élément externe
    • les branchements
    • les alimentations
    • les précautions à prendre
    • l’utilisation globale du produit
    • l’utilisation particulière des éléments du produit
    • les conseils et méthodes de dépannage adaptées à l’utilisateur
  • D’autre part, la notice peut inclure :
    • des photos ou des dessins
    • l’adresse du fabriquant
    • une adresse email du type « contact »
    • un numéro de téléphone et un FAX

Retour en haut


Sandra Lenneville. SMTE. Cégep Gérald-Godin

Creative Commons License

Historique du site et récupération du matériel

Dernière mise à jour 27 août 2009

Cégep Gérald-Godin