Rapport INformatique

Rapport INformatique

Rédaction d’un rapport en informatique Corps du rapport : description du travail INTRODUCTION Ce document contient quelques conseils pour rédiger correctement un rapport de projet en informatique. Il est destiné principalement aux étudiants en sciences appliquées. Objectifs d’un rapport de projet p g Le rapport d’un proje du travail accompli. mer les professeurs Ces lecteurs, on peut raisonnablement le supposer, connaissent le problème et ont une bonne idée des éléments de solution.

Le second objectif d’un rapport de projet est l’apprentissage de la rédaction d’un rapport echnique. Pour cet aspect-ci, on doit supposer que le lecteur n’est pas un spécialiste du domaine et qu’il ne sait rien du projet. un rapport doit donc contenir tout ce qui est nécessaire pour donner un tel lecteur une perception correcte du travail accompli (ni plus, ni moins). Il faut donc avoir constamment à l’esprit que l’on ne rédige pas exclusivement pour les professeurs, mais bien pour ce type de lecteur « naif ». ‘un numéro de page. Introduction e but de l’introduction est de permettre à quelqu’un qui ne sait rien du travail accompli d’avoir une ue générale de ce qu’il fallait faire et de ce qui a été fait. Après avoir lu l’introduction,

Désolé, mais les essais complets ne sont disponibles que pour les utilisateurs enregistrés

Choisissez un plan d'adhésion
un lecteur doit en savoir assez pour décider s’il lira le rapport en entier. L’introduction doit situer brièvement le sujet du rapport et annoncer le problème qui a été étudié. Le cadre dans lequel le travail a été accompli est décrit lorsque c’est utile.

Si le rapport est long, on présente dans l’introduction la structure du rapport en annonçant les différentes parties du texte et leur contenu. • L’introduction doit être courte. L’essentiel doit se trouver dans es premières phrases. • N’oubliez pas que l’introduction doit accrocher le lecteur, lui donner envie de lire la suite. • Evitez d’entrer directement au cœUr du problème. Il faut situer celui-ci pour le lecteur, qui n’a pas été plongé dans le travail comme vous. Evitez de placer dans l’introduction des généralités hors sujet telles que « L’informatique est une science jeune qui ou « De nos jours, plus personne ne peut se passer d’un ordinateur » 1. Contenu du corps du texte Le but du corps du rapport est de faire connaître les points mportants du travail entrepris afin que le lecteur y trouve de l’intérêt. Si le lecteur doit entreprendre le même genre de travail, votre rapport doit lui permettre de mieux l’aborder, d’éviter de s’engager sur de fausses p 2 d’un projet en informatique, il est faux de penser que le lecteur trouve l’essentiel dans le listing d’un programme.

Au contraire, il faut traiter de l’analyse du problème, la gestion du projet, la réalisation et les tests. Il est intéressant de : o décrire la méthode de travail utilisée, la division du problème en sous-problèmes, la épartition des tâches parmi les membres de l’équipe du projet ; o détailler les difficultés rencontrées, les solutions possibles, la solution retenue et les raisons de ce choix ; o détailler la liste des objets manipulables, expliquer le choix de leur représentation (structures de données) ainsi que les opérations sur ces objets. 2.

Explications d’un algorithme Expliquer un algorithme consiste à décrire les étapes, les choix qui ont mene à celui-ci, ainsi que le comportement global de celui-ci. Les explications contiennent . o des exemples illustratifs, des schémas pour aider à la compréhension, o des justifications: pourquoi l’algorithme est correct (pré/post, invariants, etc. ), o un commentaire sur son efficacité et sur l’importance de celle-ci dans le programme. De nombreux exemples d’explications d’algorithmes se trouvent dans [Ah093]. En particulier, vous pouvez regarder les explications données sur le tri par sélection pages 30 à 33.

Les explications seront d’autant plus intéressantes qu’elles sont données avec un certain recul. Quand un programme a été écrit et que le programmeur décrit son travail, il doit eter un œil critique sur celui-ci en s’éloignant des détails de l’implémentation. 3 s’éloignant des détails de l’implémentation. Exemple d’un mauvais début de rapport: « La base de données a été réalisée par une liste chaînée de base unidirectionnelle, implémentée par des pointeurs, le nom de la variable attribuée est « atomO’ ‘ 3.

Réalisation Il faut présenter : o l’architecture modulaire de votre programme, o les spécifications du programme et de chaque sous- programme, o le rôle des variables, o des explications de certaines parties importantes du programme : ne « traduisez » pas les nstructions le code en français, mais expliquez plutôt le pourquoi de cette instruction. Exemple de mauvaises explications: « On initialise tout d’abord zéro les variables On amorce ensuite une boucle allant de 1 à 22. Dans cette première boucle, on initialise la variable j] à zéro.

Ensuite, Conclusion La conclusion d’un rapport de projet est essentielle: elle reprend les éléments importants de l’introduction et répond aux questions qui y ont été posées. La conclusion doit être courte, précise, concise. 2 La conclusion peut contenir des recommandations. Elle explique ourquoi la méthode utilisée était bonne, ou pourquoi elle était mauvaise. On y expliquera aussi ce que l’on a retiré du projet, quels ont été les points forts et les p Enfin, la conclusion 4 générale du travail effectué (sans les détails).

Bibliographie La bibliographie comprend tous les ouvrages • que vous avez consultés lors de votre travail • auxquels vous faites référence dans le rapport. Dans le texte, quand vous faites référence à un ouvrage cité dans la bibliographie, vous pouvez • soit indiquer le nom de l’auteur et la date : « dans les travaux de Dupont 941 », • soit indiquer un numéro de référence qui renvoie à la liste des références : « dans les travaux de J. Dupont [3] ». Dans la liste des références, la même notation est reprise, les ouvrages étant classés dans l’ordre alphabétique des auteurs ou dans l’ordre d’apparition dans le texte. our chaque ouvrage sont indiqués le nom de l’auteur ou des auteurs, le titre complet de l’ouvrage ou de l’article, l’éditeur ou le nom de la revue (4 le numéro de la revue), la ville où l’ouvrage a été édité, l’année et éventuellement les pages concernées. Il faut pouvoir retrouver l’ouvrage ou l’article aisément à partir de la référence. Annexes On met en annexe tout ce qui est utile à la compréhension du rapport ou qui fait partie des résultats du travail, mais qui n’a pas sa place dans le corps même du rapport, parce que cela alourdirait la lecture et détournerait l’attention du fil conducteur.

Exemples d’éléments à mettre en annexe : • résumé des notations utilisées, • cahier des charges initial, • document de spécification du ro ramme, • modes d’emploi du progr S concision un rapport n’est pas un roman. Il doit être condensé, sans mots inutiles. o Supprimez les mots flous, les redondances, les pléonasmes : « Nous avons développé un nouveau logiciel.  » o Evitez de recopier plusieurs fois les mêmes parties de texte : il vaut mieux l’écrire une première fois avec un repère et ensuite faire référence à cette partie au moyen du repère. Evitez de recopier textuellement des paragraphes qui se trouvent dans des notes de cours, des livres ou ailleurs, il vaut mieux en donner la référence. o Bannissez les mots ou expressions inutiles: « il est significatif de noter, inutile ‘ajouter, absolument unique, définitivement prouvé, complètement plein o Posez-vous constamment la question « faut-il vraiment écrire ceci et, si oui, pourquoi 3.

Varier les enchaînements La langue française possède suffisamment de mots permettant de lier les phrases entre elles pour choisir celui qui convient le mieux:  » mais, ou, et, donc, or, nl, car, au contraire, en revanche, à l’opposé, cependant, néanmoins, seulement, du moins, d’ailleurs, en effet, c’est-àdire, à savoir, aussi, ainsi, par conséquent, c’est pourquoi, en outre, de plus, enfin 4. S’efforcer à la clarté, la précision et la simplicité Clarté et précision vont de pair.

Si vous écrivez: « le logiciel obtenu est très grand », donnez un ordre de grandeur de sa taille. La cible de votre rédaction S e lecteur non averti ou le qu’ils ne pourraient pas comprendre. Abandonnez les mots imprécis comme « on, cela, peut-être, on pense que, il est établi, il semble que, il est possible que, on suppose que, j’ai l’impression que, . 5. Ajouter un peu de chaleur Un brin de chaleur ne dépare pas un rapport. Racontez comme on raconte une histoire, ou plutôt des histoires, avec ce qu’il faut de détails vécus et piquants.