Commit 8078ace9 authored by Sumu Virpi's avatar Sumu Virpi
Browse files

protocamp templates v0.1

parents
# ignore tex generated files
**.log
**.aux
**.out
**.synctex.gz
**.idx
**.toc
**.bbl
**.blg
# Usage
This is in no way official Aalto course material, use at you own risk.
The template is altogether rather scraped together, and is probably in many ways an abuse of LaTeX. Feel free to improve it.
This is definitely _not_ a good place to start learning LaTex. For that purpose I recommend the [Overleaf tutorials](https://www.overleaf.com/learn/latex/Tutorials). Aalto provides staff and students with Porfessional accounts.
Tested with Texmaker 4.4.1 using pdfTeX, Version 3.14159265-2.6-1.40.16 (TeX Live 2015/Debian)
## Credits
The original author of this template is unknown. Edited for use on the Aalto ELEC-D0301 Protocamp course by Virpi Sumu, virpi.sumu@aalto.fi. Please let me know if you are the original author, and I can credit you appropriately.
%The original author of this template is unknown. Edited 07/2021 for use on the Aalto ELEC-D0301 Protocamp course by Virpi Sumu, virpi.sumu@aalto.fi. Please let me know if you are the original author, and I can credit you appropriately.
\documentclass[a4paper,11pt]{exam}
\usepackage{style}
\usepackage[ddmmyyyy]{datetime}
\renewcommand{\dateseparator}{.}
\instructiontrue % show instructions
%\instructionfalse % hide instructions
%AALTO LOGO (CHANGE THE COLOR {yellow,red,blue} AND/OR CHARACTER {!,'',?})
\uselogo{red}{!}{elec}
%DETAILS
% Title: You may alter the given Title of the project, write your decision here. Put here the final version.
\topic{Project plan / Projektisuunnitelma}
\report{Project \#1 \\
Title of My Project / Otsikko}
\def\course{ELEC-D0301 Protocamp / Protopaja}
%STUDENT DETAILS
% Do not include student numbers here.
\def\students{Firstname Surname\\Firstname Surname\\Firstname Surname\\Firstname Surname\\Firstname Surname}
\def\submitdate{\today}
\makeindex
\begin{document}
\maketitle
%information page
\newpage
\section*{Information page}
\subsection*{Students}
\students
\subsection*{Project manager}
Firstname Surname\\
\subsection*{Sponsoring Company}
X Oy\\
\subsection*{Starting date}
31.5.2021\\
\subsection*{Submitted date}
\today
\newpage
\ifinstruction{\redit{
GENERAL:
Use the Template. Technology to write the document is free to choose. The final format of this document to be submitted to MyCourses is PDF (A4 portrait).
NB: the instructions here in red are from the docx template, and will not always apply to TeX files.
Tämän dokumentin voi kirjoittaa myös suomeksi or you may write in English.
This template contains Word Styles, please use them. This style is "Instructions" and by Style it is red. Before submitting this document, make sure you have removed all text under this Style.
Use "Normal" style to write the body text.
Especially, keep the first two pages "as is", these are formal pages that must look the same.
}
}
\fi
\section{Background / Johdanto}
\ifinstruction{\redit{
Write in this chapter the background for your topic, as you have understood it. Write using your own words; do not copy-paste any text given by the company or teachers.
Ask questions from your sponsor to get more clear idea what is the background. If your project is related to developing some system, write about what is the big picture.
}
}
\fi
This is body text...
\section{Expected output / Tavoite}
\ifinstruction{\redit{
Describe here what is the "Expected output" of your project.
For instance,
\begin{itemize}
\item what are the high level functions
\item who is going to be the expected user
\item what kind of user experience related requirements are set as a goal
\item what is the expected performance
\item how it is going to be demonstrated in the end of the project, both in the demopäivä
\end{itemize}
If your company has provided some public material/links etc. of some similar project to help you to understand the problem better, feel free to include some illustration here from those
}
}
\fi
This is body text…
\section{Phases of project / Projektin vaiheistus}
\ifinstruction
{\redit{
Before going to detailed schedule, present higher-level foreseen phases of your project.
Define time constraints for every Phase, when each phase must be completed. Define these as Milestones and write a list of Milestones with the deadlines. You may also use abbreviations like M1, M2, M3, for easier referencing later in the document.
Here are some phases of project you may take into consideration
\begin{itemize}
\item planning
\item conceptualization
\item brainstorming
\item learning new skills/knowledge
\item fast prototyping
\item completing some subsystem
\item completing the system
\item final delivery
\item presentations
\item reporting
\item ...
\end{itemize}
}
}
\fi
This is body text.…
\section{Work breakdown structure (WBS)}
\ifinstruction
{\redit{
Present here your final breakdown(s). The sketches may be included in the Appendix if found necessary.
Number the units appropriately (e.g. 1, 2, 3... or 1.1., 1.2., 1.2.5)
Estimate working hours required to complete every unit.
NOTE: If you have selected approach B (conceptualization phase), you may leave this chapter out in Submission for 16.6.2021
}
}
\fi
This is body text.…
\section{Work packages and Tasks of the project and Schedule}
\ifinstruction
{\redit{
After you have completed WBS, define Tasks and form Work packages. With these, define your Schedule. You may write these under the following subchapters, or remote subchapters and use presentation format you like for these. In case of large chart, consider putting it as an appendix.
}
}
\fi
\subsection{Work packages / Työpaketit}
\ifinstruction
{\redit{
Define there the Work Packages (WP) of the project and Tasks under those. Preferably, number these like WP 3, and Task 3.4.
Tasks should be the smallest item in the schedule, later.
Define responsible persons for every WP.
Take into account the Milestones defined earlier, to be connected to the WP.
}
}
\fi
\subsection{Tasks / Tehtävät}
\ifinstruction
{\redit{
Define estimated working hours for each task. Show the sum of working hours in all tasks. }}
\fi
\subsection{Detailed schedule / Aikataulu}
\ifinstruction
{\redit{
Define here the detailed schedule and logical linking of tasks.
NOTE: If you have selected approach B (conceptualization phase), you may leave this chapter out in Submission for 16.6.2021
}}
\fi
\section{Work resources / Resurssit}
\subsection{Personal availability during the project / Henkilöresurssit}
\ifinstruction
{\redit{
Describe here the weekly table how many working hours each project group member has planned to use for the project. This table takes into account known unavailability of group members and balancing the work with other curriculum along the summer. Each of you has some parallel activities during summer and schedules of those courses may affect this table, so now it is a good time to fill your calendar from June to August. Show also cumulative numbers in the last row.
Below is a template for the table, feel free to use that or create your own style (like copy-paste from spreadsheet or so...)
}
}
\fi
\renewcommand{\arraystretch}{1.5}
\begin{center}
\begin{table}
\caption{Number of hours available for the project (excluding lectures and seminars) per week.}
\begin{tabular}{ | c | c | c | c | c | c | }
\hline
& Student A & Student B & Student C & Student D & Student E \\
\hline
Week 23 & & & & & \\
\hline
Week 24 & & & & & \\
\hline
Week 25 & & & & & \\
\hline
Week 26 & & & & & \\
\hline
Week 27 & & & & & \\
\hline
Week 28 & & & & & \\
\hline
Week 29 & & & & & \\
\hline
Week 30 & & & & & \\
\hline
Week 31 & & & & & \\
\hline
Week 32 & & & & & \\
\hline
Week 33 & & & & & \\
\hline
Week 34 & & & & & \\
\hline
Week 35 & & & & & \\
\hline
TOTAL & & & & & \\
\hline
\end{tabular}
\end{table}
\end{center}
\ifinstruction
{\redit{
The sums and sum of sums should be balanced with the sum of required hours in tasks, shown in earlier chapters.
}
}
\fi
\subsection{Personal goals / Henkilökohtaiset tavoitteet}
\ifinstruction
{\redit{
This is an optional subchapter.
Each of you may have your own learning objectives, what to learn and in which tasks to focus in the project. If you decide to drop this optional chapter off, remember to discuss of this aspects in your group.
}
}
\fi
This is body text.…
\section{Cost plan and materials / Kustannussuunnitelma}
\ifinstruction
{\redit{
Define how the budget of the project is handled. Who is responsible?
Present the budget, as a table of foreseen costs and estimate the total costs for parts, materials etc. that must be obtained during the project (the materials that exist in the beginning of the project are not counted).
If you need to buy services, like manufacturing from external workshop, include these here.
If the project requires materials, define who is responsible getting those and how the procedure works. (In general, the students are not allowed to do any procurement, university policy.)
}
}
\fi
This is body text.…
\section{Other resources / Muut resurssit}
\ifinstruction
{\redit{
Define here the other resources available for the project.
Do you have:
\begin{itemize}
\item additional working place (like a room or a table or a place to store your stuff somewhere?)
\item keys for working place?
\item devices, like specific computers in your use
\item devices, like tools to do something
\end{itemize}
If you have some tools available which require official instruction before you may use (like all electric powered manufacturing tools are), define here how you will get the permission to use them.
List here the tools of Sähköpaja, you need to learn to use, in order to complete the tasks of the project.
}
}
\fi
This is body text.…
\section{Project management and responsibilities / Henkilöiden roolit ja vastuut}
\ifinstruction
{\redit{
Define here the responsibilities of each role (project manager, working package leader etc.)
Define as clearly as possible the responsibility of
\begin{itemize}
\item Project manager
\item Vastuuassistentti
\item Company representative
\item ...
\end{itemize}
}
}
\fi
\section{Weekly Project Meetings / Viikkopalaverit}
\ifinstruction
{\redit{
The Project group consisting of all students should have meetings once a week.
In the beginning of the Project, the meetings are important in order to create this plan, in order to agree on various details. Later on, the focus of meetings is on progress tracking, progress of Tasks etc. and communicating various observations that affect the project progress and goals.
Define here the default agenda for each Project Meeting, use template. Usually, meetings consists of selecting a "memokeeper", the one who writes the memo/minutes, going through the progress/results since the last meeting, checking this against the planned schedule, agreeing on what each person is going to do by the next meeting, agreeing on the next meeting. Your project probably has some special features that cause you to make your own template.
Like in any meeting, it is important that every person have the same understanding on the starting time. For instance, it is not exceptional that some persons are used to the practice that everything start 15 minutes past the hour, while the other person may arrive always five minutes earlier to the place. In order to avoid delayed starts of the Project Meetings, agree on this and write here your agreement.
Writing a memo of each Project meeting is a standard practice in any project. The memos can be written in short, like just the decisions made, or a little bit longer, that documents some discussion of the meeting. It is up to you to define here what kind of meeting memos you write, but define it here. Define also, where you store these documents.
As important as the memo, is the prepared agenda for the Project meeting. Agree on who is responsible on this. Recommended practice is that the Project manager does this and distributes to others before the meeting starts.
}
}
\fi
This is body text.…
\section{Communication plan / Viestintäsuunnitelma}
\ifinstruction
{\redit{
Face-to-Face Project Meetings (Chapter 10) are important means of communication, but it is as important to communicate between the meetings. Other communication may be face-to-face too, but some electronic communication means are recommended too.
Typical error is to use multiple communication means and if someone is not following all means, communication breakdowns are common. In general it is beneficial to agree on a common tool for each communication purpose.
Define here how the student group is communicating
\begin{itemize}
\item internally in the student group
\item with vastuuassistentti
\item with company
\end{itemize}
}
}
\fi
This is body text...
\section{Risks / Riskit}
\ifinstruction
{\redit{
Present here the risk analysis of the project plan.
List the risks in the table (one row = one risk). Define the risk, severity of that and present how each risks was taken into account in this plan.
}
}
\fi
This is body text.…
\section{Quality plan / Laatusuunnitelma}
\ifinstruction
{\redit{
Discuss here how the quality is handled in all phases of the project.
Is the project manager responsible on the quality?
How the project manager is going to take care the quality in each work package?
How the observed problems in quality are communicated? How the actions to improve quality are decided?
}
}
\fi
This is body text.…
\section{Changing this plan / Muutokset suunnitelmaan}
\ifinstruction
{\redit{
Define here the procedures how to change any part of this plan.
Define who can make initiative to ask change.
Define what the process to change the schedule is. How the decision to change the plan is made. If the decision is made in weekly meeting and some people are absent, how the changes are communicated et cetera.
Define how the change is documented.
}
}
\fi
This is body text.…
\section{Measures for successful project / Onnistuneen projektin mittarit}
\ifinstruction
{\redit{
Here you define the common understanding how it is measured if the project was successful.
Remember, that learning goals are measures for a successful project too. How to measure that?
Define:
\renewcommand{\labelenumi}{\alph{enumi}}
\begin{enumerate}
\item How the project final outcome is evaluated
\begin{itemize}
\item In case of software, how to test it? In case of hardware, how to test it?
\item Where it is evaluated / demonstrated?
\end{itemize}
\item How the project process is evaluated
\begin{itemize}
\item Describe how reaching the milestones is documented and how the quality of deliverables is documented.
\end{itemize}
\end{enumerate}
}
}
\fi
\end{document}
%NB whenever you change this file, at least in Texmaker, remember to first
% - include entry here
% - cite it in the .tex file
% Then build .tex file with
% - Quick Build
% - BibTeX
% - probably twice with Quick Build again
% Possibly repeat the whole build process if still not working.
% Pay special attention to any errors thrown by BibTeX build.
@misc{examplewebsite,
author = "Example",
title = "Website",
year = "2021",
howpublished = "\url{https://www.example.com/}",
note = "Accessed 1.1.2021"
}
@article{example1,
author = "Firstname Surname",
title = "Developing gadget systems",
journal = "Transactions of Gadgets",
volume = "53",
number = "1",
pages = "34--45",
year = "2010"
}
@article{example2,
author = "Firstname Surname and Etunimi Sukunimi and Teemu Teekkari",
title = "Developing gadget systems",
journal = "Transactions of Gadgets",
volume = "53",
number = "1",
pages = "34--45",
year = "2010"
}
\ No newline at end of file
%The original author of this template is unknown. Edited 07/2021 for use on the Aalto ELEC-D0301 Protocamp course by Virpi Sumu, virpi.sumu@aalto.fi. Please let me know if you are the original author, and I can credit you appropriately.
\documentclass[a4paper,11pt]{exam}
\usepackage{style}
\usepackage[ddmmyyyy]{datetime}
\renewcommand{\dateseparator}{.}
%this should really go in the style file, but it's easier to access here
\addto\captionsenglish{
%changes the text displayed at the top of the ToC page
\renewcommand{\contentsname}%
{Table of Contents / Sisällysluettelo}%
%changes the text displayed at the top of the bibliography page
\renewcommand{\refname}%
{References / Lähteet}%
}
\instructiontrue % show instructions
%\instructionfalse % hide instructions
%AALTO LOGO (CHANGE THE COLOR {yellow,red,blue} AND/OR CHARACTER {!,'',?})
\uselogo{red}{!}{elec}
%DETAILS
% Title: Put here the same title as in the project plan - not just the name of the company. Choose either Mid project report or Final report, and remove the other
\topic{Mid project report / Väliraportti}
%\topic{Final report / Loppuraportti}
\report{Project \#1 \\
Final Title of My Project / Otsikko}
\def\course{ELEC-D0301 Protocamp / Protopaja}
%STUDENT DETAILS
% Do not include student numbers here.
\def\students{Firstname Surname\\Firstname Surname\\Firstname Surname\\Firstname Surname\\Firstname Surname}
\def\course{ELEC-D0301 Protocamp / Protopaja}
% Add here an IMAGE of your project, some Image that illustrates your project in the best way. May be even a group photo of the team with the project outcome?
\def\submitdate{\today}
\makeindex
\begin{document}
\maketitle
%information page
\newpage
\section*{Information page}
\subsection*{Students}
\students
\subsection*{Project manager}
Firstname Surname\\
\subsection*{Sponsoring Company}
X Oy\\
\subsection*{Starting date}
31.5.2021\\
\subsection*{Submitted date}
\today
\newpage
\section*{Tiivistelmä}
\addcontentsline{toc}{section}{Tiivistelmä}
\ifinstruction{\redit{ Kirjoita lyhyt tiivistelmä sekä suomeksi että englanniksi.
Write abstract of the project, 250-300 words, what was the project about and what did you achieve.
In Finnish. }
}
\fi
This is body text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur vitae facilisis erat. Aliquam pulvinar rhoncus dolor, sit amet accumsan metus porttitor sit amet. Nulla consequat convallis elit ut mattis. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Nullam mattis molestie mi, faucibus dictum urna auctor a. Mauris convallis augue a urna feugiat, varius tincidunt ligula consectetur. Ut vitae malesuada nulla. Vivamus mi odio, convallis sed sem vitae, mattis lacinia quam. Donec molestie felis a justo maximus pulvinar. Curabitur eu quam sed risus euismod scelerisque scelerisque at lectus. Fusce libero ante, sodales non nisl eget, dapibus tincidunt libero. Nullam ornare dignissim purus. Nunc eget urna justo. Aliquam eu venenatis turpis, suscipit pretium risus. Duis tempus vel lectus convallis iaculis. Donec a urna non quam lobortis dictum. Etiam aliquet risus in nulla congue, vestibulum volutpat velit commodo. In quis nisl nunc. Ut lacinia odio id ipsum euismod ultricies. Nunc ullamcorper justo eget consequat molestie. Nulla quis magna in quam ultrices ornare non dignissim justo. Donec a ullamcorper risus. Quisque eget turpis diam. Sed ultrices bibendum est, quis interdum dolor fermentum eu. Nulla at sagittis lacus, et mattis nibh. Sed venenatis risus purus, ut ultrices neque scelerisque vitae. Pellentesque ornare turpis ipsum, id sollicitudin lacus eleifend id. Nullam eget accumsan orci. Sed eros risus, volutpat in placerat vitae, placerat fermentum erat. Nulla fringilla volutpat elit, et suscipit libero vulputate ut. Nunc et egestas ligula, at vestibulum lorem. Nullam ipsum erat, tempus at consequat quis, rutrum at enim. Vestibulum.
\newpage
\section*{Abstract}
\addcontentsline{toc}{section}{Abstract}
\ifinstruction{\redit{
In English.}
}
\fi
This is body text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur vitae facilisis erat. Aliquam pulvinar rhoncus dolor, sit amet accumsan metus porttitor sit amet. Nulla consequat convallis elit ut mattis. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Nullam mattis molestie mi, faucibus dictum urna auctor a. Mauris convallis augue a urna feugiat, varius tincidunt ligula consectetur. Ut vitae malesuada nulla. Vivamus mi odio, convallis sed sem vitae, mattis lacinia quam. Donec molestie felis a justo maximus pulvinar. Curabitur eu quam sed risus euismod scelerisque scelerisque at lectus. Fusce libero ante, sodales non nisl eget, dapibus tincidunt libero. Nullam ornare dignissim purus. Nunc eget urna justo. Aliquam eu venenatis turpis, suscipit pretium risus. Duis tempus vel lectus convallis iaculis. Donec a urna non quam lobortis dictum. Etiam aliquet risus in nulla congue, vestibulum volutpat velit commodo. In quis nisl nunc. Ut lacinia odio id ipsum euismod ultricies. Nunc ullamcorper justo eget consequat molestie. Nulla quis magna in quam ultrices ornare non dignissim justo. Donec a ullamcorper risus. Quisque eget turpis diam. Sed ultrices bibendum est, quis interdum dolor fermentum eu. Nulla at sagittis lacus, et mattis nibh. Sed venenatis risus purus, ut ultrices neque scelerisque vitae. Pellentesque ornare turpis ipsum, id sollicitudin lacus eleifend id. Nullam eget accumsan orci. Sed eros risus, volutpat in placerat vitae, placerat fermentum erat. Nulla fringilla volutpat elit, et suscipit libero vulputate ut. Nunc et egestas ligula, at vestibulum lorem. Nullam ipsum erat, tempus at consequat quis, rutrum at enim. Vestibulum.
\newpage
\tableofcontents
\addcontentsline{toc}{section}{Table of Contents / Sisällysluettelo}
% The answers to be written here
\newpage
\ifinstruction{\redit{ GENERAL:
Use the Template. Technology to prepare the document is free.
The final format of this document to be submitted to MyCourses is PDF (A4 portrait).
NB: the instructions here in red are from the docx template, and will not always apply to TeX files.
Tämän dokumentin voi kirjoittaa suomeksi or in English. Valitse otsikoiden kieli systemaattisesti samaksi.
This template contains Word Styles, please use them. This style is "Instructions" and by Style it is red. Before submitting this document, make sure you have removed all text under this Style.
Use "Normal" style to write the body text.
Especially, keep the first two pages "as is", these are formal pages that must look the same.
The nature of final report is technical report, including details of technical design.
The appropriate length of the final report depends on the number of Figures etc. Typical length of Final report is 30 to 50 pages.
}
}
\fi
\section{Introduction / Johdanto}
\ifinstruction{\redit{
Like in any report or thesis, describe the background of the project, in which context the project was done or in general what is the "big picture". }
}
\fi
This is body text...
\section{Objective / Tavoite}
\ifinstruction{\redit{
Describe shortly what was the objective of your project, probably already defined in the Project plan.
}
}
\fi
This is body text…
\section{Results A}
\ifinstruction
{\redit{
Use appropriate number of Chapters here to present results. Preferably many.
Results Chapter should have technical sound, describing detailed information.
Use Figures, Tables, Equations etc. as necessary.
Use Heading styles from level 1 to 2. If necessary, you may consider also 3rd level, but is not recommended.
\begin{figure}[h]
\centering
\includegraphics[width=0.25\textwidth]{koala}
\caption{Sample picture representing koala.}
\end{figure}
In Figures, use "Figure" style for the actual Figure and "Figure Caption" for the text below. Use "Insert Caption" button to add automatic numbering of Figures and use "Cross-references" to cite automatically in text. E.g., see Figure 1, a cute koala. }
}
\fi
This is body text.…
\section{Results B}
\subsection{Subchapter X}
\subsubsection{Subsubchapter X}
\subsection{Subchapter X}
This is body text.…
\section{Results C}
This is body text...