Veuillez cliquer ici pour aider David McMurrey payer pour l'hébergement web :
Faites un don de n'importe quel petit montant que vous pouvez.
La rédaction technique en ligne restera gratuite.
Cette page est en maintenance.
Un guide de l'utilisateur est un document technique expliquant comment effectuer des tâches courantes par un utilisateur d'un produit. Commun tâches sont des actions que l'utilisateur doit être capable d'effectuer. Le utilisateur est à un niveau de connaissance et d'expérience prévu par le produit. Certains produits ont des utilisateurs de base et des utilisateurs avancés—un guide d'utilisateur peut répondre à l'un de ces besoins ou aux deux. Pensez à un four à micro-ondes : il peut avoir un utilisateur de base, et c'est à peu près tout. En revanche, un produit de design graphique peut avoir à la fois des utilisateurs de base et des utilisateurs avancés.
Infographie générée par NotebookLLM de ce chapitre
Dans ce chapitre, design de livre désigne le contenu, le style, le format, le design et la séquence des différentes composantes typiques d'un livre. "Composantes" fait ici référence à des sections ou pages réelles d'un livre telles que l'avis d'édition, la préface, l'index, ou la couverture avant ou arrière. Dans le chapitre de conception de page, le terme élément se réfère à des éléments qui peuvent apparaître plusieurs fois pratiquement partout dans un livre, tels que des en-têtes, des pieds de page, des tableaux, des illustrations, des listes, des avis, des surlignages, etc.
Ce qui suit donne un aperçu des composants typiques d'un livre technique imprimé et du contenu, du format, du style et de la séquence typiques de ces composants. Certes, aucun guide d'utilisateur unique, manuel de référence technique, document de référence rapide ou autre document de ce type n'aurait en réalité tous ces composants conçus et séquencés de la manière précise que vous êtes sur le point de lire. Au lieu de cela, cette revue offrira un aperçu des possibilités—disons de la gamme de possibilités.
Remarque : Actuellement, nous avons seulement un exemple guide de l'utilisateur développé dans FrameMaker puis exporté en PDF. Il manque un glossaire, mais toutes les autres parties d'un manuel utilisateur typique sont en place. (Je ne comprends pas ce "d" dans "Filepad" !) Sachez qu'il ne respecte pas certaines des exigences de police et de marge énumérées ci-dessous.
Avant de commencer à lire ce qui suit, procurez-vous plusieurs livres sur le matériel et les logiciels afin de pouvoir comparer leur contenu, style, format et séquençage à ce qui est discuté ici.
Pour encore plus de détails que ceux que vous voyez ici, consultez ces deux ressources industrielles standard :
- Publications techniques Sun. Lisez-moi d'abord ! Toute édition récente. Prentice Hall.
- Microsoft Corporation. Manuel de style Microsoft pour les publications techniques. Toute édition récente. Microsoft Press.
Vous pouvez voir des exemples de ces composants de livre dans Conception Techdoc.
Couverture avant et couverture arrière
Les documents produits pour les clients payants ont généralement des couvertures avant bien conçues, même si, à l'intérieur, le livre est de qualité très médiocre. Sur la couverture avant, vous verrez souvent certains ou la totalité des éléments suivants :
- Nom de l'entreprise
- Nom du produit
- Plateforme produit ou système d'exploitation
- Numéros de version et de publication du produit
- Titre du livre
- Logos d'entreprise ou de produit
- Symboles de marque déposée
- Œuvre d'art
- Numéro de commande de livre
- Slogan d'entreprise ou de produit
Il peut être difficile de déterminer un bon format pour le nom de l'entreprise, le nom du produit et le titre du livre. Parfois, cela peut représenter tout un paragraphe de texte ! Les entreprises sont assez partagées sur la question d'indiquer les numéros de version et de publication sur les couvertures— certaines le font ; d'autres ne le font pas. Cependant, presque toujours, vous verrez la plateforme indiquée— que le produit soit destiné au Macintosh, au PC, à UNIX, etc.
Exemple d'une page de couverture.
La couverture arrière des guides et manuels d'utilisateur en version papier est généralement très simple. En général, elle contient le numéro de commande du livre, le nom de l'entreprise avec les symboles de marque appropriés, un symbole de copyright et une mention concernant la propriété du livre, ainsi qu'une déclaration sur le pays où le livre a été imprimé. Vous trouverez également des codes-barres au dos de la couverture. Vérifiez si votre logiciel peut générer un code-barres—il vous suffit d'accéder à l'utilitaire de code-barres et de taper le numéro de commande du livre, et l'utilitaire génère le code-barres.
Page de titre
La page de titre est généralement un duplicata de la couverture avant, mais avec certains éléments omis. Sont généralement omis l'œuvre d'art, les logos d'entreprise ou de produit, et les slogans. Certaines publications techniques omettent complètement la page de titre en raison de la duplication apparemment inutile. (Et dans un tirage de 20 000 exemplaires, une seule page compte beaucoup !)
Exemple de page de titre.
Avis d'édition
L'avis d'édition est généralement la première instance de texte régulier dans une publication technique, bien qu'il soit généralement en plus petite taille. Il se trouve au verso de la page de titre. Si l'éditeur technique adopte une approche économe et écologique et élimine la page de titre, l'avis d'édition apparaîtra au verso de la première de couverture.
Personne n'aime lire les petits caractères, mais jetez un œil aux déclarations généralement incluses dans un avis d'édition :
Exemple d'avis de réédition
Marques déposées
Que vous listiez des marques déposées et comment vous écoutez est de la responsabilité des avocats de l'entreprise. Dans tous les cas, vous ne listez que les noms de produits déposés qui figurent dans ce guide de l'utilisateur particulier.
Le plus souvent, les marques sont indiquées :
- dans l'avis d'édition (comme l'illustration ci-dessus le montre)
- dans une section séparée quelque part dans le guide de l'utilisateur
mentionnez cette note
Si les avocats d'entreprise souhaitent que chaque occurrence d'un nom de produit protégé par une marque soit indiquée par un astérisque ou une note de bas de page, essayez de les dissuader de ce fiasco de design de page. Parsemer le texte d'astérisques ou de numéros de note est distrayant pour les lecteurs.
Garantie
Les garanties accompagnent les produits matériels physiques—et non les logiciels. Les avocats d'entreprise prennent en charge la langue et le format de la garantie. Si vous créez un exemple de guide utilisateur ou un livre pour votre portfolio, vous pouvez utiliser cet "exemple de garantie" anonyme.fenêtre contextuelle pour montrer que vous êtes conscient que les garanties doivent être incluses.
garanties logicielles ?Avertissements de sécurité
Les produits matériels ont généralement une section d'avertissements de sécurité au début de leurs livres. Ceux-ci peuvent apparaître comme une sous-section de la préface, par exemple, ou comme une section distincte à part entière. Ces sections rassemblent typiquement tous les avis de danger, d'avertissement et de prudence qui figurent dans le livre et les organisent d'une manière logique. Mais même avec cette alerte en amont, les livres matériels placent toujours les avis individuels aux endroits où ils s'appliquent. (Pour plus d'informations, voir avis spéciaux.)
Déclarations de communication
Les livres sur le matériel nécessitent également des déclarations de communication telles que stipulées par les gouvernements des pays vers lesquels ces produits sont expédiés. Aux États-Unis, la FCC exige certaines déclarations de communication en fonction de la "classe" du produit matériel. En tant qu'écrivain, vous devez veiller à utiliser la bonne déclaration de communication pour le produit que vous documentez — et ne pas modifier la déclaration de quelque manière que ce soit (mots légaux sacrés !).
Table des matières
La table des matières (TDM) contient généralement au moins un deuxième niveau de détail (les titres 1 dans le texte réel) afin que les lecteurs puissent trouver ce dont ils ont besoin plus précisément. Les auteurs, éditeurs et designers de livres discutent généralement de la séquence de la TDM. En termes d'ergonomie, il est bien mieux d'avoir la TDM aussi près que possible du début du livre, sinon à tout le début du livre. En ce qui concerne les aspects juridiques, cependant, les gens craignent que toutes ces déclarations de communication, garanties, droits d'auteur, marques déposées et avis de sécurité doivent venir en premier. Dans les cas où l'ergonomie l'emporte, les livres utilisent toutes les tactiques possibles pour faire sortir ce matériel légal des éléments préliminaires : les garanties sont mises sur des cartes séparées et conditionnées sous film avec le livre ou le produit ; les garanties, déclarations de communication, marques déposées et autres peuvent être reléguées dans des annexes.
Des difficultés à créer une table des matières bien formatée ? Voir Créer une table des matières au look professionnel
Liste des figures
Les manuels techniques pour les utilisateurs ordinaires n'ont généralement pas de listes de figures. En fait, les figures elles-mêmes n'ont généralement pas de titres complets. Mais cela ne signifie pas qu'une liste de figures n'a pas sa place dans les manuels techniques. Tout dépend du lecteur et de ses besoins— ainsi que du contenu du livre. Si le livre contient des tableaux, des illustrations, des graphiques, des diagrammes et d'autres éléments que les lecteurs souhaitent trouver directement, la liste des figures est de mise.
Préface
La fonction de la préface est de préparer les lecteurs à lire le livre. Elle le fait en :
- caractériser le contenu et le but du livre
- identifier ou même décrire brièvement le produit que le livre soutient
- expliquant le type de lecteur pour lequel le livre est destiné
- tracé des principaux contenus du livre
- montrant les conventions ou la terminologie spécifiques utilisées dans le livre
- fournir un soutien et des chiffres marketing, et d'autres éléments similaires
Dans l'édition traditionnelle de livres, la préface vient avant la table des matières ; mais comme discuté précédemment dans le table des matières section, les personnes de l'édition technique souhaitent que la table des matières apparaisse plus tôt dans le livre pour des raisons d'utilisabilité.
Chapitres du corps
Oh oui, et il y a du texte réel dans ces livres—ce n'est pas que des éléments préliminaires ! Peu d'autre à dire ici si ce n'est que la plupart des livres techniques ont des chapitres ou des sections, et, dans certains cas, des parties. Voir le chapitre sur conception de page pour des problèmes de format, de style et de conception concernant des éléments tels que les en-têtes, les pieds de page, les titres, les listes, les avis, les tableaux, les graphiques, les renvois et le surlignage.
Annexes
Comme vous le savez, les annexes sont destinées aux éléments qui ne semblent tout simplement pas s'intégrer dans la partie principale d'un livre mais qui ne peuvent pas non plus être omis. Les annexes sont souvent l'endroit où se trouvent de grands tableaux difficiles à manipuler. Certaines publications techniques contiennent des éléments comme des garanties dans les annexes. En termes de format, une annexe est identique à un chapitre—excepté qu'elle est nommée "Annexe A" ou quelque chose de similaire, et les en-têtes et pieds de page correspondent à cette convention de numérotation et de nommage différente (A-1, A-2, etc. pour les pages de l'Annexe A).
Glossaire
Certaines publications techniques incluent une section de termes spécialisés et de leurs définitions. Remarquez que la plupart des glossaires utilisent une mise en page à deux colonnes. En général, chaque terme et sa définition constituent un paragraphe séparé, le terme étant en minuscules (sauf s'il s'agit d'un nom propre) et en gras, suivi d'un point, puis la définition en romain standard. Remarquez aussi que les définitions ne sont généralement pas des phrases complètes. De bonnes définitions de glossaire devraient utiliser la technique de définition de phrase formelle telle que décrite dans le chapitre de définition de ce texte en ligne. Plusieurs définitions sont généralement identifiées par des chiffres arabes entre parenthèses. Les paragraphes du glossaire contiennent également Voir références aux termes préférés et Voir aussi références à des termes connexes.
Index
Les index sont généralement à deux colonnes et contiennent également Voir références aux termes préférés et Voir aussi références à des termes connexes. Voir le chapitre sur indexation pour les processus et les lignes directrices pour créer de bons index.
Formulaire de réaction du lecteur
Avant l'essor d'Internet et des médias sociaux, certaines publications techniques contenaient un formulaire papier pour permettre aux lecteurs d'envoyer des commentaires, des questions et une évaluation du livre. Bien sûr, il s'avère que ces formulaires suscitent plus souvent des plaintes concernant le dysfonctionnement du produit documenté par le livre. Avec l'essor d'Internet, ces formulaires ont été mis en ligne, et les livres se contentent d'indiquer leur emplacement en ligne.
Conception et mise en page de livre
Typiquement, les guides d'utilisateur et les manuels produits par les fabricants de matériel et de logiciels sont conçus de manière assez austère et spartiate. Les entreprises de haute technologie développent de nouvelles versions et des mises à jour de leurs produits parfois tous les neuf mois. Dans ce contexte, un design sophistiqué n'est tout simplement pas pratique. Voici quelques-unes des caractéristiques de mise en page et de conception typiques que vous verrez :
- La taille de la page est souvent déterminée par des considérations d'emballage ainsi que par les tailles de page standard disponibles auprès des entreprises d'impression. Lorsque la taille de la page n'est pas une contrainte, certaines entreprises utilisent la taille de page de 8,5 × 11 pouces— ce qui facilite beaucoup la production pour les rédacteurs.
- Les pages sont généralement conçues avec des pages droites et gauches alternées. Le pied de page de la page de gauche (paire) commence par le numéro de page et se termine par le titre du livre. Le pied de page de la page de droite (impaire) commence par le titre du chapitre et se termine par le numéro de page.
- Les pratiques varient quant à savoir si la numérotation des pages est consécutive dans tout le livre ou par chapitre.
- À moins que les pages ne soient plutôt petites, le design de texte en retrait des titres par rapport aux pages est assez courant dans les manuels techniques. Le retrait suspendu est généralement d'un pouce à un pouce et demi.
- Les polices sont souvent en Times New Roman taille 12 pour le texte principal et en Arial pour les titres. Un espacement de ligne et un espacement de mot standard sont utilisés. Voir le chapitre sur mise en évidence pour d'autres problèmes typographiques.
- Les marges sont assez standard, d'un à deux pouces tout autour. En général, on utilise un extra de demi-pouce sur les marges intérieures pour permettre la reliure.
- Typiquement, la couleur est pas utilisés dans ces manuels et guides, généralement pour des raisons de coût et d'efficacité.
Table des matières
TABLE DES MATIÈRES
Quel que soit le format de table des matières (TdM) que vous utilisez, voici les normes courantes :
- Numéro de page de départ uniquement. Bien que certains générateurs de table des matières automatiques affichent la plage de pages, la norme est le numéro de première page uniquement.
- Niveaux de titres à inclure. Comme indiqué dans la table des matières ci-dessus, affichez les deux premiers niveaux de titres à moins que le guide de l'utilisateur n'ait de nombreux sous-titres. La table des matières doit fournir un moyen rapide de trouver des informations.
- Espacement et capitalisation. Remarquez comment les éléments textuels dans la table des matières ci-dessus sont indentés. Les titres de premier niveau sont en majuscules ; les titres de deuxième niveau utilisent des majuscules au début de chaque mot principal ; les titres de troisième niveau utilisent des majuscules en style phrase.
- Espacement vertical. Remarquez que les sections de premier niveau ont un espace supplémentaire au-dessus et en dessous, ce qui augmente la lisibilité.
Selon les exigences de votre organisation, vous avez deux choix de format pour les tables des matières (TDM) :
Ce sommaire utilise un style de numérotation décimale pour les numéros de chapitre et de section, ce qui est courant dans les guides d'utilisateur. Les autres sections de ce livre utilisent le style des chiffres romains en majuscules uniquement pour les chapitres de premier niveau (voir ).
Des difficultés à créer une table des matières bien formatée ? Voir Créer une table des matières au look professionnel
Virgules et numéros de page. Si un format de point de leader n'est pas requis et que vous préférez l'éviter, vous pouvez utiliser ce format couramment accepté :
Voyez cet exemple de préface :
Texte de table des matières simple avec des virgules et un numéro de page.Liste des figures
Rarement inclus dans les guides d'utilisation...
-->Préface
Chapitres Principaux du Guide de l'Utilisateur
Annexes
Index
Autres éléments du guide de l'utilisateur
Titres
Listes à puces et numérotées
Symboles, Nombres et Abréviations
Titres des graphiques et des figures
Renvois croisés
Numérotation des pages
Invitations IA pour Guides d'Utilisation
Les listes de contrôle, qui restent généralement sans être lues, peuvent être utilisées comme source pour des invites d'IA avec quelques modifications. Copiez ce qui suit, collez-le dans un système d'IA tel que Gemini de Google, et voyez ce que vous avez peut-être manqué.
Remarque : Toutes les références au contenu, au format, au style des guides de l'utilisateur ou de leurs composants peuvent être trouvées dans le manuel de rédaction technique en ligne.
Lorsque vous souhaitez utiliser l'intelligence artificielle pour évaluer un projet d'écriture, présentez-vous, dites à l'IA qui vous êtes, ce que vous voulez. Donnez à l'IA un point de référence pour effectuer des évaluations, comme un manuel en ligne. Ensuite, publiez ce que vous souhaitez que l'IA vérifie dans son évaluation.
Modifiez l'introduction pour qu'elle corresponde à votre identité.
|
Guides d'utilisation des invites d'IA Bonjour, IA. Je demande que tu évalues les instructions rédigées par un étudiant de deuxième année d'université aux États-Unis. Voici un résumé des chapitres de manuel sur instructions et avis à utiliser comme base de votre évaluation. (Informations d'identification masquées) :
|
Informations connexes
Comment rédiger des sujets d'aide conviviaux pour les débutants. clickhelp.com
Comment rédiger une documentation utilisateur. techscribe
Manuels d'utilisation. techscribe
J'apprécierais vos réflexions, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.
