Skip to content

Commit

Permalink
Move proposal content into subfolder and update its TODOs (#40)
Browse files Browse the repository at this point in the history
  • Loading branch information
robertjndw authored Jul 2, 2024
1 parent 1ded800 commit 9fe6992
Show file tree
Hide file tree
Showing 9 changed files with 84 additions and 65 deletions.
63 changes: 0 additions & 63 deletions content/proposal.typ

This file was deleted.

8 changes: 8 additions & 0 deletions content/proposal/abstract.typ
Original file line number Diff line number Diff line change
@@ -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
]
11 changes: 11 additions & 0 deletions content/proposal/introduction.typ
Original file line number Diff line number Diff line change
@@ -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)
]
12 changes: 12 additions & 0 deletions content/proposal/motivation.typ
Original file line number Diff line number Diff line change
@@ -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
]
9 changes: 9 additions & 0 deletions content/proposal/objective.typ
Original file line number Diff line number Diff line change
@@ -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
]
10 changes: 10 additions & 0 deletions content/proposal/problem.typ
Original file line number Diff line number Diff line change
@@ -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
]
11 changes: 11 additions & 0 deletions content/proposal/schedule.typ
Original file line number Diff line number Diff line change
@@ -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
]
7 changes: 7 additions & 0 deletions content/proposal/transparency_ai_tools.typ
Original file line number Diff line number Diff line change
@@ -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.
18 changes: 16 additions & 2 deletions proposal.typ
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#import "/layout/proposal_template.typ": *
#import "/metadata.typ": *
#import "/utils/todo.typ": *

#set document(title: titleEnglish, author: author)

Expand All @@ -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"

0 comments on commit 9fe6992

Please sign in to comment.