Quels sont les différents types de documentation technique?


Meilleure réponse

Il existe tellement de types de documents techniques quil est presque impossible de tous les énumérer ici.

Au cours de ma longue carrière de rédacteur technique, jai personnellement dû rédiger plus de 15 types de documents techniques différents, variant dun projet à lautre.

Au niveau le plus abstrait, les documents techniques peuvent être classés dans ceux écrits pour les utilisateurs internes et utilisateurs finaux externes .

Par exemple, un Guide de configuration système est un exemple de document «interne» alors quun Le guide dinstallation est un exemple de document « utilisateur final externe ».

Un Guide API peut être à la fois pour et les utilisateurs externes. Un Guide de démarrage rapide , en revanche, est presque toujours destiné aux utilisateurs finaux externes.

Jai écrit Guides de lutilisateur , Guides de dépannage , Feuilles de référence , Notes de version , (modifiées) Documents sur les exigences marketing (MRD), Documents darchitecture et dingénierie (A&E Doc), Fichiers daide , Manuels des procédures opérationnelles standard (SOP), et bien plus.

Nous vous invitons à visiter le Centre de communication technique pour plus dinformations gratuites sur tous ces différents types de documents techniques.

Réponse

Il existe différentes manières de catégoriser les types de documentation technique qui existent. Je nai pas la prétention de les connaître tous, mais les deux grandes catégories principales que vous pouvez utiliser pour classer toute documentation technique sont lutilisateur et le cas dutilisation.

Par « lutilisateur », je veux dire ce que type dutilisateur utilisera le document? Sagit-il dun guide de ladministrateur, dun didacticiel ou dun guide de lutilisateur? Ces niveaux de connaissances sont pris en compte lors de la conception dun document. Un guide de ladministrateur suppose que la personne qui lit le document en sait un peu plus que le lecteur du didacticiel.

Par «cas dutilisation», je veux dire à quoi sert le document? Cela peut aller de la documentation militaire sur la façon de lancer un missile à la documentation du développeur sur la façon dutiliser une API graphique pour développer un jeu vidéo.

Si vous pouvez affiner votre question, je pourrais peut-être pour vous donner plus de ce que vous recherchez.

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *