X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;ds=sidebyside;f=appli%2FcreaNewProject%2FNewProject%2Fdoc%2FUserDocumentation%2FUserDocumentation.tex;fp=appli%2FcreaNewProject%2FNewProject%2Fdoc%2FUserDocumentation%2FUserDocumentation.tex;h=f49e631637705f59b3f025978ec8ebcf0ad927f5;hb=1105ecb7bc1fab95fd553ab104275df6506fea22;hp=95105532d440559e7ebc89bc9a8f86dd4c3e7f5d;hpb=7d1be46f5e0f987f125785da9c0dd1ce53fb5fca;p=crea.git diff --git a/appli/creaNewProject/NewProject/doc/UserDocumentation/UserDocumentation.tex b/appli/creaNewProject/NewProject/doc/UserDocumentation/UserDocumentation.tex index 9510553..f49e631 100644 --- a/appli/creaNewProject/NewProject/doc/UserDocumentation/UserDocumentation.tex +++ b/appli/creaNewProject/NewProject/doc/UserDocumentation/UserDocumentation.tex @@ -3,47 +3,68 @@ \documentclass[11pt,final,a4paper]{article} \input{config.tex} \begin{document} -\bbtkGuide[Package Developers' Guide] +\UserDocumentGuide[User Documentation Guide] \newpage % ========================================== - - - % ========================================== \section{Introduction} % ========================================== - -Introduction - -\begin{enumerate} -\item \textbf{Subject 1 } -This is described in section \ref{Section1}. - -\item \textbf{Describe your new box.} -You can do it either : +Introductory paragraph to the content of the document +% ========================================== +% ========================================== +\section{Objectives} +% ========================================== +\subsection{General Objective} +% ========================================== \begin{itemize} -\item In \CPP code. You will have to write the class for -your box, mostly using \bbtk macros. -\item In \xml code. -When configuring your project with \cmake, -the utility \bbfy will then generate the corresponding \CPP code. +\item{\bf Objective 1} General description of the +objectives \end{itemize} - -This is described in section \ref{CreateBlackBox}. - -\end{enumerate} - % ========================================== -\section{Subject 1} -\label{Section1} % ========================================== - +\subsection{Specific Objectives} % ========================================== -\subsection{SubSection 1} +\begin{itemize} +\item{\bf Objective 1} Detail description of the +objective +\item{\bf Objective n} Detail description of the +objective +\end{itemize} +% ========================================== +\section{Scope and Vision} +% ========================================== +Scope and vision of the system to analyze +What is the reaching point of the system? +% ========================================== +\section{General Description} +% ========================================== +General description of the whole module +% ========================================== +\section{Requirements List} +% ========================================== +\begin{itemize} +\item{\bf Req1} Description of the +requirement +\item{\bf Reqn} Description of the +requirement +\end{itemize} +% ========================================== +\section{Analysis and design of the requirements} +% ========================================== +% ========================================== +\subsection{Req1} +% ========================================== +Detailed description of each req +% ========================================== +\subsection{Reqn} +% ========================================== +% ========================================== +\section{Glosary} +% ========================================== +% ========================================== +\section{Anexes} % ========================================== -Description of the SubSection - \end{document}