Quelques conseils de présentation d`un document écrit

Master Outils & Systèmes de l’Astronomie et de l’Espace 2008-2009
Observatoire de Paris & Universités Paris 6, 7, 11
Quelques conseils de présentation d’un document écrit
Ce mémento explicite quelques règles utiles pour la rédaction d’un document tel un rapport de projet
ou de stage de Master.
– Les éléments, divers et variés, ont été notés et compilés à l’occasion des soutenances précédentes.
Ils portent essentiellement sur la forme d’un texte, mais vous montrent en quelle mesure celle-ci doit
accompagner le fond du message.
– Quasiment aucune de ces règles n’est circonstancielle ; elles s’appliquent en général à tout document
écrit qu’un ingénieur est amené à produire tout au long de son activité professionnelle, pour expliquer,
diffuser, rendre compte de son travail.
– Si ce mémento vous semble inutile, tant mieux... mais prenez d’abord la peine de le lire.
B. Mosser
LESIA, Observatoire de Paris
[email protected]
version 2.1, 12/09/08
2 . . . . . . . . . . . . . . . . . . . . . Outils & systèmes de l’astronomie et de l’espace . . . . . . . . . . . . . . . . . . . . .
1
Rendre compte
Un compte-rendu de stage (ou projet, TP...) rend
compte de votre travail de stage (projet, TP...).
Il présente le cadre de ce travail, la méthodologie
mise en œuvre, les questions abordées et réponses
apportées. Il énonce des résultats (au sens large),
mais aussi le processus ayant conduit à ce résultat.
Le document doit être à la hauteur du travail
fourni : le mettre en valeur, avec un éclairage
simple et précis de ce que vous avez réalisé.
2
Votre travail
Se mettre en juste valeur
Redde caesari quae Caeseri sunt
S’affirmer comme professionnel OSAE
Comme futur professionnel diplômé du Master
OSAE (du moins on l’espère), votre crédibilité
doit pouvoir être totale et sans équivoque sur
les notions clefs du Master : ingénierie-système,
technologies spatiales, projet, qualité.
Votre crédibilité nécessite entre autres que vous
maı̂trisiez les champs de compétences associés au
Master. Vous ne pouvez pas vous permettre de
vous mélanger les pinceaux sur des notions telles
que bruit ou signal, bruit parasite ou courant
d’obscurité, résolution spatiale ou dimension spatiale des pixels, espace réel ou espace de Fourier...
3
Mise en page et agencement
du document
La simple lecture d’un document doit permettre
de déterminer la part de travail de l’auteur, dans
un cadre bien plus vaste où certaines tâches ont
été réalisées collectivement, d’autres reprises sur
étagère, d’autres encore simplement remaniées, et
certaines faisant référence à d’autres travaux.
Il n’est pas interdit d’expliciter clairement : j’ ai
apporté ma contribution, dans le cadre d’un
travail que nous avons développé en collaboration
avec une autre équipe, en s’appuyant sur les
travaux de Machin & Chouette, dans le cadre
du modèle Bidule développé par l’entité Chose.
Ainsi, par cette démarche qui respecte un juste
partage des tâches et responsabilise vos propos,
votre propre contribution est mise en valeur.
Première page
S’affirmer comme ingénieur
Résumé
Après une longue formation universitaire ou
d’ingénieur, et avec à la clef un Master Pro, vos
compétences ne peuvent pas ne pas transparaı̂tre
dans votre production écrite. Un document écrit
raconte souvent autant par sa forme que par le
fond la qualité du travail effectué. Veiller à :
– l’emploi du vocabulaire adapté,
– l’emploi des notions adaptées,
– une méthodologie choisie.
Indispensable. Si le manuscrit de votre rapport
de stage de Master OSAE est en anglais, rajouter
un résumé, une introduction et une conclusion
en français. Si le manuscrit est en français, un
résumé en anglais fera du meilleur effet.
Ainsi, vous pouvez emporter l’assentiment de
votre lecteur, qui par la pertinence de votre
propos sera convaincu de la pertinence de votre
travail.
La 1ère page du rapport gagne à ne pas être
négligée. Mentionner :
– les établissements (votre université, le lieu et
l’équipe d’accueil), et ne pas oublier les logos,
– les acteurs (pas la peine de nommer le jury),
– les coordonnées précises du stage (lieu et date).
Plan
Éviter les plans en 2 parties, ou 14. Bien découper
les parties permet déjà de donner au lecteur des
clefs de compréhension du document. Une partie
en introduction situe nécessairement le cadre de
votre stage, une autre le cadre du travail.
Un plus certain : introduire des mots-clefs, si
possible standardisés.
Introduction
Une seule règle : le lecteur doit pouvoir saisir dès
l’introduction de quoi il retourne !
Une introduction qui introduit une thématique et
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Présentation de documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
des questions dans cette thématique sera certes
classique, mais ô combien appréciable.
4
La forme au service du fond
Traitement de texte
Conclusion
Des éléments de conclusion du style, ‘ce stage m’a
plu’ ou ‘merci les copains’ ou ‘c’est beau le Chili’,
sont totalement inintéressants. Se lancer dans
un panégyrique des objectifs d’une mission ou
d’un instrument, montrant avec force superlatifs
combien la science va être révolutionnée est tout
aussi inutile (de plus, c’est énervant).
En revanche, une description du travail effectivement réalisé (par rapport aux objectifs initiaux p.ex.), des méthodes et outils utilisés, des
compétences développées... apporte de vraies informations. Un retour tant qualitatif que quantitatif est nécessaire. Répondre en conclusion aux
questions posées en introduction reste incontournable, et très efficace.
Quelque soit le traitement de texte utilisé (LATEX,
word ou tout autre succédané ...), il est de bon
ton de s’en servir de façon raisonnée et maı̂trisée.
À qualité d’analyse égale, un texte bien présenté
a plus d’impact qu’un autre mal fichu.
Dans tous les cas, il est indispensable, dès lors
qu’un document prend quelque ampleur, de
définir une feuille de style, et d’utiliser des outils
classiques de références, listes de figures et de
tables, annexes...
Conseils :
- en LATEX, ne pas se laisser abattre par la rigueur
nécessaire à ce logiciel, mais la maı̂triser.
- sous word : ne pas s’y lancer sans feuille de
style ; ensuite, la respecter.
Figures et tables
Cf. ci-dessus : il faut rendre à César ce qui est à
César, car il est inadmissible, même par omission,
de ne pas citer les sources extérieures : cela revient
à s’approprier le travail d’autrui.
Bien citer les références utilisées, en respectant les
règles ad hoc.
Une figure doit être accompagnée d’une légende,
pour être lisible et compréhensible indépendamment du texte. Les axes se doivent d’être définis.
La taille de la figure et la clarté des axes doivent
être adaptées à sa lisibilité.
La numérotation des figures permet un appel aisé
dans le texte. Veiller à l’emplacement des figures
permet une mise en page aérée, sans rupture
brutale du texte. Idem pour les tables.
Annexe
Codage de la physique
Bibliographie, et références
Créer une annexe pour y mettre les
développements techniques importants qui,
dans le corps du manuscrit, ralentiraient trop la
lecture. Par exemple : une note technique ayant
résumé une part de votre travail.
Longueur du manuscrit
Plus que la longueur, c’est la qualité qui prime :
10 pages de travail effectif dans 80 pages de blabla
n’arriveront pas à donner du volume à votre
(absence de ;-) travail. Par expérience, 40 à 50
pages (hors annexe) suffisent amplement à rendre
compte d’un stage de 6 mois ; 10 à 20 pages d’un
projet.
La physique se code avec des règles précises, qui
ne doivent pas se diluer dans un traitement de
texte mal maı̂trisé. Si vous avez des équations
à coder, arrangez-vous pour qu’elles le soient
clairement.
Les erreurs les plus fréquemment rencontrées
portent sur les unités :
– avec de gros problèmes sur la lettre k (pour
kilo) : une fréquence peut se mesurer en kHz mais
pas en Khz, une masse en kg mais pas en Kg
– une température en ◦ C ou K, mais pas en ◦ K
(le kelvin est une unité absolue, et pas un degré).
– 1’ = 1 minute d’arc, et pas 1 minute de
temps ; de même 1” = 1 seconde d’arc (et
pas arcseconde) ; les notations pour les unités
temporelles sont min et s ; cette confusion peut
4 . . . . . . . . . . . . . . . . . . . . . Outils & systèmes de l’astronomie et de l’espace . . . . . . . . . . . . . . . . . . . . .
porter à conséquence, car en coordonnées célestes,
24 h ≡ 360◦ , et donc 1 min ≡ 15’ et 1 s ≡ 15”.
Les maladresses à éviter :
– confusion entre une grandeur physique et son
nom comme variable dans un programme informatique. Il n’est pas interdit de faire un tableau
de correspondance pour expliciter le fonctionnement d’un programme... ce qui déborde sûrement
le cadre d’un rapport général et synthétique, et
relève typiquement d’une annexe.
– confusion entre une variable physique codée en
italique, et tout autre élément (fonctions usuelles,
indices...) codé sans italique.
Toujours veiller à la justesse aux dimensions des
équations physiques (en espérant que cela reste
un problème de forme... et non une erreur plus
gênante).
Les équations doivent être codées proprement.
Quelques exemples et contrexemples :
signal
RSB = q
2
bruitphotons + bruit2lecture
S
←→ RSB = q
2
2
σph + σlec
des flemmards (en règle générale, vos lecteurs sont
et seront toujours des personnes compétentes surchargées de travail, qui apprécieront un document
concis, précis et bien écrit).
Syntaxe, grammaire
Ce qui se conçoit bien s’énonce clairement,
Et les mots pour le dire arrivent
aisément
(merci Monsieur Boileau). Si pour l’orthographe,
l’accumulation d’erreurs est gênante, pour la
grammaire et encore plus la syntaxe, de trop
nombreuses erreurs deviennent des fautes. Ceci
dit, on peut être un excellent ingénieur et avoir
dû affronter une dyslexie grave dans ses jeunes
années. Mais dans ce cas on le sait et on se corrige
encore plus.
En plus de l’impossibilité de lire un document
trop fautif, négliger les corrections de base (base
= école primaire), par exemple en semant la
confusion entre des homonymes tels on/ont,
son/sont, et/est, à/a ... ruine la crédibilité de
votre travail. A-t-il simplement été relu ? Est-il
fiable, s’il pêche sur des évidences ?
ou
G = 6.67.10− 11kg−1 m3 s− 2
←→ G = 6.67 10−11 kg−1 m3 s−2
Pas la peine d’insister sur l’avantage de LATEX
dans ce domaine, mais à la condition expresse
d’un bon usage de ce logiciel.
Orthographe
Les correcteurs orthographiques sont disponibles
partout, et il faut les utiliser à bon escient. Si une
co(q)uille est toujours acceptable, un amoncellement d’erreurs va nécessairement conduire le lecteur à remettre en doute le sérieux du document.
Lorsque les accents deviennent aléatoirement distribués, et les formes infinitives ou participes
mélangées, il devient impossible de lire rapidement le document. Or tout document doit pouvoir être lu rapidement... pour donner du temps
à la lecture attentive des passages importants, et
pas parce que les responsables du MasterPro sont
Vocabulaire
Toujours par souci de crédibilité, un document
scientifique se doit d’utiliser les termes appropriés
et les notions adéquates, sans jargonner. Si, par
exemple, dans la vie courante, poids et masse
prennent des sens équivalents, ce n’est pas le cas
en physique.
– ne pas appeler poids une grandeur qui est
une masse et se mesure en kg ; ne pas confondre
une puissance et une énergie, une énergie et une
chaleur...
– certains domaines comme la photométrie sont
piégeants ; là encore plus qu’ailleurs, définir très
précisément les grandeurs utilisées, ainsi que leur
unités.
– bien distinguer les notions de temps (la
variable), instant ou date, durée ou intervalle
de temps, période ; des expressions consacrées
telles constante de temps, temps de parcours...
emploient certes le mot temps, mais bien précisé
par le complément du nom.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Présentation de documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
– constant (dans le temps) et uniforme (spatialement) ne sont pas synonymes.
– un biais n’est pas un bruit, pas plus qu’un
signal parasite.
– échantillonnage et résolution ne sont pas
synonymes.
On peut noter que les erreurs qui relèveraient de
ce paragraphe peuvent dénoter des problèmes plus
graves que simplement de forme.