diff --git a/modele/Makefile b/modele/Makefile new file mode 100644 index 0000000..2b6c6f2 --- /dev/null +++ b/modele/Makefile @@ -0,0 +1,25 @@ +NAME = rapport +BIBFILE = sources + +TEX = $(NAME).tex +SRC = $(TEX) +PDF = $(TEX:.tex=.pdf) + +TEXMK = latexmk -shell-escape -lualatex +WGET = wget -q --show-progress + +all: $(PDF) + +$(PDF): %.pdf: %.tex + @$(TEXMK) $< >/dev/null + bibtex $(BIBFILE) + @$(TEXMK) $< >/dev/null + $(TEXMK) $< + +EXTS = aux fdb_latexmk fls log nav out snm synctex.gz toc bbl blg +clean: + rm -rf $(PDF) _minted-$(NAME)/ $(foreach ext,$(EXTS),$(NAME).$(ext)) + +updatepackage: + @$(WGET) https://git.mylloon.fr/Paris7/rapport-stage-template/raw/branch/main/rapstage.cls \ + -O rapstage.cls diff --git a/modele/images/logo.png b/modele/images/logo.png new file mode 100644 index 0000000..27c0c17 Binary files /dev/null and b/modele/images/logo.png differ diff --git a/modele/rapport.tex b/modele/rapport.tex new file mode 100644 index 0000000..485b3c8 --- /dev/null +++ b/modele/rapport.tex @@ -0,0 +1,177 @@ +\DocumentMetadata{testphase = {phase-II}} +\documentclass[]{rapstage} + +% Couleurs +\usepackage[dvipsnames]{xcolor} + +\title{Titre du rapport} +\me{Prénom}{Nom}{} +\date{2023/2024} + +% Tuteurs +\tuteurpedago{Prénom \textsc{Nom}}{} +\tuteurentreprise{Prénom \textsc{Nom}}{} + +% Bibliographie +\bibliofile{sources} +\nocite{*} + +\begin{document} +\maketitle +\clearpage + +\section{Introduction} +% TODO + +\section{Contenu du rapport} +\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).} + +\section{Présentation de l'entreprise, division, unité, service\dots} +\color{red} +\textbf{Une page maximum} + +\color{blue} +Contenu : présentation qui permet de comprendre le cadre où votre stage +s'est déroulé + +\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. + +\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{1em} +\color{blue} +\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 temps-réels\dots + +\vspace{1em} +\color{red} +\textbf{A 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 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. + +\section{Présentation de \textcolor{red}{votre} travail} +\color{blue} +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. + +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 + +\newpage +\appendix +\section*{\appendixname} +\addcontentsline{toc}{section}{\appendixname} +% Annexe + +\end{document} diff --git a/modele/sources.bib b/modele/sources.bib new file mode 100644 index 0000000..2dbf1f8 --- /dev/null +++ b/modele/sources.bib @@ -0,0 +1,4 @@ +@misc{example, + author = {Example}, + howpublished = {\url{https://fr.wikipedia.org}} +}