From 9fe6992c089af618f0f75c2aaa1f851fc3b6b493 Mon Sep 17 00:00:00 2001
From: Robert Jandow <38583713+robertjndw@users.noreply.github.com>
Date: Tue, 2 Jul 2024 12:30:04 +0200
Subject: [PATCH] Move proposal content into subfolder and update its TODOs
 (#40)

---
 content/proposal.typ                       | 63 ----------------------
 content/proposal/abstract.typ              |  8 +++
 content/proposal/introduction.typ          | 11 ++++
 content/proposal/motivation.typ            | 12 +++++
 content/proposal/objective.typ             |  9 ++++
 content/proposal/problem.typ               | 10 ++++
 content/proposal/schedule.typ              | 11 ++++
 content/proposal/transparency_ai_tools.typ |  7 +++
 proposal.typ                               | 18 ++++++-
 9 files changed, 84 insertions(+), 65 deletions(-)
 delete mode 100644 content/proposal.typ
 create mode 100644 content/proposal/abstract.typ
 create mode 100644 content/proposal/introduction.typ
 create mode 100644 content/proposal/motivation.typ
 create mode 100644 content/proposal/objective.typ
 create mode 100644 content/proposal/problem.typ
 create mode 100644 content/proposal/schedule.typ
 create mode 100644 content/proposal/transparency_ai_tools.typ

diff --git a/content/proposal.typ b/content/proposal.typ
deleted file mode 100644
index eee8654..0000000
--- a/content/proposal.typ
+++ /dev/null
@@ -1,63 +0,0 @@
-#import "/utils/todo.typ": TODO
-
-#TODO(color: red)[ // Remove this block
-  Before you start with your thesis, have a look at our guides on Confluence!
-  #link("https://confluence.ase.in.tum.de/display/EduResStud/How+to+thesis")
-]
-
-#set heading(numbering: none)
-= Abstract
-#TODO[ // Remove this block
-  *Abstract*
-  - Provide a brief summary of the proposed work 
-  - What is the main content, the main contribution?
-  - What is your methodology? How do you proceed?
-]
-
-#set heading(numbering: "1.1")
-= Introduction
-#TODO[ // Remove this block
-  *Introduction*
-  - Introduce the reader to the general setting 
-  - What is the environment?
-  - What are the tools in use?
-]
-
-
-= Problem
-#TODO[ // Remove this block
-  *Problem description*
-  - What is/are the problem(s)?
-  - Identify the actors and use these to describe how the problem negatively influences them.
-  - Do not present solutions or alternatives yet!
-  - Present the negative consequences in detail
-
-]
-
-
-= Motivation
-#TODO[ // Remove this block
-  *Thesis Motivation*
-  - Outline why it is important to solve the problem
-  - Again use the actors to present your solution, but don’t be to specific
-  - Be visionary!
-  - If applicable, motivate with existing research, previous work
-]
-#pagebreak(weak: true)
-
-= Objective
-#TODO[ // Remove this block
-  *Thesis Objective*
-  - What are the main goals of your thesis?
-]
-
-
-= Schedule
-#TODO[ // Remove this block
-  *Thesis Schedule*
-  - When will the thesis start
-  - Create a rough plan for your thesis (separate the time in sprints with a length of 2-4 weeks)
-  - Each sprint should contain several work items - Again keep it high-level and make to keep your plan realistic
-  - Make sure the work-items are measurable and deliverable
-  - No writing related tasks! (e.g. ”Write Analysis Chapter”)
-]
diff --git a/content/proposal/abstract.typ b/content/proposal/abstract.typ
new file mode 100644
index 0000000..aaf07b0
--- /dev/null
+++ b/content/proposal/abstract.typ
@@ -0,0 +1,8 @@
+#import "/utils/todo.typ": TODO
+
+= Abstract
+#TODO[ // Remove this block
+  *Abstract*
+  - Short (1/3-1/2 page) summary of the project 
+  - It is fine to repeat yourself here 
+]
diff --git a/content/proposal/introduction.typ b/content/proposal/introduction.typ
new file mode 100644
index 0000000..481f89d
--- /dev/null
+++ b/content/proposal/introduction.typ
@@ -0,0 +1,11 @@
+#import "/utils/todo.typ": TODO
+
+
+= Introduction
+#TODO[ // Remove this block
+  *Introduction*
+  - Introduce the reader to the general setting (No Problem description yet)
+  - What is the environment?
+  - What are the tools in use?
+  - (Not more than 1/2 a page)
+]
diff --git a/content/proposal/motivation.typ b/content/proposal/motivation.typ
new file mode 100644
index 0000000..56f94bc
--- /dev/null
+++ b/content/proposal/motivation.typ
@@ -0,0 +1,12 @@
+#import "/utils/todo.typ": TODO
+
+
+= Motivation
+#TODO[ // Remove this block
+  *Proposal Motivation*
+  - Outline why it is (scientifically) important to solve the problem
+  - Again use the actors to present your solution, but don't be to specific
+  - Do not repeat the problem, instead focus on the positive aspects when the solution to the problem is available
+  - Be visionary! 
+  - Optional: motivate with existing research, previous work 
+]
diff --git a/content/proposal/objective.typ b/content/proposal/objective.typ
new file mode 100644
index 0000000..05ff68f
--- /dev/null
+++ b/content/proposal/objective.typ
@@ -0,0 +1,9 @@
+#import "/utils/todo.typ": TODO
+
+= Objective
+#TODO[ // Remove this block
+  *Proposal Objective*
+  - What are the main goals of your thesis? 
+  - Ideally this section starts with a short overview where you state the goals with short enumerated bulletpoints, i.e. 1., 2., 3., ...
+  - Then, the section has a sub section for each goal (repeating the bulletpoint before to stay consistent) which is at least two paragraphs long and describes the goal in more detail
+]
diff --git a/content/proposal/problem.typ b/content/proposal/problem.typ
new file mode 100644
index 0000000..51a4ebe
--- /dev/null
+++ b/content/proposal/problem.typ
@@ -0,0 +1,10 @@
+#import "/utils/todo.typ": TODO
+
+= Problem
+#TODO[ // Remove this block
+  *Problem description*
+  - What is/are the problem(s)? 
+  - Identify the actors and use these to describe how the problem negatively influences them.
+  - Do not present solutions or alternatives yet!
+  - Present the negative consequences in detail 
+]
diff --git a/content/proposal/schedule.typ b/content/proposal/schedule.typ
new file mode 100644
index 0000000..650fb12
--- /dev/null
+++ b/content/proposal/schedule.typ
@@ -0,0 +1,11 @@
+#import "/utils/todo.typ": TODO
+
+= Schedule
+#TODO[ // Remove this block
+  *Thesis Schedule*
+  - When will the thesis Start
+  - Create a rough plan for your thesis (separate the time in iterations with a length of 2-4 weeks)
+  - Each iteration should contain several smaller work items - Again keep it high-level and make to keep your plan realistic
+  - Make sure the work-items are measurable and deliverable, they should describe features that are vertically integrated
+  - Do not include thesis writing or presentation tasks
+]
diff --git a/content/proposal/transparency_ai_tools.typ b/content/proposal/transparency_ai_tools.typ
new file mode 100644
index 0000000..c70e408
--- /dev/null
+++ b/content/proposal/transparency_ai_tools.typ
@@ -0,0 +1,7 @@
+#import "/utils/todo.typ": TODO
+
+#TODO[
+  Change this paragraph to reflect the tools you used in your proposal
+]
+
+In preparing this proposal, I utilized Grammarly for grammar and style correction across the Abstract, Introduction, and Conclusion sections, ensuring clarity and coherence in my writing. I used DeepL to enhance language quality and translate parts of the Literature Review. I used ChatGPT to generate initial drafts and expand on ideas in the Introduction and Discussion sections, providing valuable suggestions and examples. Additionally, I used GitHub Copilot to generate code snippets for the developed functionality and code snippets in the Methodology section.
\ No newline at end of file
diff --git a/proposal.typ b/proposal.typ
index 5291ef0..e7c2d78 100644
--- a/proposal.typ
+++ b/proposal.typ
@@ -1,5 +1,6 @@
 #import "/layout/proposal_template.typ": *
 #import "/metadata.typ": *
+#import "/utils/todo.typ": *
 
 #set document(title: titleEnglish, author: author)
 
@@ -13,7 +14,20 @@
   author: author,
   startDate: startDate,
   submissionDate: submissionDate,
-  transparency_ai_tools: include "/content/transparency_ai_tools.typ",
+  transparency_ai_tools: include "/content/proposal/transparency_ai_tools.typ",
 )
 
-#include "/content/proposal.typ"
+#TODO(color: red)[ // Remove this block
+  Before you start with your thesis, have a look at our guides on Confluence!
+  #link("https://confluence.ase.in.tum.de/display/EduResStud/How+to+Proposal")
+]
+
+#set heading(numbering: none)
+#include "/content/proposal/abstract.typ"
+
+#set heading(numbering: "1.1")
+#include "/content/proposal/introduction.typ"
+#include "/content/proposal/problem.typ"
+#include "/content/proposal/motivation.typ"
+#include "/content/proposal/objective.typ"
+#include "/content/proposal/schedule.typ"