source: vision/vision.tex @ 67fdae0e986614e255862b0b2605ddaf342fab6e

Revision 67fdae0e986614e255862b0b2605ddaf342fab6e, 10.5 KB checked in by Stanislaw Klekot <stanislaw.klekot@…>, 7 years ago (diff)

[on behalf of tdrag] Added few requirements.

  • Property mode set to 100644
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] \reqfunc \\
226    edycja tylko dla osób zalogowanych
227  \item[FEAT 7] \reqfunc \\
228    możliwość wylogowania się
229  \item[FEAT 8] \reqnf \\
230    po zalogowaniu się użytkownika system nie wymaga podawania żadnych
231    dodatkowych haseł
232  \item[FEAT 9] \reqfunc \\
233    system umożliwia tworzenie dowolnej liczby stron --- ograniczenie co do
234    liczby stron narzucać będzie sprzęt na którym zostanie zainstalowana
235    DashWiki
236  \item[FEAT 10] \reqfunc \\
237    nazwa strony ustalana przez użytkownika
238  \item[FEAT 11] \reqfunc \\
239    możliwość powrotu do strony głównej
240  \item[FEAT 12] \reqfunc \\
241    możliwość powrotu do poprzedniej strony
242  \item[FEAT 13] \reqfunc \\
243    możliwość przejścia z informacji zbiorczej do informacji szczegółowej
244    poprzez kliknięcie na danym obiekcie
245  \item[FEAT 14] \reqfunc \\
246    wyświetlenie listy rewizji wszystkich stron (historia)
247  \item[FEAT 15] \reqfunc \\
248    każda rewizja niesie informacje o dacie utworzenia, dacie skasowania,
249    zmianie parametrów strony oraz autorach tych czynności
250  \item[FEAT 16] \reqfunc \\
251    wyświetlenie listy stron (nieskasowanych)
252  \item[FEAT 17] \reqfunc \\
253    możliwość zdefiniowania rozmieszczenia na obszarze roboczym elementów do
254    wyświetlenia
255  \item[FEAT 18] \reqfunc \\
256    brak ograniczenia liczby elementów do obserwacji na jednej stronie ---
257    zdajemy się na rozsądek osoby edytującej stronę
258  \item[FEAT 19] \reqfunc \\
259    dodawanie opisów do wstawionych obiektów
260  \item[FEAT 20] \reqfunc \\
261    możliwość zdefiniowania koloru w jakim stan obiektu będzie wyświetlony;
262  \item[FEAT 21] \reqfunc \\
263    kasowanie \term{dashboarda} będzie wymagało potwierdzenia ze strony
264    użytkownika
265  \item[FEAT 22] \reqfunc \\
266    możliwość wstawiania na stronie linków do zewnętrznych zasobów (np.
267    dokumentacji, Wikipedii itp.)
268  \item[FEAT 23] \reqfunc \\
269    gość może przeglądać utworzone strony DashWiki ale nie może nic edytować
270  \item[FEAT 24] \reqfunc \\
271    użytkownik może przeglądać i edytować całą DashWiki
272  \item[FEAT 25] \reqfunc \\
273    administrator może dodawać i usuwać użytkowników
274  \item[FEAT 26] \reqnf \\
275    łatwe rozszerzenie aplikacji o obsługę nowego protokołu
276  \clearpage
277  \item[FEAT 27] \reqnf \\
278    łatwe rozszerzanie/zmienianie aplikacji przez administratora (popularność
279    wśród administratorów frameworka i języka, w którym \dashwiki{} jest
280    napisane)
281  \item[FEAT 28] \reqnf \\
282    łatwa instalacja aplikacji
283  \item[FEAT 29] \reqnf \\
284    wygodny język formatowania (opisu) \term{dashboarda}
285  \item[FEAT 30] \reqnf \\
286    łatwe rozszerzanie języka formatowania (parser wygenerowany z gramatyki)
287  \item[FEAT 31] \reqnf \\
288    dostępność \dashwiki{} z komputerów i urządzeń mobilnych (\dashwiki{}
289    wykonane jako webaplikacja)
290  \item[FEAT 32] \reqnf \\
291    aplikacja powinna być lekka, tzn. uruchamiać się na systemach z 256 MB
292    pamięci RAM
293  \item[FEAT 33] \reqnf \\
294    rozwiązanie musi posiadać spójny graficzny interfejs użytkownika (wygląd
295    ekranu, obsługa klawiszy funkcyjnych, menu)
296  \item[FEAT 34] \reqnf \\
297    kod źródłowy i UI (interfejs użytkownika) w języku angielskim
298\end{description}
299
300\begin{longtable}{|p{1cm}|p{2.2cm}|p{2.2cm}|p{2.2cm}|p{2.2cm}|p{2.2cm}|}
301  \hline
302    FEAT ID &
303    status  &
304    korzyść biznesowa &
305    wysiłek &
306    ryzyko  &
307    stabilność \\
308  \hline \endhead
309    1 & & & & & \\
310  \hline
311    2 & & & & & \\
312  \hline
313    3 & & & & & \\
314  \hline
315    4 & & & & & \\
316  \hline
317    5 & & & & & \\
318  \hline
319    6 & & & & & \\
320  \hline
321    7 & & & & & \\
322  \hline
323    8 & & & & & \\
324  \hline
325    9 & & & & & \\
326  \hline
327    10 & & & & & \\
328  \hline
329    11 & & & & & \\
330  \hline
331    12 & & & & & \\
332  \hline
333    13 & & & & & \\
334  \hline
335    14 & & & & & \\
336  \hline
337    15 & & & & & \\
338  \hline
339    16 & & & & & \\
340  \hline
341    17 & & & & & \\
342  \hline
343    18 & & & & & \\
344  \hline
345    19 & & & & & \\
346  \hline
347    20 & & & & & \\
348  \hline
349    21 & & & & & \\
350  \hline
351    22 & & & & & \\
352  \hline
353    23 & & & & & \\
354  \hline
355    24 & & & & & \\
356  \hline
357    25 & & & & & \\
358  \hline
359    26 & & & & & \\
360  \hline
361    27 & & & & & \\
362  \hline
363    28 & & & & & \\
364  \hline
365    29 & & & & & \\
366  \hline
367    30 & & & & & \\
368  \hline
369    31 & & & & & \\
370  \hline
371        32 & & & & & \\
372  \hline
373        33 & & & & & \\
374  \hline
375        34 & & & & & \\
376  \hline
377\end{longtable}
378
379% }}}
380
381\end{document}
382
383% vim:enc=utf8:foldmethod=marker
Note: See TracBrowser for help on using the repository browser.