diff options
| -rw-r--r-- | plan.tex | 128 |
1 files changed, 74 insertions, 54 deletions
@@ -5,70 +5,39 @@ \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. +\tablestables \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: +% Documentation Standard is described here +\section{Documentation} +This section describes the required documentation for the project, including the types of documents to be created and the standards they must adhere to. +\subsection{Documents} +This project consists of five main documents: \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}. + \item \textbf{Project Plan:} Contains all elements related to the + organization of the project, including timelines, milestones, roles, + responsibilities. + \item \textbf{Requirements:} Details the requirements and + user stories, including both functional and non-functional requirements. + \item \textbf{Research:} Consists of all research related to this project. + \item \textbf{Design:} Describes the design choices, including + architecture, user interface, and system components. + \item \textbf{Qualification:} Includes test cases, test plans, and quality measures to + ensure the project meets its requirements and standards. \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{Documentation Standard} -\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} +Work agreements are the expectations and commitments made by the team members. +This section includes details on roles and responsibilities, documentation of +work hours, protocols for handling absences or delays, guidelines for +addressing inconsistent participation, and procedures for weekly updates and +meetings. All team members reviewed and agreed to these terms. +\subsection{Project roles} \begin{itemize} \item \textbf{Loek Le Blansch}: Integrator \item \textbf{Wouter Boerenkamps}: Project Member @@ -131,10 +100,61 @@ 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 + +% 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 +% 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 \end{document} |