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 réelles ou aux pages 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 se produire 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 mises en évidence, etc.

Ce qui suit offre 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. Certainement, aucun guide utilisateur, 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 séquencés de la manière précise que vous allez lire. Au lieu de cela, cette revue donnera un aperçu des possibilités—disons de la gamme des 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 tous les autres éléments d'un guide utilisateur typique sont en place. (Je ne comprends pas ce "d" dans "Filepad" !) Soyez conscient qu'il n'utilise pas certaines des exigences en matière de police et de marges listées ci-dessous.

Avant de commencer à lire ce qui suit, prenez un certain nombre de 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 standard de l'industrie :

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

Couvertures avant et arrière

Les documents produits pour les clients payants ont généralement de belles couvertures, même si, à l'intérieur, le livre est de qualité très médiocre. Sur la couverture, vous verrez typiquement certains ou tous les éléments suivants :

Il peut être difficile de trouver 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 versions et les numéros de publication sur les couvertures avant— certaines le font ; d'autres ne le font pas. Cependant, presque toujours, vous verrez la plateforme indiquée— que le produit soit pour Macintosh, PC, UNIX, etc.

La couverture arrière des guides de l'utilisateur et des manuels imprimés 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 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 sur la couverture arrière. 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 une duplication 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 qui semble inutile. (Et dans un tirage de 20 000 exemplaires, une seule page compte beaucoup !)

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 caractères plus petits. Il se trouve au verso de la page de titre. Si l'éditeur technique adopte une approche éco-responsable en éliminant la page de titre, l'avis d'édition apparaîtra au verso de la couverture avant.

Personne n'aime lire les petits caractères, 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 cachés. Si un produit ou sa publication nécessite une page entière pour ses avertissements, je ne l'achète pas !

Marques déposées

Bien que de nombreuses entreprises répertorient leurs propres marques ainsi que 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 vous y conformer, peu importe à quel point la décision est mauvaise en termes de design du livre ou de style d'écriture. N'oubliez pas de lister uniquement les noms de produits déposés qui apparaissent dans ce livre particulier.

Vous remarquerez que certaines publications vont à des extrêmes avec les marques déposées : elles ajouteront une astérisque ou une note de bas de page à la première, ou même à chaque occurrence d'un nom de produit protégé. Mais encore une fois, ce sont des directives des avocats de l'entreprise auxquelles les rédacteurs techniques doivent se soumettre, aussi tristement cela puisse-t-il être.

Garanties

Plus de questions juridiques. Ce sont les "garanties" que l'entreprise apportera concernant son produit. Parfois, elles sont publiées dans les pages liminaires du livre ; mais, de manière plus appropriée du point de vue du design de 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 avec les avis d'édition, c'est un texte que vous apportez simplement en tant que "texte standard" et que vous positionnez au bon endroit dans le livre.

Cependant, vous devez être conscient que les entreprises conservent 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 types, aussi mal écrits soient-ils. Les modifications doivent généralement être approuvées 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é).

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 en tant que sous-section de la préface, par exemple, ou comme une section séparée à part entière. Ces sections rassemblent généralement tous les avis de danger, d'avertissement et de prudence qui apparaissent tout au long du livre et les organisent d'une manière logique. Mais même avec cet avis 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 comme l'exigent 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 être attentif à 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 (sacrés mots légaux !).

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 livre débattent typiquement de la séquence de la TDM. En termes d'ergonomie, il est beaucoup mieux d'avoir la TDM aussi près du début du livre que possible, sinon à tout début du livre. En termes de légalité cependant, les gens s'inquiètent que toutes ces déclarations de communication, garanties, droits d'auteur, marques déposées et avis de sécurité devraient venir en premier. Dans les endroits où l'ergonomie prime, les livres utilisent toutes les tactiques possibles pour faire sortir ce matériel légaliste de la matière préliminaire : les garanties sont mises sur des cartes séparées et emballées sous plastique 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 problèmes pour créer une table des matières bien formatée ? Voir Créer une table des matières au design professionnel

Liste des figures

Les manuels techniques destinés aux 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 des besoins du lecteur— ainsi que du contenu du livre. Si le livre contient des tableaux, des illustrations, des graphiques, des courbes, et d'autres éléments que les lecteurs voudront rechercher 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 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 arrive plus tôt dans le livre pour des raisons d'ergonomie.

Chapitres du corps

Oh oui, et il y a du texte réel dans ces livres—ce n'est pas que de la page de garde ! 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 design de page pour les problèmes de format, de style et de design pour 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 la mise en évidence.

Annexes

Comme vous le savez, les annexes sont destinées à des matériels qui ne semblent simplement pas s'intégrer dans la partie principale d'un livre, mais qui ne peuvent pas non plus être exclus du livre. Les annexes sont souvent l'endroit où se trouvent de grands tableaux encombrants. Certaines publications techniques ont des choses comme des garanties dans les annexes. En termes de format, une annexe est similaire à un chapitre—excepté qu'elle est nommée "Annexe A" ou quelque chose de similaire, et les en-têtes et les pieds de page correspondent à cette numérotation et ce nommage différents (A-1, A-2, et ainsi de suite pour les pages de l'Annexe A).

Glossaire

Certaines publications techniques comprennent une section de termes spécialisés et leurs définitions. Notez que la plupart des glossaires utilisent un format à deux colonnes. Typiquement, chaque terme et sa définition forment un paragraphe séparé, le terme en minuscules (sauf s'il s'agit d'un nom propre) et en gras, suivi d'un point, puis la définition en romain ordinaire. 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 en phrase formelle comme 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 de 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 aussi 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 de création de bons index.

Forme de réponse du lecteur

Avant l'essor d'Internet et des réseaux sociaux, certaines publications techniques contenaient 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 le mauvais fonctionnement du produit documenté dans le livre. Avec la montée d'Internet, ces formulaires sont devenus en ligne, et les livres ne font que pointer vers leur emplacement en ligne.

Conception et mise en page de livre

En général, 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 mises à jour de leurs produits parfois tous les neuf mois. Dans ce contexte, un design sophistiqué n'est tout simplement pas pratique. Voici quelques caractéristiques 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 conception de page, qui couvre éléments tels que les en-têtes et pieds de page, les titres, les listes, les avis spéciaux, les tableaux, les graphiques, le surlignage, les renvois, et plus encore.

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