-
Notifications
You must be signed in to change notification settings - Fork 0
/
appendices.tex
executable file
·176 lines (127 loc) · 6.05 KB
/
appendices.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
\chapter{Survey structure}
\label{appendix:survey}
\begin{center}
This is the structure for the knowledge sharing survey conducted at the beginning of February and at the end of April.
The survey was created with Google Forms.
\vspace{12pt}
\textbf{Notation:} \\
\textbf{This is a question} \\
\emph{This is an additional text from the survey} \\
These are clarifications for documenting purposes
\vspace{12pt}
\textbf{What is your role?} \\
\emph{Select the most suitable one}
\begin{itemize}
\itemsep0em % Item separation
\item \begin{center} \emph{Junior developer} \end{center}
\item \begin{center} \emph{Senior developer} \end{center}
\item \begin{center} \emph{Junior consultant} \end{center}
\item \begin{center} \emph{Senior consultant} \end{center}
\item \begin{center} \emph{Executive} \end{center}
\end{itemize}
\textbf{Work experience in years at QOCO?} \\
Integer scale from 0 to 10
\vspace{12pt}
\textbf{How familiar are you with these projects?} \\
List of 34 projects in random order, each evaluated with a 6-point scale:
\begin{enumerate}
\itemsep0em % Item separation
\setcounter{enumi}{-1}
\item \begin{center} \emph{I do not know the business case} \end{center}
\item \begin{center} \emph{I am familiar with the business case} \end{center}
\item \begin{center} \emph{I am familiar with the business case and general architecture} \end{center}
\item \begin{center} \emph{I can do some minor tasks} \end{center}
\item \begin{center} \emph{I can do major tasks} \end{center}
\item \begin{center} \emph{I know this project in detail} \end{center}
\end{enumerate}
\vspace{12pt}
\textbf{Do you think following barriers are a challenge at QOCO?} \\
\emph{Knowledge sharing barriers are things that disturb or prevent sharing of knowledge. Think especially in the context of QOCO Systems.}
\vspace{12pt}
5-step Likert scale (\emph{Strongly disagree, Disagree, Neither agree or disagree, Agree, Strongly agree}) was used to evaluate 20 knowledge sharing barriers in random order:
\vspace{12pt}
\emph{Lack of formal documentation\\
Lack of informal documentation\\
Lack of comments in code\\
Lack of trust\\
Messy and complex code\\
Lack of informal communication\\
Knowledge hoarding\\
Difference in experience levels\\
Tight schedule\\
Lack of motivation\\
Used communication tools\\
Multitasking\\
Complex domain (aviation industry)\\
Working in different locations\\
Difference in age\\
Individual communication skills\\
Strong code ownership\\
Physical work environment\\
Organization culture\\
Strong organizational structure}
\vspace{12pt}
\end{center}
\chapter{README template}
\label{appendix:readme}
\begin{tiny}
\begin{verbatim}
# qoco-readme
### Table of Contents
- [qoco-readme](#qoco-readme)
- [Table of Contents](#table-of-contents)
- [Business case](#business-case)
- [Development](#development)
- [Prerequisites](#prerequisites)
- [Setting up local development environment](#setting-up-local-development-environment)
- [Building](#building)
- [Running or Usage](#running-or-usage)
- [Deploying](#deploying)
- [Environments](#environments)
- [Support](#support)
- [Related / dependent projects](#related--dependent-projects)
- [Known limitations](#known-limitations)
## Business case
The business case of the project is briefly described here. What does this project do? Why does it exist?
This README template is meant to improve informal documentation of projects. It is meant to be used as a reference material about
necessary information required for README. It can be modified to fit the context of different projects, but the template itself
should be kept on a general level to ensure suitability for different use cases.
## Development
### Prerequisites
A list of prerequisites for this project and instructions on how to get them.
* [A Github account](https://github.com/)
* [Markdown editor](https://code.visualstudio.com/)
* [Git](https://git-scm.com/)
### Setting up local development environment
Steps needed to setup the local development environment.
Clone repository:
```git clone [email protected]:QOCOSystems/qoco-readme.git```
### Building
Steps needed to build or install the project. Additional information about build tools can be presented.
This project is a simple markdown file, so no additional build steps are required.
### Running or Usage
Steps needed to run or start the project. Additional information about runtime parameters etc. can be presented.
This project can't be run, it is meant to be copied to the root folder of a project in a default branch so that it is the first
thing that developers see when they open the repository. The template acts as a starting point and reference material to create
a project specific README and after copying it should be modified to fit the specific context.
### Deploying
Steps needed to deploy the project to dev/preprod/prod environments.
This project is hosted on GitHub and it is deployed by creating a pull request to master branch (see [Contributing](CONTRIBUTING.md))
## Environments
A list of environments this project is deployed to. Also a description of artifacts or architecture overview can be added.
| Stage | Environment | Artifacts |
|:------|:------------|:-------------------|
| Prod | Github | README.md template |
## Support
Who knows something about this project? Where to find more documentation?
This template was first created as a part of master's thesis by Markus Tyrkkö.
## Related / dependent projects
List of projects that use the API provided by this project for example, or are otherwise dependent or related to this one.
Also a brief description about how they are related to this would be nice to have. An overview of architecture can also be added here.
* [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
* A cheatsheet for markdown syntax
## Known limitations
A list of known limitations or issues. This might not be necessary as issues could be tracked using other issue tracking methods,
but if there is something that should be mentioned in README already, it could be added here.
\end{verbatim}
\end{tiny}