Get best of the week

Comment faire comprendre votre article ou votre documentation rapidement et avec précision

Non seulement le contenu, mais aussi la structure du texte doivent avoir un sens.

Donc, si nous parlons d'un texte technique ou scientifique, par exemple un article ou une documentation, le formulaire devrait aider à comprendre rapidement et facilement le contenu. Pour moi, dans le cas de l'article, cela signifie que la structure devrait être quelque chose comme ceci:

  • Gros titre
  • L'essence de l'article
    Sur la base de ces quelques phrases, ainsi que du titre, le lecteur doit comprendre s'il souhaite lire cet article plus avant.
  • Résumé
    Ici, sous la forme la plus concise, la thèse, mais avec la précision et l'exhaustivité nécessaires, l'essence de cet article doit être reflétée - de plusieurs phrases à plusieurs pages. Quelqu'un au fond du sujet peut suffire à comprendre l'article dans son intégralité. Mais dans tous les cas, il est utile que le lecteur présente sous la forme la plus générale de quoi traite cet article et quelles conclusions il recevra à la fin.
  • La logique de l'article
    Si l'article est long, contient de nombreuses sections et une logique complexe, ce chapitre peut également être utile. Il s'agit essentiellement d'une table des matières étendue. Ici, brièvement, sur une ou deux pages, la logique du raisonnement est énoncée, sèchement, sans détails. Encore une fois, cela suffira pour que quelqu'un comprenne tout. Si c'est difficile, alors le lecteur peut sauter ceci (comme une table des matières) et continuer à lire.
  • Présentation simplifiée
    Si l'article est assez compliqué, alors il serait commode pour beaucoup de comprendre d'abord conceptuellement ce que l'auteur veut dire. Par conséquent, il est bon de tout d'abord dire comme si vous parliez aux étudiants, manquant des preuves complexes, et peut-être pas dans un langage aussi formel et strict. Pour tant de personnes, ce niveau de présentation peut être suffisant et elles s'arrêteront là.
  • Présentation stricte
    Voici une présentation strictement professionnelle.

Bien sûr, la structure ne doit pas être juste cela. Par exemple, selon la complexité et la longueur du texte, certaines sections peuvent être redondantes ou, inversement, peuvent être ajoutées, mais la structure doit être appropriée à cet effet. Dans ce cas, l'approche indiquée permet au lecteur de comprendre le contenu d'un article complexe le plus rapidement possible et avec le degré de profondeur nécessaire. J'ai utilisé cette approche lors de la rédaction de l'article Équations différentielles non linéaires, la discrétion de l'espace-temps et le produit epsilon . Vous verrez tous les articles sauf le dernier.

Je dois lire beaucoup de documentation technique. À mon avis, l'organisation généralement acceptée du texte n'est pas pratique. Je n'ai pas le temps (et l'envie) d'apprécier le développement cohérent de l'intrigue et la beauté de la syllabe, ce n'est pas "Guerre et Paix", j'ai seulement besoin d'informations et le plus vite, le mieux. Par conséquent, dans le cas d'un sujet nouveau et complexe, je dois d'abord parcourir le texte plusieurs fois à la recherche de significations, de conclusions et de logique, et seulement alors je pourrai le percevoir adéquatement. C'est-à-dire, en fait, je suis l'approche ci-dessus, mais d'une manière très gênante et longue, et il serait beaucoup plus pratique pour moi que les informations soient immédiatement organisées en conséquence.

More articles:


All Articles