Caractéristiques
Directives
(note: Puisque les caractéristiques changent tellement considérablement de sujet au sujet, toutes les directives suivantes ne s'appliqueront pas dans tous les cas.)
Prenez le soin avec des prétentions au sujet de la connaissance de vos lecteurs. Presque toujours avec des caractéristiques, vous écrirez pour plus d'un lecteur. Savez leur fond, connaissance, et connaissance récente de votre sujet. Quand dans le doute, expliquez.
Vue d'ensemble les objectifs d'un processus, d'un projet, ou d'un matériel avant de commencer les détails spécifiques.
Essayez d'indiquer exactement et énoncer brièvement le nombre d'étapes, d'étapes, ou de composants dans le processus, l'instruction, ou la description. De telles pannes rendent le sujet entier plus compréhensible.
En décrivant le matériel, commencez par les pièces internes et déplacez-vous à l'externe ou vice versa, n'importe quel agencement semble plus logique. Cependant, ne vous déplacez pas dans les deux sens entre les deux agencements de détail.
Définissez les limites peu familières la première fois que vous les utilisez. Comment savez-vous dans un domaine technique qui les limites sont peu familières ? Encore, connaître vos assistances est essentiel. En général, il vaut toujours mieux de donner une définition "inutile" que pour omettre nécessaire.
Employez les abréviations pour couper la longueur de mot, mais assurez-vous qu'elles sont standard et bien connues.
Mentionnez en évidence toutes les mesures de sécurité et les répétez encore avant l'étape ou les sectionnez dans ce que la précaution devrait être prise.
Donnez les étapes dans la commande chronologique. Indiquez chaque étape dans une phrase séparée. Autrement, les étapes peuvent être comprises en tant qu'actions simultanées plutôt que séparées, séquentielles.
Écrivez les instructions dans l'humeur impérative : "surveillez ces boussoles pour..." plutôt que "ces boussoles devraient être surveillées pour..." ; "couvrez les surfaces d'aboutement d'extrémité de matériel approuvé de cachetage" plutôt que "les surfaces d'aboutement d'extrémité seront couvertes de matériel approuvé de cachetage."
Faites le complément des textes et de schémas, plutôt que le double. Par exemple, vous pouvez dire en texte comment des brides d'un tube sur un ajustage de précision de réduction et donnez les dimensions de tube dans un schéma. Le problème en répétant l'information dans deux endroits est double : 1) le schéma ou le texte peut être changé à certains date ultérieure sans accompagner des changements de l'autre document, ainsi ayant pour résultat les détails contradictoires ; 2) la même information peut être reformulée ainsi pour la "clarification," ayant pour résultat deux traductions séparées. Si vous devez répéter l'information dans deux endroits, assurez-vous que vos mots sont une répétition exacte.
Placez la table supportante, les croquis, les diagrammes, les photographies, ou les listes comme près de leur mention dans le texte comme possible.
Utilisez les chiffres au lieu des nombres écrits.
Donnez les genres, les classes, ou les catégories de matériaux en quelque sorte qui vous permet d'être spécifique pour toutes les situations. Pour faire ceci, commencez par les exceptions et puis le morceau dans des catégories de "tout le repos". Par exemple : Pipe: 3/8 pouce pour des toilettes et des fontaines de l'eau ; pouce de 1/2 pour tous les systèmes d'arroseuses ; 3/4 pouce pour toutes autres lignes de flottaison.
Cassez vers le haut longtemps les blocs de texte. Utilisez la section fréquente ou divisez en paragraphes les titres ; utilisez les listes ; ou les mots clés ou les expressions mis en majuscules, les impriment en italique, ou les soulignent. Ces aides permettent à votre lecteur d'écrémer comme avec un manuel de référence ou un document juridique sans grands blocs de lecture de texte. Mettez en valeur les détails significatifs seul en les plaçant dans un paragraphe séparé et court.
N'incluez pas "portée une section de travail". Son imprécision habituelle la rend sans signification et dangereuse. Comme d'autres introductions, la "portée des sections de travail" tendent à être complétant qui indique simplement, "plus tard moi vais vous dire quelque chose de important et spécifique." Ces sections peuvent être dangereuses : Les lecteurs peuvent jeter un coup d'oeil sur la section pensant qu'ils ont l'image entière et la trouvaille postérieure "mineur" étonne apprêter dans les sections détaillées. Quand la "portée des sections de travail" sont à leur meilleur -- détail -- elles deviennent redondantes.
N'utilisez pas les clauses tout-entourantes de crochet telles que ce qui suit : "la compagnie terminera et inclura tout pour la pleine exécution du système avec tout le travail sujet à l'approbation par nos ingénieurs." Ouvrez-vous à beaucoup de traductions, un tel moyen de commentaires habituellement, "conjecture ce qui peut indiquer plus tard cela que je veux que vous fassiez."
N'ajoutez pas "etc..." à la fin d'une liste. Ceci suggère que l'auteur ne sache pas ce que la liste se compose ou est trop paresseuse pour terminer de l'écriture. "etc..." seulement questions d'augmenter.
