Conception de page signifie des choses différentes pour différentes personnes, mais ici cela désignera l'utilisation de la typographie et du formatage comme vous le voyez dans des documents professionnellement conçus.
Notre objectif ici est la documentation technique, ce qui implique un design modeste et fonctionnel.
Pour des détails encore plus précis que ce que vous voyez ici, consultez ces deux ressources standard de l'industrie :
- Publications Techniques Sun. Lisez-moi d'abord ! Toute édition récente. Prentice Hall.
- Microsoft Corporation. Manuel de style Microsoft pour publications techniques. Toute édition récente. Microsoft Press.
En-têtes et Pieds de page
Les gens confondent souvent les en-têtes avec les titres. Les titres, abordés dans titres est-ce que ces phrases se produisent dans la zone corporelle d'un document. Les en-têtes sont ces phrases et éventuellement les numéros de page apparaissant dans la zone d'en-tête d'un document. Les pieds de page sont ces phrases et éventuellement des numéros de page qui apparaissent dans la zone de pied de page d'un document. Une erreur courante, et une grande, est de mettre le titre d'un document dans l'en-tête, ce qui le fait apparaître en haut de chaque page suivante.
Jetez un œil à un diagramme d'une page de document typique :
Un design de page commun consiste à placer le titre du document et le numéro de page dans la zone de pied de page. Dans un format alterné, la page de gauche pourrait afficher le numéro de page et le titre du document, dans cet ordre ; la page de droite pourrait afficher le titre du document et le numéro de page, dans cet ordre.
Titres
Les éléments suivants présentent quelques-unes des directives standard sur les titres. Pour une discussion plus détaillée, voir le chapitre sur titres dans le manuel en ligne.
- Faites un usage libéral des titres, peut-être un titre pour chaque deux à trois paragraphes. Bien sûr, les titres peuvent être exagérés : de nombreux titres avec seulement une ou deux phrases par titre ne fonctionnent pas.
- Concevez des titres de manière à ce qu'ils indiquent clairement leur niveau. Utilisez la taille de police, le style de police, la couleur, le gras, l'italique, et l'alignement de façon à ce que le niveau du titre soit évident. ("Niveaux" des titres sont comme des niveaux dans un plan : le premier niveau correspondrait aux chiffres romains ; le deuxième niveau, aux lettres majuscules ; et ainsi de suite.)
- Rendez les titres descriptifs des sections qu'ils introduisent. Des titres comme "Contexte Technique" n'indiquent rien à personne.
- Créer des titres parallèle dans la formulation. Le parallélisme envoie aux lecteurs des indices importants sur le fait que la section est similaire dans sa nature à celles qui la précèdent.
- Évitez les "titres isolés"—c'est le même concept que d'avoir un "A" sans un "B" ou un "1" sans un "2" dans les plans.
- Évitez les "titres empilés"—c'est deux ou plusieurs titres consécutifs sans texte intervenant.
- Évitez de faire référence aux titres avec des pronoms dans le texte suivant les titres. Si vous avez un titre comme "Configuration du logiciel," ne le suivez pas par une phrase comme "Cette prochaine étape..."
- Envisagez d'utiliser le format "tête suspendue" pour faire ressortir les titres et réduire la longueur des lignes de texte normal. Dans le design à tête suspendue, certains ou tous les titres sont alignés à la marge gauche, tandis que tout le texte est en retrait d'un à deux pouces.
- Considérez l'utilisation de titres "intégrés" pour votre niveau de titre le plus bas. Il peut être difficile de se fier uniquement au style et à la taille de la police pour indiquer les niveaux de titre. Un titre intégré "s'intègre" dans le début d'un paragraphe et se termine par un point. Vous pouvez utiliser une combinaison de gras, d'italique ou de couleur pour ces titres.
Listes
Les listes sont des outils utiles pour souligner des points importants, permettant une lecture rapide du texte et offrant plus d'espace blanc. Ce qui suit présente quelques-unes des directives standard concernant les listes. Pour une discussion plus détaillée, voir le chapitre sur listes.
- Utilisez des listes numérotées pour les éléments qui sont dans un ordre requis ou qui doivent être référencés par un numéro. Utilisez des listes à puces pour les éléments sans ordre requis.
- Utilisez le format de liste numérotée et à puces standard disponible dans les styles de paragraphe des logiciels de traitement de texte, des balises HTML, et autres.
- Rédiger la formulation des éléments de la liste. parallèle.
- Introduisez toutes les listes avec un préambule ; n'utilisez pas de titres comme préambules pour les listes.
- À moins que le style de votre organisation ne prévienne le contraire, ponctuez les éléments de la liste d'un point final uniquement s'ils sont des phrases complètes ou contiennent des propositions subordonnées intégrées.
- Utilisez soit une majuscule initiale, soit des minuscules pour le premier mot des éléments de la liste, mais faites-le de manière cohérente.
- Pour les listes imbriquées, utilisez un tiret median en gras pour le symbole de puce dans les éléments de liste au deuxième niveau ; utilisez des lettres minuscules pour les éléments de liste numérotés au deuxième niveau. Assurez-vous que les éléments imbriqués s'alignent sur le texte ou le niveau précédent.
- Évitez l'utilisation excessive de listes ou de listes avec trop d'éléments. Sept à dix éléments est généralement considéré comme le maximum pour les listes.
Avis
Les avis sont ces morceaux de texte spécialement formatés qui alertent les lecteurs sur des points spéciaux, des exceptions, des problèmes potentiels ou des dangers. Les lignes suivantes présentent quelques-unes des directives standard pour les avis. Pour une discussion plus détaillée, voir le chapitre sur avis.
- Utilisez une hiérarchie standard des avis dans laquelle les avis sont plus proéminents et remarquables à mesure qu'ils deviennent plus graves.
- Considérez utiliser cette hiérarchie :
- avis de danger pour des situations impliquant des blessures graves potentielles ou un décès
- avertissements pour des situations impliquant des blessures mineures
- précautions pour les situations impliquant des dommages à l'équipement ou aux données ou une menace pour le succès de la procédure
- notes pour des points d'exception ou d'emphase ne concernant pas les situations précédentes.
- Quel que soit le design de l'avis que vous utilisez, évitez le texte étendu en gras, en italique, en majuscules, ou en combinaisons de ceux-ci.
- En plus de dire aux lecteurs de faire ou de ne pas faire quelque chose, expliquez ce qui se passera s'ils ignorent l'avertissement, dans quelles conditions utiliser l'énoncé, comment se rétablir si l'énoncé est ignoré.
- Rendez le texte des avis concis, mais sans sacrifier la clarté. Évitez un style télégraphique (omission d'articles comme). a, un, le) dans les avis.
- Dans les listes numérotées, alignez les avis à le texte de l'élément de la liste auquel ils s'appliquent.
- La sagesse standard de placer des avis avant l'étape dans laquelle le problème potentiel existe peut causer des problèmes de mise en forme. Si possible, indiquez les avertissements, les précautions ou les dangers au début de l'ensemble de la procédure.
Figures
Les figures sont toutes sortes d'illustrations, de dessins, de schémas, de photos, etc. Voir graphismes pour une discussion détaillée. En attendant, voici quelques points importants :
- Dans le texte avant la figure, fournissez une référence croisée à la figure.
- Bien qu'il ne soit pas absolument nécessaire d'inclure une légende (titre) pour chaque figure, lorsque vous le faites, placez-la en dessous la figure.
- Par exemple, dans les instructions où les figures sont étroitement liées aux étapes individuelles, les titres des figures n'ont pas de fonction essentielle et ne sont pas nécessaires.
Tables
Les tableaux sont comme des listes verticales, discutées précédemment, mais plus structurés et formels. Dans votre texte, recherchez des paires, triplets ou quadruplets d'éléments qui peuvent être formatés sous forme de tableaux. Par exemple, une série de termes et de définitions est une utilisation classique des tableaux. Ce qui suit présente quelques lignes directrices standard pour les tableaux. Pour une discussion plus détaillée, voir le chapitre sur tables.
- Recherchez des groupes d'éléments répétitifs dans votre texte que vous pouvez formater sous forme de tableaux.
- Dans le texte avant le tableau, fournissez une référence croisée au tableau.
- Utilisez un titre de tableau sauf si le contenu du tableau est totalement évident et que le tableau contient peu d'éléments. Placez le titre du tableau. au-dessus la table, ou en faire la première ligne de la table.
- Utilisez des en-têtes de colonnes et de lignes (ou les deux) pour définir le contenu des colonnes et des lignes. Envisagez d'utiliser un type de surlignage pour ces en-têtes de colonnes et de lignes.
- Aligner à gauche les colonnes de texte (à moins qu'il s'agisse d'éléments simples de caractères alphabétiques). Aligner à gauche les colonnes de texte avec leurs en-têtes.
- Aligner à droite ou aligner décimalement les données numériques, et les centrer sous leur titre.
- Mettez des unités de mesure standard (ft, mm, gal.) dans l'en-tête de colonne ou de ligne plutôt qu'avec chaque élément de la colonne ou de la ligne.
- Fournissez une brève discussion de la tendance principale dans le tableau—ce que vous souhaitez que les lecteurs remarquent.
Surlignage
La documentation logicielle utilise généralement beaucoup de mises en évidence. La mise en évidence ici fait référence au gras, à l'italique, aux polices alternatives, aux majuscules, aux guillemets et à d'autres astuces typographiques utilisées pour attirer l'attention sur le texte. Ce qui suit présente quelques directives standards pour la mise en évidence. Pour une discussion plus détaillée, voir le chapitre sur mise en évidence.
- Établissez un plan pour l'utilisation de la mise en surbrillance et appliquez-le de manière cohérente. Utilisez la mise en surbrillance pour des raisons spécifiques et fonctionnelles. Évitez trop de mise en surbrillance ; évitez les schémas de mise en surbrillance compliqués.
- Considérez l'utilisation de ce schéma de mise en surbrillance assez standard :
- Pour un simple accent, utilisez l'italique.
- Utilisez **gras** pour les commandes, les boutons à l'écran et les options de menu.
- Utilisez des italiques pour les variables pour lesquelles les utilisateurs doivent fournir leurs propres mots.
- Utilisez une police alternative pour le texte affiché à l'écran ou pour le texte que les utilisateurs doivent taper.
- Pour les noms d'écran et de champ, utilisez le style de capitalisation montré à l'écran, mais aucun autre surlignage.
- Utilisez une majuscule initiale pour les noms clés mais pas d'autres mises en valeur.
- Pour une emphase prolongée, utilisez le format d'avis.
Marges, Retraits et Alignement
Comme mentionné dans la section sur les titres, une touche agréable est d'indentation le texte d'un à deux pouces tout en laissant les titres sur les marges de gauche. Ce style fait deux choses : il fait ressortir les titres et il réduit la longueur des lignes du texte normal.
Polices et Couleur
Voici quelques suggestions concernant les polices et les couleurs :
- Utilisez une seule police alternative, au maximum deux. Par exemple, vous pourriez utiliser Arial pour les titres, Times New Roman pour le texte principal et Courier New pour le texte affiché à l'écran ou que les utilisateurs doivent saisir.
- Si vous utilisez de la couleur, utilisez-la de manière minimale. Par exemple, si vous avez du texte noir sur un fond blanc, vous pourriez sélectionner une autre couleur pour les titres. Vous pourriez utiliser cette même couleur pour les titres des figures et des tableaux ainsi que pour les étiquettes des avis (les véritables étiquettes "Remarque," "Avertissement," "Précaution," et "Danger" sur les avis).
- Évitez les combinaisons inhabituelles de couleurs de fond et de texte. Par exemple, du texte violet ou rouge sur un fond noir est horrible à lire. Restez avec du texte noir sur un fond blanc ou gris, à moins qu'il n'y ait une raison fonctionnelle forte pour une autre combinaison de couleurs.
J'apprécierais vos pensées, réactions, critiques concernant ce chapitre : votre réponse.
