source: vision/vision.tex @ bea88f3201d70503ea5b56482553e1b8fdbe27ec

Revision bea88f3201d70503ea5b56482553e1b8fdbe27ec, 11.0 KB checked in by Stanislaw Klekot <dozzie@…>, 7 years ago (diff)

Added fancy headers.

  • 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\usepackage{fancyhdr}
18
19%-----------------------------------------------------------------------------
20
21\nonstopmode
22
23%-----------------------------------------------------------------------------
24
25\newcommand{\command}[1]{\texttt{#1}}
26\newcommand{\prog}[1]{\textsl{#1}}
27\newcommand{\term}[1]{\textit{#1}}
28\newcommand{\dashwiki}{\prog{DashWiki}}
29\newcommand{\TODO}{\textbf{TODO}}
30\newcommand{\reqfunc}{\textit{<<functional>>}}
31\newcommand{\reqnf}{\textit{<<non-functional>>}}
32
33%-----------------------------------------------------------------------------
34
35\pagestyle{fancy}
36\rhead{Wizja aplikacji \dashwiki}
37\lhead{v1.1}
38
39\title{Wizja aplikacji \dashwiki}
40\date{}
41
42\begin{document}
43
44\maketitle \thispagestyle{fancy}
45
46\setlist{noitemsep,leftmargin=*}
47
48\section*{Historia zmian} % {{{
49
50\begin{longtable}{|p{1.7cm}|p{1.0cm}|p{6.2cm}|p{3.7cm}|}
51  \hline
52    \textbf{Data} & \textbf{Wersja} & \textbf{Opis} & \textbf{Autor} \\
53  \hline \endhead
54    2013/03/10 & 1.1 & Rozszerzona lista wymagań. & Tomasz Drąg \\
55  \hline
56    2013/02/26 & 1.0 & Wersja podstawowa. &
57      Magdalena Baczyńska \newline
58      Tomasz Drąg \newline
59      Stanisław Klekot \newline
60      Bartłomiej Żmudziński \\
61  \hline
62\end{longtable}
63
64% }}}
65
66\section{Wprowadzenie} % {{{
67
68\subsection{Przeznaczenie dokumentu wizji}
69
70Celem dokumentu jest zebranie, analiza i definicja cech aplikacji \dashwiki.
71
72\subsection{Ogólny opis produktu}
73
74Dokument zawiera wizję aplikacji, która na podstawie danych z innych aplikacji
75i systemów umożliwia wyświetlanie w formie tablicy rozdzielczej
76(\term{dashboarda}) bieżącego stanu środowiska monitorowanego przez wspomniane
77aplikacje i systemy.
78
79Inspiracją projektu jest ruch \term{\#monitoringsucks}
80(\texttt{https://github.com/monitoringsucks}).
81
82% }}}
83
84\section{Sformułowanie problemu} % {{{
85
86\begin{longtable}{|p{4cm}|p{9cm}|}
87  \hline
88    Problem &
89    \parbox{\linewidth}{
90      \begin{enumerate}[label=\alph*)]
91        \item rozproszenie informacji o monitorowanym środowisku
92        \item konieczność pisania całego \term{dashboarda} od nowa dla nowo
93          napisanego systemu
94      \end{enumerate}
95    }
96  \\ \hline
97    Dotyczy &
98    \parbox{\linewidth}{
99      \begin{enumerate}[label=\alph*)]
100        \item administratorzy systemów i sieci
101        \item programiści tworzący systemy monitoringu
102      \end{enumerate}
103    }
104  \\ \hline
105    Wpływ problemu &
106    \parbox{\linewidth}{
107      \begin{enumerate}[label=\alph*)]
108        \item utrudniona orientacja w stanie środowiska; utrudnione
109          przedstawianie zestawień informacji z różnych systemów monitoringu
110        \item zwiększony nakład pracy potrzebny do napisania nowego systemu
111          dłuższy czas prac do wyświetlenia pierwszych wyników
112      \end{enumerate}
113    }
114  \\ \hline
115    Pomyślne rozwiązanie &
116    \parbox{\linewidth}{
117      \begin{enumerate}[label=\alph*)]
118        \item stan środowiska dostępny w jednej aplikacji
119        \item przyspieszenie prac przy pisaniu systemu
120      \end{enumerate}
121    }
122  \\ \hline
123\end{longtable}
124
125% }}}
126
127\section{Przegląd udziałowców i użytkowników systemu} % {{{
128
129\subsection{Użytkownicy systemu}
130
131\begin{longtable}{|p{2cm}|p{5.5cm}|p{5.5cm}|}
132  \hline
133    \textbf{nazwa} &
134    \textbf{opis/rola} &
135    \textbf{kompetencje} \\
136  \hline \endhead
137    gość &
138    Reprezentuje końcowego użytkownika. Osoba zainteresowana stanem środowiska
139    przedstawionym na \term{dash\-boar\-dzie}. &
140    Przegląda \term{dashboardy}. \newline
141    Loguje się do systemu, zostając \term{użytkownikiem}. \\
142  \hline
143    użytkownik &
144    Reprezentuje końcowego użytkownika. Osoba zainteresowana stanem środowiska
145    albo zmianą definicji \term{dash\-boar\-da}.
146    &
147    Przegląda \term{dashboardy}. \newline
148    Edytuje, tworzy i usuwa \term{dash\-boar\-dy}. \newline
149    Dodaje zewnętrzne źródła informacji wyświetlanych na
150    \term{dash\-boar\-dach}. \\
151  \hline
152    administrator &
153    Użytkownik końcowy, który instaluje i konserwuje aplikację \dashwiki,
154    systemy monitoringu i zarządza monitorowanym środowiskiem. &
155    Konserwuje instancję aplikacji. \\
156  \hline
157\end{longtable}
158
159\subsection{Kluczowe potrzeby użytkowników i udziałowców}
160
161\begin{longtable}{|p{6cm}|p{2cm}|p{5cm}|}
162  \hline
163    \textbf{potrzeba} &
164    \textbf{priorytet} &
165    \textbf{źródło} \\
166  \hline \endhead
167    łatwość instalacji i rozruchu \dashwiki &
168    &
169    administrator \\
170  \hline
171    łatwość definiowania \term{dashboarda} &
172    &
173    użytkownik \\
174  \hline
175    łatwość włączania nowych źródeł danych &
176    &
177    użytkownik \\
178  \hline
179    łatwość rozszerzania aplikacji \dashwiki &
180    &
181    programista-autor \dashwiki \\
182  \hline
183    dostępność \term{dashboarda} z różnych urządzeń (tablet, smartphone,
184    komputery) &
185    &
186    programista-autor \dashwiki \\
187  \hline
188    powszechna znajomość frameworka, w którym \dashwiki{} zostanie stworzone &
189    &
190    użytkownik-programista \\
191  \hline
192\end{longtable}
193
194% }}}
195
196\section{Możliwości produktu} % {{{
197
198\begin{longtable}{|p{6.5cm}|p{6.5cm}|}
199  \hline
200    \textbf{korzyść} &
201    \textbf{własności aplikacji} \\
202  \hline \endhead
203    \parbox{\linewidth}{
204      integracja informacji o stanie z różnych źródeł
205    } &
206    \parbox{\linewidth}{
207      \begin{itemize}
208        \item dodawanie i usuwanie \term{dashboardów}
209        \item dodawanie i usuwanie zewnętrznych źródeł informacji
210        \item wyświetlanie listy
211        \item wyświetlanie tekstu
212        \item wyświetlanie wykresu
213      \end{itemize}
214    } \\
215  \hline
216    \parbox{\linewidth}{
217      szybkie budowanie nowych systemów monitoringu
218    } &
219    \parbox{\linewidth}{
220      \begin{itemize}
221        \item łatwa instalacja
222        \item wygodny język formatowania \term{dashboarda}
223      \end{itemize}
224    } \\
225  \hline
226\end{longtable}
227
228% }}}
229
230\section{Własności produktu} % {{{
231
232\begin{description}
233  \item[FEAT 1] \reqfunc \\
234    dodawanie i usuwanie \term{dashboardów}
235  \item[FEAT 2] \reqfunc \\
236    dodawanie i usuwanie zewnętrznych źródeł wyświetlanych informacji
237  \item[FEAT 3] \reqfunc \\
238    wyświetlenie listy (informacja pobierana z zewnętrznego źródła)
239  \item[FEAT 4] \reqfunc \\
240    wyświetlenie tekstu (informacja pobierana z zewnętrznego źródła)
241  \item[FEAT 5] \reqfunc \\
242    wyświetlenie wykresu (informacja pobierana z zewnętrznego źródła)
243  \item[FEAT 6] \reqfunc \\
244    edycja tylko dla osób zalogowanych
245  \item[FEAT 7] \reqfunc \\
246    możliwość wylogowania się
247  \item[FEAT 8] \reqnf \\
248    po zalogowaniu się użytkownika system nie wymaga podawania żadnych
249    dodatkowych haseł
250  \item[FEAT 9] \reqfunc \\
251    system umożliwia tworzenie dowolnej liczby stron --- ograniczenie co do
252    liczby stron narzucać będzie sprzęt na którym zostanie zainstalowana
253    DashWiki
254  \item[FEAT 10] \reqfunc \\
255    nazwa strony ustalana przez użytkownika
256  \item[FEAT 11] \reqfunc \\
257    możliwość powrotu do strony głównej
258  \item[FEAT 12] \reqfunc \\
259    możliwość powrotu do poprzedniej strony
260  \item[FEAT 13] \reqfunc \\
261    możliwość przejścia z informacji zbiorczej do informacji szczegółowej
262    poprzez kliknięcie na danym obiekcie
263  \item[FEAT 14] \reqfunc \\
264    wyświetlenie listy rewizji wszystkich stron (historia)
265  \item[FEAT 15] \reqfunc \\
266    każda rewizja niesie informacje o dacie utworzenia, dacie skasowania,
267    zmianie parametrów strony oraz autorach tych czynności
268  \item[FEAT 16] \reqfunc \\
269    wyświetlenie listy stron (nieskasowanych)
270  \item[FEAT 17] \reqfunc \\
271    możliwość zdefiniowania rozmieszczenia na obszarze roboczym elementów do
272    wyświetlenia
273  \item[FEAT 18] \reqfunc \\
274    brak ograniczenia liczby elementów do obserwacji na jednej stronie ---
275    zdajemy się na rozsądek osoby edytującej stronę
276  \item[FEAT 19] \reqfunc \\
277    dodawanie opisów do wstawionych obiektów
278  \item[FEAT 20] \reqfunc \\
279    możliwość zdefiniowania koloru w jakim stan obiektu będzie wyświetlony;
280  \item[FEAT 21] \reqfunc \\
281    kasowanie \term{dashboarda} będzie wymagało potwierdzenia ze strony
282    użytkownika
283  \item[FEAT 22] \reqfunc \\
284    możliwość wstawiania na stronie linków do zewnętrznych zasobów (np.
285    dokumentacji, Wikipedii itp.)
286  \item[FEAT 23] \reqfunc \\
287    gość może przeglądać utworzone strony DashWiki ale nie może nic edytować
288  \item[FEAT 24] \reqfunc \\
289    użytkownik może przeglądać i edytować całą DashWiki
290  \item[FEAT 25] \reqfunc \\
291    administrator może dodawać i usuwać użytkowników
292  \item[FEAT 26] \reqnf \\
293    łatwe rozszerzenie aplikacji o obsługę nowego protokołu
294  \clearpage
295  \item[FEAT 27] \reqnf \\
296    łatwe rozszerzanie/zmienianie aplikacji przez administratora (popularność
297    wśród administratorów frameworka i języka, w którym \dashwiki{} jest
298    napisane)
299  \item[FEAT 28] \reqnf \\
300    łatwa instalacja aplikacji
301  \item[FEAT 29] \reqnf \\
302    wygodny język formatowania (opisu) \term{dashboarda}
303  \item[FEAT 30] \reqnf \\
304    łatwe rozszerzanie języka formatowania (parser wygenerowany z gramatyki)
305  \item[FEAT 31] \reqnf \\
306    dostępność \dashwiki{} z komputerów i urządzeń mobilnych (\dashwiki{}
307    wykonane jako webaplikacja)
308  \item[FEAT 32] \reqnf \\
309    aplikacja powinna być lekka, tzn. uruchamiać się na systemach z 256 MB
310    pamięci RAM
311  \item[FEAT 33] \reqnf \\
312    rozwiązanie musi posiadać spójny graficzny interfejs użytkownika (wygląd
313    ekranu, obsługa klawiszy funkcyjnych, menu)
314  \item[FEAT 34] \reqnf \\
315    kod źródłowy i UI (interfejs użytkownika) w języku angielskim
316\end{description}
317
318\begin{longtable}{|p{1cm}|p{2.2cm}|p{2.2cm}|p{2.2cm}|p{2.2cm}|p{2.2cm}|}
319  \hline
320    FEAT ID &
321    status  &
322    korzyść biznesowa &
323    wysiłek &
324    ryzyko  &
325    stabilność \\
326  \hline \endhead
327    1 & & & & & \\
328  \hline
329    2 & & & & & \\
330  \hline
331    3 & & & & & \\
332  \hline
333    4 & & & & & \\
334  \hline
335    5 & & & & & \\
336  \hline
337    6 & & & & & \\
338  \hline
339    7 & & & & & \\
340  \hline
341    8 & & & & & \\
342  \hline
343    9 & & & & & \\
344  \hline
345    10 & & & & & \\
346  \hline
347    11 & & & & & \\
348  \hline
349    12 & & & & & \\
350  \hline
351    13 & & & & & \\
352  \hline
353    14 & & & & & \\
354  \hline
355    15 & & & & & \\
356  \hline
357    16 & & & & & \\
358  \hline
359    17 & & & & & \\
360  \hline
361    18 & & & & & \\
362  \hline
363    19 & & & & & \\
364  \hline
365    20 & & & & & \\
366  \hline
367    21 & & & & & \\
368  \hline
369    22 & & & & & \\
370  \hline
371    23 & & & & & \\
372  \hline
373    24 & & & & & \\
374  \hline
375    25 & & & & & \\
376  \hline
377    26 & & & & & \\
378  \hline
379    27 & & & & & \\
380  \hline
381    28 & & & & & \\
382  \hline
383    29 & & & & & \\
384  \hline
385    30 & & & & & \\
386  \hline
387    31 & & & & & \\
388  \hline
389        32 & & & & & \\
390  \hline
391        33 & & & & & \\
392  \hline
393        34 & & & & & \\
394  \hline
395\end{longtable}
396
397% }}}
398
399\end{document}
400
401% vim:enc=utf8:foldmethod=marker
Note: See TracBrowser for help on using the repository browser.