Veuillez cliquer ici pour aider. David McMurrey payer sa facture d'hébergement web :
Faites don de tout montant même petit que vous pouvez !
La rédaction technique en ligne restera gratuite.
Formulation du Titre
Les titres de documents plus longs tels que les techdocs formels, les guides d'utilisation et les livres blancs sont parfois trop brefs. Par exemple, si le titre d'un techdoc était "Rapport sur la Pollution Plastique", le document pourrait faire plus de 300 pages. S'il était "Évaluation des Méthodes de Recyclage du Plastique", le document pourrait être plus gérable.
Bien sûr, vous ne voulez pas qu'un document ait le titre de celui que John Milton, le poète anglais, a créé en 1641 : De la Réforme de la Discipline de l'Église en Angleterre : Et les Causes qui l'ont jusqu'à présent entravée. Deux Livres, Écrits à un Ami.
Pensez à toutes les choses que vous pourriez dire sur chacun de ces sujets ! Il est également important de noter que les lecteurs ne sauront tout simplement pas, à partir de tels titres, ce que vous allez vraiment aborder.
Éléments de la formulation du titre
Lorsque vous rédigez un titre pour votre document, envisagez d'indiquer ces éléments sans créer un titre qui fasse un paragraphe de long :
- Sujet : Le sujet de votre document peut être similaire à ces exemples ci-dessus. Mais ne vous arrêtez pas là—vous avez encore du travail à faire.
- Portée : Le périmètre fait référence à la largeur ou à la profondeur de votre concentration sur le sujet. Le périmètre et l'aperçu ne sont pas toujours faciles à distinguer. L'élément aperçu indique un examen général de certains aspects du sujet.
- Aperçu : Dans le contexte utilisé ici, un aperçu fait référence à une énumération des principaux sous-thèmes à aborder. Certes, cela est contradictoire avec la façon dont le terme est utilisé pour définir la portée. Pas de souci—ce n'est pas de la science. Un bon exemple de cette utilisation du terme est le suivant : Ebola : Transmission, Symptômes, Traitement. Les trois derniers mots sont l'énumération.
Remarquez que le processus de création d'un titre spécifique et ciblé est similaire au processus de rétrécir un sujet, couvert ailleurs.
Exemples de formulation de titres
Considérez ce titre : Nanotechnologie : Aperçu des Applications Médicales. Le sujet géant nanotechnologie est en effet mentionné, mais notez qu'il est restreint à applications médicales et un élément de portée est appliqué—aperçu.
Remarquez l'utilisation du deux-points dans l'exemple précédent. Cela vous permet de réduire le nombre de mots. Une autre possibilité est Applications médicales de la nanotechnologie : Aperçu.
Formulation du titre du problème
Un problème courant avec les documents techniques concerne des titres trop généraux et vagues, par exemple :
Rapport sur la nanotechnologie
Rapport sur l'Ebola
Rapport sur les Smartphones
Rapport sur l'énergie solaire
Rapport sur le Graphène
Conception et Format de la Page de Garde
Le chapitre sur conception de la documentation technique présente une idée assez spartiate de la page de titre, montrée ici à gauche. Cependant, de nombreux techdocs contiennent de belles images sur la page de titre, comme montré à droite :
 |
 |
J'apprécierais vos réflexions, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.
