271 lines
11 KiB
TeX
271 lines
11 KiB
TeX
\DocumentMetadata{testphase = {phase-II,sec,toc,graphic,minipage,text,firstaid}}
|
|
\documentclass[n]{rapstage}
|
|
|
|
% Couleurs
|
|
\usepackage[dvipsnames]{xcolor}
|
|
|
|
\title{Titre du Rapport}
|
|
\me*{Prénom}{Nom}
|
|
\date{20../20..}
|
|
|
|
% Tuteurs
|
|
\tuteurpedago*{Prénom \textsc{Nom}}
|
|
\tuteurentreprise*{Prénom \textsc{Nom}}
|
|
|
|
% Bibliographie
|
|
\bibliofile{sources}
|
|
\nocite{*}
|
|
|
|
% Commande pour ajouter un lien
|
|
\newcommand\link[1]{\href{#1}{\texttt{\textcolor{blue}{\ul{#1}}}}}
|
|
|
|
\begin{document}
|
|
\maketitle
|
|
\clearpage
|
|
|
|
\section{Introduction}
|
|
\color{ForestGreen}
|
|
Ce modèle explique les règles pour la mise en page du rapport et donne
|
|
aussi une idée du contenu à présenter.
|
|
|
|
Les règles de mise en page servent à faciliter la lecture - et finalement la
|
|
compréhension - du rapport et doivent être respectées : vous devez utiliser les
|
|
styles dont on va parler \textbf{sans les modifier ! (sauf si l'entreprise où vous
|
|
réalisez votre stage vous impose un format)}.
|
|
|
|
Il est recommandé d'utiliser LibreOffice que vous pouvez obtenir gratuitement
|
|
(\link{https://www.libreoffice.org/}) et d'utiliser le modèle que nous
|
|
vous fournissons. Si vous utilisez un autre éditeur de texte, il vous faut
|
|
respecter les règles de styles données par la suite.
|
|
|
|
\color{black}
|
|
\subsection{Mise en page}
|
|
\color{ForestGreen}
|
|
Le rapport doit être rédigé sur du papier format A4 (21x29,7 cm), recto verso
|
|
avec une distance de 4 cm pour la marge gauche, 2 cm pour la marge droite,
|
|
et 3,5 cm pour les marges supérieures et inférieures. Les pages doivent être
|
|
numérotées progressivement au pied de la page au centre
|
|
(style : \texttt{PageRapportDeStage}). Les exceptions à ce style sont les
|
|
pages du titre (style : \texttt{FrontPage}), la bibliographie et les annexes.
|
|
|
|
Les titres de sections utiliseront la police \textbf{Arial de dimension 18 en
|
|
gras} (style : Heading~1), et les titres des sous sections la police
|
|
\textbf{Arial de dimension 14 en gras et italique} (Heading~2).
|
|
|
|
L'alignement du texte doit être justifié forcé et la font doit être
|
|
\textbf{\mbox{Times New Roman} de dimension 12}, sauf cas échéant.
|
|
L'interligne doit être de \textbf{1,15 ligne. (style :
|
|
\texttt{TexteDeRapportDeStage})}. Le style du texte s'occupe aussi d'indenter
|
|
la première ligne de chaque paragraphe, ce qui aide à comprendre la structure
|
|
du texte et les changements du sujet traité.
|
|
|
|
ATTENTION au copier/coller qui peuvent changer le style du document !
|
|
|
|
% Note : L'avantage de LaTeX est que vous n'avez pas besoin de vous soucier
|
|
% des soucis de mise en page.
|
|
|
|
\newpage
|
|
\color{red}
|
|
Les images ne \textbf{doivent surtout pas} être placées au milieu du
|
|
\begin{figure}[H]
|
|
\centering
|
|
\includegraphics[alt={Logo large},width=.49\textwidth]{images/wide_logo.png}
|
|
\includegraphics[alt={Logo large},width=.49\textwidth]{images/wide_logo.png}
|
|
\end{figure}
|
|
\noindent
|
|
texte, car cela coupe le flot et complique la lecture. L'image ci-dessus est un
|
|
exemple de ce qu'il ne faut pas faire Les expressions comme "ci-dessus" ou
|
|
"ci-dessous" sont absolument à éviter, car ambiguës.
|
|
|
|
\color{ForestGreen}
|
|
La façon correcte d'insérer des images dans le rapport et d'en parler est de
|
|
les placer séparément du texte (par exemple en haut, en bas des pages ou à
|
|
l'extérieur de paragraphe), les numéroter, leur donner une description
|
|
(Utiliser sous LibreOffice Insérer caption), et d'y faire référence en
|
|
utilisant leur numéro. Par exemple, la "caption" de l'Illustration 1 esquisse
|
|
le contenu de l'illustration, qui montre le logo de l'Université Paris Cité.
|
|
|
|
\begin{figure}[h]
|
|
\centering
|
|
\includegraphics[alt={Logo large},width=1\textwidth]{images/wide_logo.png}
|
|
\caption{Logo de l'Université Paris Cité}
|
|
\end{figure}
|
|
|
|
\color{black}
|
|
\subsection{Format du rendu}
|
|
\color{ForestGreen}
|
|
Le rapport final doit être rendu en format PDF. Il est très facile de générer un document PDF avec LibreOffice. Pour cela, il suffit d'exporter le rapport en PDF (menu \mbox{\texttt{File $\rightarrow$ Export As $\rightarrow$ Export as PDF}}).
|
|
|
|
\newpage
|
|
\color{black}
|
|
\section{Contenu du rapport}
|
|
\color{ForestGreen}
|
|
Jusqu'ici on s'est occupé de la forme/mise en page de ce rapport. On vous
|
|
rappelle le guide sur le contenu de ce rapport donné sur la page web suivante :
|
|
|
|
\color{black}
|
|
\subsection{Objectifs principaux d'un rapport de stage}
|
|
\color{ForestGreen}
|
|
Décrire ce que vous avez fait, conçu, réalisé. Pour ce faire, décrire de manière
|
|
minimale les prérequis permettant au jury/lecteur de comprendre votre travail.
|
|
|
|
Décrire ce que vous avez appris au cours de votre réalisation. Quelles nouvelles
|
|
compétences avez-vous acquises, sur le plan des connaissances, sur le plan des
|
|
méthodes.
|
|
|
|
Quelles perspectives techniques envisageriez-vous pour la suite de ce travail,
|
|
si on vous en donnait la liberté et les moyens ?
|
|
|
|
Existe-t-il à votre avis d'autres approches permettant de résoudre le problème
|
|
dont vous avez été chargé ? Fournissez, si possible, quelques références
|
|
(logiciels commerciaux, ou libres), et comparez synthétiquement avec votre travail.
|
|
|
|
Prendre du recul et exposer brièvement :
|
|
\begin{itemize}
|
|
\item ce qui dans votre formation universitaire vous a servi au cours de
|
|
ce stage,
|
|
\item ce qui a manqué dans votre formation universitaire,
|
|
\item ce qui a manqué au cours de vote stage pour faciliter votre travail
|
|
\end{itemize}
|
|
|
|
\color{red}
|
|
\textbf{
|
|
En particulier, le rapport doit être au minimum de 25 pages, et ne doit
|
|
pas dépasser le 40 pages (incluant la bibliographie et les annexes).}
|
|
|
|
\color{black}
|
|
\subsection{Plan à suivre}
|
|
\color{ForestGreen}
|
|
Dans la suite, nous donnons une proposition de plan en utilisant
|
|
le style fourni.
|
|
|
|
\color{black}
|
|
\section{Présentation de l'entreprise, division, unité, service\dots}
|
|
\color{red}
|
|
\textbf{Une page maximum}
|
|
|
|
\color{RoyalBlue}
|
|
Contenu : présentation qui permet de comprendre le cadre où votre stage
|
|
s'est déroulé
|
|
|
|
\newpage
|
|
\color{red}
|
|
\textbf{À ne pas faire :} Retracer l'histoire d'IBM depuis sa création, les
|
|
variations du cours en bourse et la glorification des diverses inventions de la
|
|
société. Donner l'évolution du chiffre d'affaires sur les 5 dernières années.
|
|
Décrire l'application phare de la société en long en large et en travers,
|
|
surtout si vous n'avez pas travaillé sur cette application.
|
|
|
|
\color{black}
|
|
\section{Présentation du projet, de l'application}
|
|
\color{red}
|
|
\textbf{5 à 8 pages}
|
|
|
|
\color{ForestGreen}
|
|
Il y a trois grands types de stages :
|
|
\begin{itemize}
|
|
\item S1 : Développement d'une application, d'un module, de tests, \dots
|
|
\item S2 : Déploiement, installation, configuration, personnalisation d'une
|
|
application
|
|
\item S3 : Maintenance d'applications existantes
|
|
\item S4 : S4 : Stage de recherche
|
|
\end{itemize}
|
|
|
|
Ces types de stages correspondent à des métiers existants en informatique.
|
|
Il n'y a pas lieu de valoriser un type de stage par rapport à un autre.
|
|
|
|
Le résultat du stage sera évidemment différent suivant son type. Le contenu
|
|
de votre rapport et de votre exposé seront aussi différents en fonction du type
|
|
de stage. Dans tous les cas, une présentation succincte de l'application sera
|
|
la bienvenue.
|
|
|
|
\vspace{2em}
|
|
\color{RoyalBlue}
|
|
\textbf{Contenu :} Présentez de manière simple (simplifiée) le but et le
|
|
fonctionnement de l'application. Attention à ne pas (trop) utiliser les termes
|
|
métiers (jargon bancaire, assurance, \dots). N'utilisez que le strict minimum
|
|
nécessaire à la compréhension de votre travail. Soyez précis ET concis.
|
|
|
|
Utilisez des exemples -judicieux- représentatifs, illustrant le fonctionnement
|
|
principal de l'application. Si votre travail porte sur des cas moins courants,
|
|
couvrez aussi ces cas moins courants par un exemple.
|
|
|
|
Décrivez l'architecture de l'application, en gros blocs, mentionnez les
|
|
systèmes, langages, composants et protocoles utilisés. Cela doit permettre
|
|
d'avoir une compréhension TECHNIQUE INFORMATIQUE générale des mécanismes
|
|
mis en œuvre.
|
|
|
|
Si nécessaire / possible donnez aussi une indication des performances :
|
|
traitements/secondes, empreinte mémoire, volume de données traitées,
|
|
débit réseau, consommation CPU induite, contraintes en temps-réels\dots
|
|
|
|
\newpage
|
|
\color{red}
|
|
\textbf{À ne pas faire :}
|
|
|
|
NE PAS Décrire de manière exhaustive l'application.
|
|
|
|
Pas de Copier-Coller aveugle et abusif : De nombreuses documentations techniques
|
|
ou marketing peuvent exister dans l'entreprise où vous effectuez votre stage.
|
|
Elles s'adressent à des connaisseurs (développeurs ou clients) du domaine
|
|
fonctionnel (composante du métier). Elles ne sont pas forcément la meilleure
|
|
source pour votre propre rapport, destiné à un jury. Cela vous évitera
|
|
d'utiliser un discours formaté où les mots sont parfois trop généraux pour
|
|
permettre une compréhension correcte et pertinente.
|
|
|
|
NE PAS Citer les autres applications utilisées sans définir TRÈS SUCCINCTEMENT
|
|
le rôle de ces applications complémentaires. Personne ne sait ce que
|
|
fait l'application Zilborion V7.0 de la société BestSoft.com. Tout le monde
|
|
comprend qu'elle produit un rapport PDF à partir d'une base de données
|
|
suivant des critères fournis en entrée.
|
|
|
|
\color{black}
|
|
\section{Présentation de \textcolor{red}{votre} travail}
|
|
\color{RoyalBlue}
|
|
C'est le contenu de cette section qui dépend le plus du type de votre stage.
|
|
C'est ici qu'il faut décrire ce que vous avez réellement fait.
|
|
Sans être exhaustif il faut fournir les éléments permettant au jury
|
|
d'appréhender :
|
|
\begin{itemize}
|
|
\item la complexité du problème qui se posait à vous,
|
|
\item les solutions que vous avez considérées et le choix que vous avez
|
|
retenu en le motivant,
|
|
\item les techniques et mécanismes utilisés, mis en œuvre,
|
|
\item des exemples de \textcolor{red}{votre} code,
|
|
\item la pertinence de votre solution.
|
|
\end{itemize}
|
|
|
|
Là encore, en fonction du type de stage effectué, le contenu sera différent.
|
|
Pour les stages de type "développement", on décrira les grands algorithmes
|
|
mis en place, on donnera une idée du volume de code (nombre de lignes,
|
|
taille du binaire, \dots) et on \textbf{inclura des exemples du code produit}
|
|
(dont la taille totale pourrait par exemple occuper entre 1 et 5 pages,
|
|
en cumulé)\dots
|
|
|
|
Pour les stages de type déploiement, on décrira, si possible, l'environnement
|
|
dans lequel ce déploiement s'est effectué : architecture du réseau, organisation
|
|
emplacement des bases données, authentification des utilisateurs, etc.
|
|
de manière à donner une vue d'ensemble qui permette de comprendre la complexité
|
|
de votre travail, et comment il s'insère dans le reste du système.
|
|
|
|
\newpage
|
|
Pour les stages de maintenance, on décrira, si possible, l'architecture de
|
|
l'application sur laquelle la maintenance s'est effectuée, plutôt que le
|
|
processus de mise en ouvre de la maintenance. Si vous avez modifié une
|
|
application, vous devriez normalement en maitriser l'architecture globale
|
|
et certains détails pour les modules sur lesquels vous êtes intervenus.
|
|
Comment avez-vous fait pour obtenir cette maîtrise, qu'est-ce qui vous
|
|
a posé problème ?
|
|
|
|
\color{black}
|
|
\reference*{ % bibliographie
|
|
\noindent
|
|
Le style des pages de la bibliographie doit être "\texttt{Bibliographie}". \\
|
|
Le style de chaque entrée de la bibliographie doit être "\texttt{BibEntry}".
|
|
}
|
|
|
|
\annexe
|
|
% Annexe
|
|
|
|
|
|
\end{document}
|