Je dois écrire des documents techniques tels que des manuels, des rapports et des articles de revues.
Récemment, je commence des phrases par « This » la plupart du temps. Par exemple,
Déployez une bouée de marquage à lemplacement GPS de lancre et une autre à lemplacement GPS du cadre. Cela rend la navigation beaucoup plus facile.
ou
Les fichiers journaux seront analysé pour les paramètres détalonnage et autres métadonnées. Ce processus peut prendre quelques minutes pour les fichiers très volumineux.
ou
Si de nouvelles piles ont été insérées, le magnétomètre doit être recalibré. Cette opération est similaire au recalibrage souvent requis lors de lutilisation dune boussole de téléphone intelligent.
Ces phrases sont-elles correctes ou y a-t-il dautres constructions de phrases qui se lisent mieux? Dois-je simplement laccepter et passer à autre chose?
Commentaires
- Les documents techniques doivent être rédigés pour plus de clarté, pas délégance ou de style supérieur. Je pense que les exemples que vous avez fournis sont clairs et nécessitent moins de traitement cognitif que les alternatives. Je leur dis de rester avec eux et de continuer.
- Cela rend la navigation beaucoup plus facile. Cela ferait bla. Cela rend la navigation bla. En vérité, en vérité, je vous dis que cela faciliterait beaucoup la navigation.
Réponse
Il y a un avantage distinct de continuer à faire ce que vous avez fait jusquà présent.
Cest que la répétition du modèle
Demander au lecteur dexécuter une action,
immédiatement suivi de
Description / commentaire concernant le résultat et / ou lavantage de laction,
diminue la charge cognitive de vos lecteurs « : ils ne sont pas constamment tenus deffectuer le travail supplémentaire dinterprétation dune variété des formats de présentation et des structures de phrases afin de trier les instructions des descriptions, ou de comprendre leurs relations mutuelles.
La façon dont vous présentez actuellement les informations à lire ers leur permet de savoir immédiatement ce que lon attend deux et pourquoi.
Le fait dune phrase commençant par « Ceci » est en fait un signal utile à vos lecteurs que ce qui va suivre est probablement une description ou un commentaire concernant une action que vous venez de leur demander deffectuer.
Cet aspect de la présentation du matériel est un moyen important par lequel la documentation technique diffère de la fiction littéraire.
Selon le style de lauteur de fiction, une partie du plaisir de lire la fiction dépend dêtre surpris par des juxtapositions inattendues et de petites énigmes, dont certaines sont créées ou rendues plus intrigantes en variant la façon dont le matériel est présenté au lecteur.
Dans votre cas, vous visez (ou devriez être) pour le résultat inverse: la prévisibilité de votre présentation et la clarté de la compréhension de vos lecteurs iront de pair. La brièveté relative des phrases et la répétitivité du format dans votre documentation réduisent la possibilité de créer une ambiguïté involontaire.
Cela vaut la peine de porter en min d une raison importante pour éviter toute ambiguïté dans la documentation technique: non seulement cest ennuyeux, mais cela peut même être dangereux ou dommageable si un lecteur est confus en exécutant une action incorrecte (comme mettre sous tension un circuit qui ne devrait pas être sous tension).
Commentaires
- @geometrikal – Il ‘ est probablement la jalousie de mes oreilles pointues et de mon joli petit nez.
- Une excellente réponse @Erik Kowal. Cest pourquoi je lai voté pour 🙂
Réponse
Presque tous les mots ou expressions peuvent être surutilisés, mais nommer un sujet (agent, « personnage » ou sujet) dans une phrase et le référencer avec ceci dans la phrase suivante est un excellent moyen daider les lecteurs à traverser un passage avec clarté et facilité. Cest un exemple dun type principal de chaîne de sujet , un élément stylistique essentiel de la plupart des bonnes écritures.
Il est possible que vous trouviez parfois une meilleure façon de formuler, généralement en allongeant la phrase précédente dune ou plusieurs clauses; mais – surtout lorsque vous « traitez un contenu complexe – moins de phrases longues peut aider vos lecteurs à traiter. (Il ny a rien de mal avec des phrases longues bien structurées, mais je préfère les paires de phrases dans vos exemples à toute façon dont je peux penser à les combiner.)
Dans la fiction avec beaucoup de dialogue, nous sommes trouvent souvent de nombreuses occurrences du mot dit. Il nest pas automatiquement préférable de les parcourir et dessayer de remplacer beaucoup dentre eux par des verbes alternatifs ( pleuré, marmonné, émis etc.). Certains mots sont répétés souvent sans attirer lattention sur la répétition. Cest (!) Parce quils remplissent bien et silencieusement leurs fonctions prévues.
Réponse
Toutes les phrases me semblent correctes. Mais si vous voulez vous débarrasser du «ceci» au début de la deuxième phrase, vous pouvez réécrire un peu la première phrase.
Par exemple, au lieu de
Déployez une bouée de repérage à lemplacement GPS de lancre et une autre à lemplacement GPS du Cadre. Cela rend la navigation beaucoup plus facile.
write
Déploiement dune bouée de marquage à la position GPS de lancre, et une autre à la position GPS du cadre facilitent la navigation.
Au lieu de
Les fichiers journaux seront analysés pour les paramètres détalonnage et autres métadonnées. Ce processus peut prendre quelques minutes pour les fichiers très volumineux.
write
Lanalyse des fichiers journaux pour les paramètres détalonnage et dautres métadonnées peut prendre quelques minutes pour les fichiers très volumineux.
À mon avis, le troisième exemple est probablement le meilleur laissé tel que vous lavez cité.
Commentaires
- Comme je suppose que vous vous en rendez compte, vos alternatives changent la signification des paires de phrases originales. Votre premier changement perd la fonction principale de loriginal: linstruction de déployer. Votre deuxième modification perd la fonction principale de loriginal: informer quune analyse va se produire.
- Pour la première, vous pouvez utiliser la voix passive: La navigation est facilitée par le processus. Mais ce nest pas la plus grande des phrases. Pour le second, quen est-il de » Des fichiers très volumineux peuvent faire que ce processus prenne quelques minutes « ?