\documentclass{projdoc}
\input{meta.tex}

\title{Project Plan}

\begin{document}

% Information regarding the git workflow of this project. Diagram explaining the workflow
\section{Git Workflow}

GitHub is used for version management of both code and documentation, each in its own respective repository.
This keep the documentation and code seperate, resulting in ordened and manageable repositories. 

\begin{itemize}
    \item Code Repository: \href{https://github.com/lonkaars/crepe}{crepe}
    \item Documentation Repository: \href{https://github.com/lonkaars/crepe-docs}{crepe-docs}
\end{itemize}

\subsection{Git new branch}
% TODO: add here details from contributing.md?
\subsection{Git merge to master}
% TODO: add here diagram on what actions are taken before merge.
\newpage

% Information about how and when Scrum will be used in this project (using Miro).
\section{Scrum (Miro)}

The team will start using scrum after the inital fase of sructering the project is over.
This fase is over when proof of concepts are being made.

\subsection{Scrum Board}
The \href{https://miro.com/app/board/uXjVKjtdM64=/?share_link_id=303851465474}{Scrum board} will consist of the following tabs:
 
\begin{itemize}
    \item \textbf{Backlog}: This tab contains a list of all tasks and user stories that are planned for future sprints.
    \item \textbf{Next Sprint}: This tab includes tasks and user stories that have been selected for the upcoming sprint.
    \item \textbf{Current Sprint}: This tab displays the tasks and user stories that are actively being worked on in the current sprint.
    \item \textbf{In Progress}: Tasks that are actively being worked on are moved to this tab.
    \item \textbf{Review}: Completed tasks that are awaiting review or testing will be placed in this tab.
    \item \textbf{Done}: Once tasks have been reviewed and are considered complete, they are moved to the Done tab.
    \item \textbf{Blocked}: This tab is used for tasks that cannot proceed due to obstacles or dependencies.
\end{itemize}

\noindent
To manage tasks effectively:
\begin{itemize}
    \item A task from the \textbf{Current Sprint} tab should be selected and moved to the \textbf{In Progress} tab when work begins. 
    \item The status of the task should be updated to \textbf{In Progress} as soon as work starts.
    \item Once the task is completed and reviewed, it should be moved to the \textbf{Done} tab, and its status should be updated to \textbf{Done}.
\end{itemize}

\noindent
Each task or user story will be assigned user points, which indicate the relative size or complexity of the task compared to these examples.
TODO: add examples

\subsection{Burn down chart}
The Burn Down Chart will be generated using Excel from the Scrum board data every week.
Each user story or tasks marked as done will burn the chart downwards.
This Burn down chart is shared in the weekly updates with the team and the project supervisor.
\newpage

% Documentation Standard is described here
\section{Documentation Standard}
\newpage

\section{Documents}
\newpage

\section{Work Agreements}
\subsection{Project roles}

\begin{itemize}
    \item \textbf{Loek Le Blansch}: Integrator
    \item \textbf{Wouter Boerenkamps}: Project Member
    \item \textbf{Jaro Rutjes}: Team Leader / Scrum Master
    \item \textbf{Max Smits}: Project Member
    \item \textbf{Niels Stunnebrink}: Project Member
\end{itemize}


\subsection{Work hours}
Each project member will keep track of their own working hours and 
add them to the 'file'.

\subsection{Absents or delay}
If a project member is going to be absent or delayed, they are required to notify the 
team through either WhatsApp or Outlook. Additionally, the teacher should 
be informed of the absence as well.

\subsection{Inconsistent Participation}
Inconsistent participation will be addressed in a structured manner:

\begin{enumerate}
    \item \textbf{Initial Discussion}: The team leader will first discuss the 
    issue of inconsistent participation with the individual team member.
    \item \textbf{Team Discussion}: If no improvement is observed, the issue 
    will be brought up with the entire team to seek a collective solution.
    \item \textbf{Project Supervisor Involvement}: Should the problem persist 
    despite these efforts, it will be escalated to the project supervisor for 
    further action.
\end{enumerate}

Valid reasons for absence or inconsistency will be considered, and no 
repercussions will be necessary in such cases. However, if the inconsistency 
is due to other factors, potential repercussions may include additional 
assignments or actions as determined by the project supervisor.

A team member is considered to have inconsistent participation if their hours 
are significantly behind the team’s average or if tasks are not completed 
without valid reasons. It is essential that any concerns regarding a team 
member's performance be resolved through unanimous agreement within the team.


\subsection{Weekly update}
Each team member is required to send their technical weekly update to Jaro 
Rutjes before 12:00 on Friday. Personal updates may also be included and will be kept 
confidential between the team member, the Team Leader, and/or the teacher, 
if requested.

Jaro Rutjes will compile and send a team update to the project supervisor,
Bob van der Putten, also by Friday. This update will include technical 
information on what has been accomplished, plans for upcoming work, and an 
overview of the team's overall progress.

\subsection{Weekly meetings}
The project team will hold at least two meetings each week, with each meeting 
lasting a maximum of 30 minutes. Following these meetings, an additional one 
hour will be scheduled for discussions on the topics covered.

Meetings will be planned and discussed one week in advance, with invitations 
sent via Outlook. Additional meetings may be scheduled if necessary to address 
issues or project needs.


\newpage



\end{document}

