Dans ce chapitre, design de livre signifie le contenu, le style, le format, le design et la séquence des différents composants typiques d'un livre. "Composants" ici fait référence aux 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 n'importe où 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 fournit un aperçu des composants typiques d'un livre technique imprimé ainsi que du contenu, du format, du style et de la séquence de ces composants. Certes, aucun manuel d'utilisation unique, manuel de référence technique, document de référence rapide ou autre document de ce type n'aurait réellement tous ces composants conçus et ordonnés exactement de la manière dont vous allez le lire. Au lieu de cela, cet examen donnera un aperçu des possibilités—disons la gamme des possibilités.

Remarque : Actuellement, nous n'avons qu'un seul exemple. manuel d'utilisation développé dans FrameMaker puis exporté en PDF. Il manque un glossaire, mais toutes les autres parties d'un guide utilisateur typique sont en place. (Je n'arrive pas à comprendre ce "d" dans "Filepad" !) Soyez conscient 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 le logiciel afin de pouvoir comparer leur contenu, leur style, leur format et leur séquençage à ce qui est discuté ici.

Pour des détails encore plus précis que ceux que vous voyez ici, consultez ces deux ressources standard de l'industrie :

Vous pouvez voir des exemples de ces composants de livre dans Conception de Techdoc.

Couverture avant et arrière

Les documents produits pour les clients qui paient ont généralement des couvertures avant bien conçues, même si, à l'intérieur, le livre est de qualité médiocre. Sur la couverture avant, vous verrez typiquement certains ou la totalité des éléments suivants :

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 divisé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, on voit presque toujours la plateforme indiquée—que le produit soit destiné au Macintosh, au PC, à UNIX, et ainsi de suite.

La couverture arrière des guides utilisateur et manuels en version papier est généralement très simple. En règle générale, 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 phrase concernant la propriété du livre, ainsi qu'une déclaration indiquant dans quel pays 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 certains éléments sont omis. Sont généralement omis les illustrations, 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 !)

Avis de publication

L'avis de l'é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 de l'édition apparaîtra au dos de la couverture avant.

Personne n'aime lire les petites lignes, mais jetez un œil aux déclarations généralement incluses dans un avis d'édition :

Avertissements

Voir la section sur édition avis, où les avertissements sont généralement discrets. Si un produit ou sa publication a besoin d'une page entière pour ses avertissements, je ne l'achète pas !

Marques déposées

Bien que de nombreuses entreprises énumèrent leurs propres marques et celles d'autres entreprises dans le avis d'édition, certains préfèrent les lister sur une page séparée, juste après l'avis d'édition. Ces décisions de placement relèvent presque exclusivement des avocats de l'entreprise ; en tant qu'écrivain, vous devrez peut-être vous conformer, peu importe à quel point la décision est mauvaise en termes de design de livre ou de style d'écriture. N'oubliez pas que vous ne listez que les noms de produits déposés qui apparaissent dans ce livre particulier.

Vous remarquerez que certaines publications prennent des mesures extrêmes concernant les marques : elles utilisent un astérisque ou une note de bas de page pour la première, ou même chaque occurrence d'un nom de produit protégé par une marque. Mais encore une fois, ce sont des directives des avocats de l'entreprise auxquelles les rédacteurs techniques doivent se résigner, aussi tristement que cela puisse être.

Garantie

Plus de textes juridiques. Ce sont les "garanties" que l'entreprise soutiendra concernant son produit. Parfois, elles sont publiées dans le préambule du livre ; mais, de manière plus appropriée du point de vue du design du livre, elles sont imprimées sur une carte séparée et insérées dans le film plastique du livre ou du produit. Encore une fois, comme pour les avis d'édition, ce texte est simplement à considérer comme un "texte standard" et à positionner au bon endroit dans le livre.

Cependant, vous devez être conscient que les entreprises maintiennent parfois plusieurs versions des avis d’édition, des avis de sécurité, des garanties, des déclarations de communication et autres. En tant qu'écrivain, vous devez vous assurer que vous utilisez la bonne version (et, en découvrant laquelle est correcte, vous aurez l'occasion de sortir et de rencontrer beaucoup de nouvelles personnes dans l'entreprise !). Et quoi que vous fassiez, ne changez pas le texte de ces éléments standard, aussi mal écrits soient-ils. Les changements doivent généralement être approuvés par les avocats de l'entreprise (qui le font généralement à contrecœur et seulement après de nombreux efforts de votre part et après que beaucoup de temps se soit écoulé).

Avis de sécurité

Les produits matériels ont généralement une section d'avertissements de sécurité au début de leurs livres. Celles-ci peuvent figurer comme une sous-section de la préface, par exemple, ou comme une section distincte à part entière. Ces sections regroupent typiquement tous les avis de danger, d'avertissement et de précaution qui apparaissent dans le livre et les organisent d'une manière logique. Mais même avec cet avertissement en avant, 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 comme l'exige les gouvernements des pays vers lesquels ces produits sont expédiés. Aux États-Unis, la FCC exige certaines déclarations de communication selon la « classe » du produit matériel. En tant qu'écrivain, vous devez faire attention à 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 juridiques 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 écrivains, éditeurs et designers de livres discutent souvent de l'ordre de la TDM. En termes d'utilisabilité, il est préférable que la TDM soit aussi proche que possible du début du livre, si ce n'est pas au tout début. En revanche, en ce qui concerne les légalités, les gens craignent que toutes ces déclarations de communication, garanties, droits d'auteur, marques commerciales et avis de sécurité ne doivent venir en premier. Dans les cas où l'utilisabilité l'emporte, les livres utilisent toutes les tactiques possibles pour éliminer ce matériel légal du front matter : les garanties sont mises sur des cartes séparées et emballées sous film avec le livre ou le produit ; les garanties, déclarations de communication, marques commerciales et autres peuvent être reléguées dans des annexes.

Des problèmes pour 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 de figures complets. Mais cela ne veut pas dire qu'une liste de figures n'a pas sa place dans les manuels techniques. Tout dépend du lecteur et des besoins du lecteur— ainsi que du contenu du livre. Si le livre contient des tableaux, des illustrations, des graphiques, des diagrammes et autres éléments que les lecteurs voudront trouver directement, la liste des figures est nécessaire.

Préface

La fonction de la préface est de préparer les lecteurs à lire le livre. Elle le fait en :

Dans l'édition traditionnelle, la préface se trouve avant la table des matières ; mais comme discuté précédemment dans le table des matières Dans la section, les professionnels 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 de la matière préliminaire ! Peu d'autres choses à 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 les problèmes de format, de style et de design des éléments tels que les en-têtes, les pieds de page, les titres, les listes, les avis, les tableaux, les graphiques, les références croisées et le surlignage.

Annexes

Comme vous le savez, les appendices sont destinés à du matériel qui ne semble tout simplement pas s'intégrer dans la partie principale d'un livre mais qui ne peut pas non plus être omis. Les appendices sont souvent le lieu de grandes tables encombrantes. Certaines publications techniques contiennent des choses comme des garanties dans les appendices. En termes de format, un appendice est similaire à un chapitre, sauf qu’il est nommé "Appendice A" ou quelque chose du genre, et les en-têtes et pieds de page correspondent à cette convention de numérotation et de nomination différente (A-1, A-2, et ainsi de suite pour les pages de l'Appendice A).

Glossaire

Certaines publications techniques incluent une section de termes spécialisés et 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é, avec le terme en minuscules (à moins qu'il ne s'agisse d'un nom propre) et en gras, suivi d'un point, puis la définition en romain ordinaire. Notez également 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 comme décrit 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 également 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 directives concernant la création de bons index.

Formulaire de réponse du lecteur

Avant l'essor d'Internet et des réseaux sociaux, certaines publications techniques comprenaient un formulaire papier permettant aux lecteurs d'envoyer des commentaires, des questions et des évaluations du livre. Bien sûr, il s'avère que ces formulaires suscitent plus souvent des plaintes concernant des dysfonctionnements dans le produit que le livre documente. Avec l'essor d'Internet, ces formulaires sont passés en ligne, et les livres se contentent de pointer vers leur emplacement en ligne.

Conception et mise en page du livre

Typiquement, les guides d'utilisation et les manuels produits par les fabricants de matériel et de logiciels sont conçus de manière plutôt austère et spartiate. Les entreprises de haute technologie développent de nouvelles versions et des mises à jour de leur produit parfois tous les neuf mois. Dans ce contexte, un design sophistiqué n'est tout simplement pas pratique. Voici quelques-unes des caractéristiques typiques de mise en page et de design que vous verrez :

Remarque : Cela conclut la discussion sur le livre imprimé. composants. Pour compléter cet aperçu de la conception des livres imprimés, voir le chapitre sur design de page, qui couvre éléments tels que les en-têtes et les pieds de page, les titres, les listes, les avis spéciaux, les tableaux, les graphiques, les mises en surbrillance, les renvois, et plus encore.

J'apprécierais vos réflexions, réactions, critiques concernant ce chapitre : votre réponse.