Wizja: wizja.tex

File wizja.tex, 7.3 KB (added by dozzie, 7 years ago)

wizja aplikacji (źródło)

Line 
1\documentclass[10pt]{article}
2
3\usepackage{a4wide}
4\usepackage{indentfirst}
5
6\usepackage[polish]{babel}
7
8\usepackage[OT4]{fontenc}
9\usepackage[utf8]{inputenc}
10
11\usepackage{longtable}
12\usepackage{caption}
13\captionsetup{tablename=Tabela}
14
15\usepackage{enumitem}
16
17%-----------------------------------------------------------------------------
18
19\nonstopmode
20
21%-----------------------------------------------------------------------------
22
23\newcommand{\command}[1]{\texttt{#1}}
24\newcommand{\prog}[1]{\textsl{#1}}
25\newcommand{\term}[1]{\textit{#1}}
26\newcommand{\dashwiki}{\prog{DashWiki}}
27\newcommand{\TODO}{\textbf{TODO}}
28\newcommand{\reqfunc}{\textit{<<functional>>}}
29\newcommand{\reqnf}{\textit{<<non-functional>>}}
30
31%-----------------------------------------------------------------------------
32
33\title{Wizja aplikacji \dashwiki}
34\author{
35  Magdalena Baczyńska \\
36  Tomasz Drąg \\
37  Stanisław Klekot \\
38  Bartłomiej Żmudziński
39}
40\date{26 lutego 2013}
41
42\begin{document}
43
44\maketitle
45
46\setlist{noitemsep,leftmargin=*}
47
48\section{Wprowadzenie} % {{{
49
50\subsection{Przeznaczenie dokumentu wizji}
51
52Celem dokumentu jest zebranie, analiza i definicja cech aplikacji \dashwiki.
53
54\subsection{Ogólny opis produktu}
55
56Dokument zawiera wizję aplikacji, która na podstawie danych z innych aplikacji
57i systemów umożliwia wyświetlanie w formie tablicy rozdzielczej
58(\term{dashboarda}) bieżącego stanu środowiska monitorowanego przez wspomniane
59aplikacje i systemy.
60
61Inspiracją projektu jest ruch \term{\#monitoringsucks}
62(\texttt{https://github.com/monitoringsucks}).
63
64% }}}
65
66\section{Sformułowanie problemu} % {{{
67
68\begin{longtable}{|p{4cm}|p{9cm}|}
69  \hline
70    Problem &
71    \parbox{\linewidth}{
72      \begin{enumerate}[label=\alph*)]
73        \item rozproszenie informacji o monitorowanym środowisku
74        \item konieczność pisania całego \term{dashboarda} od nowa dla nowo
75          napisanego systemu
76      \end{enumerate}
77    }
78  \\ \hline
79    Dotyczy &
80    \parbox{\linewidth}{
81      \begin{enumerate}[label=\alph*)]
82        \item administratorzy systemów i sieci
83        \item programiści tworzący systemy monitoringu
84      \end{enumerate}
85    }
86  \\ \hline
87    Wpływ problemu &
88    \parbox{\linewidth}{
89      \begin{enumerate}[label=\alph*)]
90        \item utrudniona orientacja w stanie środowiska; utrudnione
91          przedstawianie zestawień informacji z różnych systemów monitoringu
92        \item zwiększony nakład pracy potrzebny do napisania nowego systemu
93          dłuższy czas prac do wyświetlenia pierwszych wyników
94      \end{enumerate}
95    }
96  \\ \hline
97    Pomyślne rozwiązanie &
98    \parbox{\linewidth}{
99      \begin{enumerate}[label=\alph*)]
100        \item stan środowiska dostępny w jednej aplikacji
101        \item przyspieszenie prac przy pisaniu systemu
102      \end{enumerate}
103    }
104  \\ \hline
105\end{longtable}
106
107% }}}
108
109\section{Przegląd udziałowców i użytkowników systemu} % {{{
110
111\subsection{Użytkownicy systemu}
112
113\begin{longtable}{|p{2cm}|p{5.5cm}|p{5.5cm}|}
114  \hline
115    \textbf{nazwa} &
116    \textbf{opis/rola} &
117    \textbf{kompetencje} \\
118  \hline \endhead
119    gość &
120    Reprezentuje końcowego użytkownika. Osoba zainteresowana stanem środowiska
121    przedstawionym na \term{dash\-boar\-dzie}. &
122    Przegląda \term{dashboardy}. \newline
123    Loguje się do systemu, zostając \term{użytkownikiem}. \\
124  \hline
125    użytkownik &
126    Reprezentuje końcowego użytkownika. Osoba zainteresowana stanem środowiska
127    albo zmianą definicji \term{dash\-boar\-da}.
128    &
129    Przegląda \term{dashboardy}. \newline
130    Edytuje, tworzy i usuwa \term{dash\-boar\-dy}. \newline
131    Dodaje zewnętrzne źródła informacji wyświetlanych na
132    \term{dash\-boar\-dach}. \\
133  \hline
134    administrator &
135    Użytkownik końcowy, który instaluje i konserwuje aplikację \dashwiki,
136    systemy monitoringu i zarządza monitorowanym środowiskiem. &
137    Konserwuje instancję aplikacji. \\
138  \hline
139\end{longtable}
140
141\subsection{Kluczowe potrzeby użytkowników i udziałowców}
142
143\begin{longtable}{|p{6cm}|p{2cm}|p{5cm}|}
144  \hline
145    \textbf{potrzeba} &
146    \textbf{priorytet} &
147    \textbf{źródło} \\
148  \hline \endhead
149    łatwość instalacji i rozruchu \dashwiki &
150    &
151    administrator \\
152  \hline
153    łatwość definiowania \term{dashboarda} &
154    &
155    użytkownik \\
156  \hline
157    łatwość włączania nowych źródeł danych &
158    &
159    użytkownik \\
160  \hline
161    łatwość rozszerzania aplikacji \dashwiki &
162    &
163    programista-autor \dashwiki \\
164  \hline
165    dostępność \term{dashboarda} z różnych urządzeń (tablet, smartphone,
166    komputery) &
167    &
168    programista-autor \dashwiki \\
169  \hline
170    powszechna znajomość frameworka, w którym \dashwiki{} zostanie stworzone &
171    &
172    użytkownik-programista \\
173  \hline
174\end{longtable}
175
176% }}}
177
178\section{Możliwości produktu} % {{{
179
180\begin{longtable}{|p{6.5cm}|p{6.5cm}|}
181  \hline
182    \textbf{korzyść} &
183    \textbf{własności aplikacji} \\
184  \hline \endhead
185    \parbox{\linewidth}{
186      integracja informacji o stanie z różnych źródeł
187    } &
188    \parbox{\linewidth}{
189      \begin{itemize}
190        \item dodawanie i usuwanie \term{dashboardów}
191        \item dodawanie i usuwanie zewnętrznych źródeł informacji
192        \item wyświetlanie listy
193        \item wyświetlanie tekstu
194        \item wyświetlanie wykresu
195      \end{itemize}
196    } \\
197  \hline
198    \parbox{\linewidth}{
199      szybkie budowanie nowych systemów monitoringu
200    } &
201    \parbox{\linewidth}{
202      \begin{itemize}
203        \item łatwa instalacja
204        \item wygodny język formatowania \term{dashboarda}
205      \end{itemize}
206    } \\
207  \hline
208\end{longtable}
209
210% }}}
211
212\section{Własności produktu} % {{{
213
214\begin{description}
215  \item[FEAT 1] \reqfunc \\
216    dodawanie i usuwanie \term{dashboardów}
217  \item[FEAT 2] \reqfunc \\
218    dodawanie i usuwanie zewnętrznych źródeł wyświetlanych informacji
219  \item[FEAT 3] \reqfunc \\
220    wyświetlenie listy (informacja pobierana z zewnętrznego źródła)
221  \item[FEAT 4] \reqfunc \\
222    wyświetlenie tekstu (informacja pobierana z zewnętrznego źródła)
223  \item[FEAT 5] \reqfunc \\
224    wyświetlenie wykresu (informacja pobierana z zewnętrznego źródła)
225  \item[FEAT 6] \reqnf \\
226    łatwe rozszerzenie aplikacji o obsługę nowego protokołu
227  \item[FEAT 7] \reqnf \\
228    łatwe rozszerzanie/zmienianie aplikacji przez administratora (popularność
229    wśród administratorów frameworka i języka, w którym \dashwiki{} jest
230    napisane)
231  \item[FEAT 8] \reqnf \\
232    łatwa instalacja aplikacji
233  \item[FEAT 9] \reqnf \\
234    wygodny język formatowania (opisu) \term{dashboarda}
235  \item[FEAT 10] \reqnf \\
236    łatwe rozszerzanie języka formatowania (parser wygenerowany z gramatyki)
237  \item[FEAT 11] \reqnf \\
238    dostępność \dashwiki{} z komputerów i urządzeń mobilnych (\dashwiki{}
239    wykonane jako webaplikacja)
240\end{description}
241
242\begin{longtable}{|p{1cm}|p{2.2cm}|p{2.2cm}|p{2.2cm}|p{2.2cm}|p{2.2cm}|}
243  \hline
244    FEAT ID &
245    status  &
246    korzyść biznesowa &
247    wysiłek &
248    ryzyko  &
249    stabilność \\
250  \hline \endhead
251    1 & & & & & \\
252  \hline
253    2 & & & & & \\
254  \hline
255    3 & & & & & \\
256  \hline
257    4 & & & & & \\
258  \hline
259    5 & & & & & \\
260  \hline
261    6 & & & & & \\
262  \hline
263    7 & & & & & \\
264  \hline
265    8 & & & & & \\
266  \hline
267    9 & & & & & \\
268  \hline
269    10 & & & & & \\
270  \hline
271    11 & & & & & \\
272  \hline
273\end{longtable}
274
275% }}}
276
277\end{document}
278
279% vim:enc=utf8:foldmethod=marker