diff options
| -rw-r--r-- | plan.tex | 27 | ||||
| -rw-r--r-- | sources.bib | 36 |
2 files changed, 50 insertions, 13 deletions
@@ -26,7 +26,7 @@ The goal is to develop a custom game engine that meets the client's requirements \subsection{Result} The expected result is a well-documented, custom game engine that follows a structure similar to Unity. Additionally, a validation application should be provided to test and showcase the engine's capabilities. -\newpage + \section{Planning} % todo add table of deliverables @@ -35,7 +35,7 @@ week 7: sprint oplevering week 10: sprint oplevering, POC and design week 17: eind oplevering -\newpage + \section{Risks} \subsection{Techincal Risks} @@ -47,7 +47,7 @@ may hinder progress. \subsection{Measures} Scope Expansion: By writing detailed requirements and having weekly team meeting to check if the progress is within the scope should be sufficient to decrease the risk. Lack of Team Collaboration: Weekly team meetings will result is collaboration among team members and discussing what each other tasks is will decease this risk. -\newpage + % Documentation Standard is described here \section{Documentation} @@ -69,13 +69,13 @@ This project consists of five main documents:\noparbreak user interface, and system components. \item[Qualification] Includes test cases, test plans, and quality measures to ensure the project meets its requirements and standards. - \item[Working hours] - \item[Api referenece] + \item[Working hours] A tabel which includes all working hours of each team member. + \item[API Reference] Details the available endpoints, request and response formats, authentication methods, error codes, and examples for interacting with the project's API. \end{description} \subsection{Documentation Standard} -% todo add link to contributing in this repo -\newpage +The documentation standard can be found in the contributing.md \autocite{crepe:docs-standard}. + \section{Work Agreements} Work agreements are the expectations and commitments made by the team members. @@ -147,7 +147,7 @@ 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)} @@ -155,7 +155,7 @@ issues or project needs. The team will start using scrum after the initial fase of structering 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: +The Scrum board \autocite{miro:scrum-board} will consist of the following tabs: \begin{description} \item[Backlog]: This tab contains a list of all tasks and user stories that are planned for future sprints. @@ -183,7 +183,7 @@ TODO: add examples 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} @@ -192,15 +192,16 @@ GitHub is used for version management of both code and documentation, each in it 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} + \item Code Repository: crepe \autocite{crepe:code-repo} + \item Documentation Repository: crepe-docs \autocite{crepe:docs-repo} \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 +\subsection{Code standard} +The code standard can be found in the contributing.md \autocite{crepe:code-standard}. \end{document} diff --git a/sources.bib b/sources.bib index b088784..5848f86 100644 --- a/sources.bib +++ b/sources.bib @@ -12,3 +12,39 @@ institution = {RFC Editor}, } +@misc{miro:scrum-board, + author = {Jaro Rutjes}, + title = {Scrum Board on Miro}, + url = {https://miro.com/app/board/uXjVKjtdM64=/?share_link_id=303851465474}, + date = {2024-09-10}, +} + +@misc{crepe:code-repo, + author = {lonkaars}, + title = {Crepe Code Repository}, + url = {https://github.com/lonkaars/crepe}, + date = {2024-09-10}, +} + +@misc{crepe:docs-repo, + author = {lonkaars}, + title = {Crepe Documentation Repository}, + url = {https://github.com/lonkaars}, + date = {2024-09-10}, +} + +@misc{crepe:docs-standard, + author = {lonkaars}, + title = {Crepe Documentation Standard}, + url = {https://github.com/lonkaars/crepe-docs/blob/master/contributing.md}, + date = {2024-09-10}, +} + +@misc{crepe:code-standard, + author = {lonkaars}, + title = {Crepe Code Standard}, + url = {https://github.com/lonkaars/crepe/blob/master/contributing.md}, + date = {2024-09-10}, +} + + |