Skip to content

Instantly share code, notes, and snippets.

@kmindi
Created May 14, 2019 18:52
Show Gist options
  • Select an option

  • Save kmindi/31ca4b49d26c33b1475f4434590f540a to your computer and use it in GitHub Desktop.

Select an option

Save kmindi/31ca4b49d26c33b1475f4434590f540a to your computer and use it in GitHub Desktop.
LaTex Experiment Report Structure according to guidelines by A. Jedlitschka and D. Pfahl
% used within a section, just replace "\sub" with "\" and it can be used as sections
% the beginning and the end should be tailored according to the paper/document
%@InProceedings{Jedlitschka2005,
% author = {A. Jedlitschka and D. Pfahl},
% title = {Reporting guidelines for controlled experiments in software engineering},
% booktitle = {2005 International Symposium on Empirical Software Engineering, 2005.},
% year = {2005},
% month = {Nov},
% pages = {10 pp.-},
% doi = {10.1109/ISESE.2005.1541818},
% keywords = {empirical software engineering;guideline development process;Guidelines;Software engineering;Proposals;Taxonomy;Standards publication;Feedback;Programming;Costs;Data mining;Psychology},
%}
This section is structured according to the experimentation reporting guidelines proposed by \citeauthor{Jedlitschka2005}~\autocite{Jedlitschka2005}.
\subsection{Title, authorship}
\subsection{Structured abstract} % Summarizes the paper under headings of background or context, objectives or aims, method, results, and conclusions
\subsection{Motivation} % Sets the scope of the work and encourages readers to read the rest of thepaper
\subsubsection{Problem statement} % Reports what the problem is; where it occurs, and who observes it
\subsubsection{Research objectives} % Defines the experiment using the formalized style used in GQM
\subsubsection{Context} % Reports environmental factors such as settings and locations
\subsection{Related work} % How current study relates to other research
\subsection{Experimental design} % Describes the outcome of the experimental planning stage
\subsubsection{Goals, hypotheses and variables} % Presents the refined research objectives
\subsubsection{Design} % Define the type of experimental design
\subsubsection{Subjects} % Defines the methods used for subject sampling and group allocation
\subsubsection{Objects} % Defines what experimental objects were used
\subsubsection{Instrumentation} % Defines any guidelines and measurement instruments used
\subsubsection{Data collection procedure} % Defines the experimental schedule, timing and data collection procedures
\subsubsection{Analysis procedure} % Specifies the mathematical analysis model to be used
\subsubsection{Evaluation of validity} % Describes the validity of materials, procedures to ensure participants keep to the experimental method, and methods to ensure the reliability and validity of data collection methods and tools
\subsection{Execution} %D escribes how the experimental plan was implemented
\subsubsection{Sample} % Description of the sample characteristics
\subsubsection{Preparation} % How the experimental groups were formed and trained
\subsubsection{Data collection performed} % How data collection took place and any deviations from plan
\subsubsection{Validity procedure} % How the validity process was followed and any deviation from plan
\subsection{Analysis} % Summarizes the collected data and describes how it was analyzed
\subsubsection{Descriptive statistics} % Presentation of the data using descriptive statistics
\subsubsection{Data set reduction} % Describes any reduction of the data set e.g. removal of outliers
\subsubsection{Hypothesis testing} % Describes how the data was evaluated and how the analysis model was validated
\subsection{Interpretation} % Interprets the findings from the Analysis section
\subsubsection{Evaluation of results and implications} % Explains the results
\subsubsection{Limitations of study} % Discusses threats to validity
\subsubsection{Inferences} % How the results generalize given the findings and limitations
\subsubsection{Lesson learnt} % Descriptions of what went well and what did not during the course of the experiment
\subsection{Conclusions and future work} % Presents a summary of the study
\subsubsection{Relation to existing evidence} % Describes the contribution of the study in the context of earlier experiments
\subsubsection{Impact} % Identifies the most important findings
\subsubsection{Limitations} % Identifies main limitations of approach i.e.
\subsubsection{Future work} % Suggestions for other experiments to further investigate
\subsection{Acknowledgments} % Identifies any contributors who do not fulfill authorship criteria
\subsection{References} % Lists all cited literature
\subsection{Appendices} % Includes raw data and/or detailed analyses which might help others to use the results
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment