This LaTeX template can be used to draft and outline the topic for a academic paper or thesis in Computer Science (in English and German language). I have found it particular helpful for topics that are more on the engineering side of CS.
- Core Ideas and Concept
- How to fill in the Template?!
- PDF generation Tool Chain
- Setup LaTeX Environment from Scratch
- Credits
Students at the Computer Science department of University of Applied Sciences Darmstadt frequently have to write seminar papers. In addition, they have craft a comprehensive thesis (Bachelor's Thesis or Master's Thesis, depending on the degree they aim for) at the end of their studies. During the creation of these papers (or theses), one of the major challenges for many students is to find the topic they are going to write about and shape it the way that it is interesting and of relevance.
The purpose of this template is to support students in developing and defining the essence of what they want to write their academic papers about.
As a supervisor I ask my students to fill it the template already at the start of their research projects. It forces them to write down, rethink, and reshape their research ideas. Based on this document I will discuss their ideas with them, helping them to shape a good storyline and strategy for their work.
Usually my students create multiple iterations of this documents as they dive deeper and deeper into their area of research and gain deeper understanding of what they want to accomplish.
The most important part for the students, is to have them answer the following four questions (within in the template they are described in much further detail as LaTeX comments):
- What is the problem you want to address in your work?
- The objective here is to have students give a very brief and to the point description (1 sentence) of the problem they want to address within their paper.
- Why is it a problem?
- Why is the problem at all relevant? Why should we spend effort into investigating/solving it?
- What is the solution you developed in your work?
- What results have been (or will be) produced? How do these results address the proposed problem?
- Why is it a solution?
- What is the quality of the results? What shortcomings are there? How did the student ensure that the results are genuine?
Furthermore, I ask them to provide:
- A abstract of their proposed work
- A proposal for a table of contents
- relevant/significant pieces of related work they have already found
The intention of this template was to be as easily usable as possible. Nevertheless, there are a few things to keep in mind while using it. The following guide is supposed to assist you in using it as smooth as possible.
Start by cloning or downloading this repository and opening the researchproposal.tex file in your favorite LaTeX environment. The template is set up the way that, at this point, you should be able to generate a PDF without any errors or warnings. This will allow you to double check that your environment is set up the way that you can generate a PDF document from the template.
In case you have trouble generating the PDF, please take a look to the PDF generation tool chain section. This may help you getting the PDF generated.
Please acknowledge that the template is bilingual. It can be used to create a research proposal in English or in German language. Thus, the first thing you have to do is choosing the language that you want to use. This is done by opening researchproposal.tex and stating the language in the following comment block.
% ##########################################
% # Choose the language for the document
% # de = German
% # en = English
\newcommand{\lang}{en}
% ##########################################
Obviously, filling in your content is the most important step. In order to do that, you will find a lot of comment blocks in the document that assist you. These blocks will also give you further explanations about what you need to consider and keep in mind. This is where you need to fill in your content.
Important: Read and follow the explanations for each comment block!
The following is an example for these blocks:
% ##########################################
% # Include the the title of your paper/thesis here.
% ######
% Coming up with a good title is hard.
% It should:
% 1. capture the contents of the your work
% 2. not be to broad or generic
% 3. use established terms and wordings
% 4. make people curious about your work
% 5. use current buzzwords if possilbe (but do it right)
% 6. not use too many buzzwords :-)
insert title here
% ##########################################
There is nothing special about the tool chain used to generate the pdf. It uses:
- pdflatex - to generate a pdf document
- biber - to process the bibliography
Assuming you are familiar with LaTeX it should easily be set up.
Please understand, if you have a running environment that makes sense to you - stick with it! It is by no means necessary to use the one poposed here, if you should be in one of my classes. Further, there are probably better environments out there.
If you should not have a working environment, a possible environment setup for LaTeX editing is described here.
The essence and wisdom of the core of this research proposal is NOT my own.
It is more the collected wisdom from many people that I have met and talked to. Further, I have encountered this style of presenting academic engineering work as a best practice at many well established conferences.
To the best of my knowledge I am just the only one to make it available like that.