Software Component Approval Sheet
Author
Christian Hettlage
Last Updated
4 years ago
License
Creative Commons CC BY 4.0
Abstract
Simple template for approving software components.
Simple template for approving software components.
\documentclass[12pt,a4paper]{article}
\usepackage[utf8]{inputenc}
\usepackage{longtable}
\usepackage{tabu}
\textwidth=166mm
\textheight 25.2cm
\oddsidemargin= -2.4mm
\evensidemargin= -2.4mm
\topmargin= -17.4mm
\parindent0mm
\setlength{\tabulinesep}{10pt}
\pagestyle{empty}
% --------------------------------------------------------
% EDIT THIS SECTION FOR COMPONENT NAME AND PEOPLE INVOLVED
\newcommand{\Component}{My Shiny Component}
\newcommand{\WrittenBy}{Author}
\newcommand{\ReviewedBy}{Reviewer}
% --------------------------------------------------------
\newenvironment{castable}[1]{
\begingroup
\setlength{\tabcolsep}{10pt} % Default value: 6pt
\begin{longtabu} to \textwidth {#1}
}{
\end{longtabu}
\endgroup
}
\begin{document}
\section*{\Component}
\subsection*{General}
\begin{castable}{|l|X[l]|}
\hline
\textbf{Name} & \Component\\
\hline
\textbf{Written by} & \WrittenBy\\
\hline
\textbf{Reviewed by} & \ReviewedBy\\
\hline
\end{castable}
\subsection*{Look \& Feel}
\begin{castable}{|X[1]|l|}
\hline
\textbf{L\&F criterion} & \textbf{OK}\\
\hline
The component looks good & \\
\hline
All messages are easy to understand and user-friendly & \\
\hline
There are no grammar errors or typos & \\
\hline
Messages are complete sentences, start with a capital and end with a punctuation mark & \\
\hline
The first (and only the first) word of labels starts with a capital &\\
\hline
\end{castable}
\subsection*{Unit Tests}
\begin{castable}{|X[1]|l|}
\hline
\textbf{Test} & \textbf{OK}\\
\hline
Test 1 & \\
\hline
\end{castable}
\subsection*{Signatures of approval}
\vspace*{5em}
(\WrittenBy)
\vspace*{5em}
(\ReviewedBy)
\end{document}