source: vision/vision.tex @ b109f53a43ce51ca9aeee9b21f6fb2984dc81bb4

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

Added changelog to vision and vocabulary documents.

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