Dokument wymagań aplikacji: czym jest i po co zatwierdzać

Jednostronicowa specyfikacja, którą zatwierdzasz najpierw: okładka wpisu na blogu Deployflix

Dokument wymagań aplikacji, czyli jej specyfikacja, to krótki pisemny plan przygotowany przed rozpoczęciem prac: kto będzie korzystać z aplikacji, jakie ekrany zobaczy każdy użytkownik, jakie informacje aplikacja przechowuje, z jakimi usługami się łączy, czego na razie nie obejmuje i jaki może być maksymalny koszt jej stworzenia. Należy go przeczytać, omówić, zadać pytania i wprowadzić zmiany, a zatwierdzić dopiero wtedy, gdy opisuje aplikację, która jest rzeczywiście potrzebna.

Specyfikację zatwierdza się najpierw, ponieważ to najtańszy etap na znalezienie błędu. Przesunięcie jednej linijki na stronie nic nie kosztuje. Jeśli dopiero po stworzeniu aplikacji okaże się, że korepetytorzy widzą numery telefonów wszystkich rodziców albo że opłat nie można rozłożyć na raty, konieczne będzie ponowne wykonanie części prac.

Czym, mówiąc prosto, jest specyfikacja oprogramowania?

W informatyce specyfikacja — w większych projektach często nazywana dokumentem wymagań lub SRS, czyli specyfikacją wymagań oprogramowania — jest uzgodnieniem między osobą, która potrzebuje aplikacji, a jej wykonawcą. Określa, co aplikacja ma robić, a nie jak realizuje to kod. W przypadku sklepu, klubu lub szkoły zwykle wystarcza jedna strona, o ile zawiera konkrety i jest napisana prostym językiem.

Test specyfikacji jest prosty: czy dwóch różnych wykonawców mogłoby ją przeczytać i stworzyć mniej więcej taką samą aplikację? Jeśli na stronie jest napisane, że uczniowie mogą zobaczyć swoje wyniki, to tylko życzenie. Jeśli mówi ona, że uczeń loguje się numerem telefonu i widzi oceny z własnych testów, pogrupowane według przedmiotów, obok średniej grupy, jest to wymaganie, które można zrealizować i sprawdzić.

Co powinna zawierać jednostronicowa specyfikacja wymagań aplikacji?

Weźmy centrum korepetycji, które potrzebuje aplikacji do zarządzania zajęciami, obecnością i opłatami. Przydatna jednostronicowa specyfikacja takiej aplikacji zawiera następujące części:

Część specyfikacjiCo zawieraPrzykład dla centrum korepetycji
Kto z niej korzystaKażdy rodzaj użytkownika, który się loguje, oraz jego uprawnieniaWłaściciel, korepetytorzy, uczniowie i rodzice; tylko właściciel widzi łączne kwoty opłat
Ekrany według rólStrony widoczne dla każdej roli i dostępne na nich działaniaKorepetytor: dzisiejsze zajęcia, zaznaczanie obecności, wpisywanie ocen z testów. Rodzic: obecność, oceny, należne opłaty
Przechowywane daneRekordy przechowywane przez aplikację i zawartość każdego z nichUczniowie, zajęcia, obecność na poszczególnych spotkaniach, testy i oceny, raty opłat oraz pokwitowania
IntegracjeUsługi zewnętrzne, z którymi aplikacja się łączy, oraz sposób połączeniaPłatności opłat online przez bramkę płatniczą, z pokwitowaniem każdej raty
Odłożone na późniejCzego ta wersja nie będzie robićBez wykrywania kolizji w planie zajęć; bez importu danych z ubiegłego roku
Maksymalny kosztNajwyższy możliwy koszt procesu tworzeniaMaksymalna kwota podana przed zatwierdzeniem, a nie szacunek po wykonaniu pracy

Część dotycząca ekranów według ról jest najczęściej czytana pobieżnie, choć ma największe znaczenie. Jedna aplikacja to tak naprawdę kilka aplikacji korzystających z tych samych danych: widok właściciela, widok korepetytora i widok rodzica. Czytając opis ekranów kolejno dla każdej roli, można zauważyć, że korepetytor może zaznaczyć obecność, ale nikt nie może poprawić popełnionego przy tym błędu.

Wiersz na razie poza zakresem jest równie ważny. Pokazuje, czego Państwo nie otrzymają — a to zwykle jest źródłem rozczarowania po zakończeniu procesu tworzenia. Krótka i uczciwa lista wyłączeń świadczy o dobrej specyfikacji, a nie o jej słabości.

Gdy opisują Państwo aplikację w Deployflix, tworzona specyfikacja ma następującą strukturę: kto korzysta z aplikacji, jakie ma ona ekrany, jakie dane przechowuje, co na razie pozostaje poza zakresem i ile najwyżej może kosztować proces tworzenia. Wszystko jest napisane w języku, którego Państwo użyli. Jeśli coś w opisie jest niejasne, Deployflix zadaje pytania przed przygotowaniem planu. Strona Jak to działa pokazuje miejsce specyfikacji w całym procesie.

Jak czytać specyfikację aplikacji i zadawać do niej pytania?

Nie należy czytać specyfikacji jak umowy, od początku do końca. Lepiej spojrzeć na nią jak na typowy dzień w swojej firmie.

  1. Proszę przejść przez prawdziwy dzień z perspektywy każdej roli. Co dana osoba naciska, co widzi i co wpisuje? Następnie proszę zrobić to samo dla wszystkich pozostałych ról.
  2. Proszę prześledzić jeden rekord od początku do końca. Może to być jeden uczeń, jedno zamówienie lub jedna rezerwacja. Kto tworzy ten rekord, kto go zmienia, kto może go usunąć i gdzie ostatecznie trafia?
  3. Proszę sprawdzić scenariusze, w których coś idzie nie tak. Anulowana rezerwacja, zwrot pieniędzy, błędny wpis, nieudana płatność czy odejście członka. Jeśli specyfikacja opisuje tylko sytuacje, w których wszystko działa prawidłowo, warto zapytać, co się stanie, gdy tak nie będzie.
  4. Proszę sprawdzić każdą liczbę i każde słowo, które może trafić na wydruk. Format faktur, raty opłat, pozycje podatkowe i numery pokwitowań powinny odpowiadać obecnemu sposobowi pracy. Jeśli faktury muszą zawierać podatek, taki jak GST, VAT lub podatek od sprzedaży, szczegóły należy sprawdzić z księgowym.
  5. Proszę pytać o wszystko, co jest niejasne. Słowa takie jak zarządzać, śledzić, łatwy i raporty ukrywają decyzje. Warto zapytać: który raport, co ma pokazywać i komu?

Jakich braków szukać przed zatwierdzeniem?

Większość specyfikacji, z którymi później są problemy, nie zawiera błędów — jest po prostu niekompletna. Poniższe braki pojawiają się najczęściej.

Kto może co zobaczyć

Role łatwo nazwać, ale równie łatwo opisać zbyt ogólnie. Proszę sprawdzić nie tylko, co każda rola może robić, lecz także co może zobaczyć. Czy korepetytor widzi opłaty? Czy jeden rodzic może zobaczyć oceny innego dziecka? Czy pracownik może pobrać listę klientów? Jeśli aplikacja przechowuje dane osobowe, już teraz należy zdecydować, kto może je zobaczyć.

Edytowanie, anulowanie i cofanie zmian

Każdy rekord prędzej czy później będzie wymagał poprawienia. Proszę sprawdzić, czy specyfikacja określa, kto może edytować lub anulować wpis oraz czy zachowywana jest jego poprzednia wartość.

Pieniądze

Jeśli aplikacja przyjmuje płatności, specyfikacja powinna przedstawiać ich przebieg: jak klienci mogą płacić (kartami i lokalnymi metodami płatności), za co płacą, czy dopuszczalna jest płatność częściowa, co klient otrzymuje po zapłacie i co dzieje się, gdy płatność nie zostanie dokonana lub się nie powiedzie. Zasady zwrotów to decyzja biznesowa, dlatego proszę spisać własne. Operatorzy bramek zwykle pobierają procent od transakcji, a w wielu krajach także stałą opłatę, więc warto sprawdzić cennik swojego operatora. Aplikacje Deployflix przyjmują płatności przez bramkę płatniczą, taką jak Razorpay lub Cashfree; obsługa międzynarodowych bramek pojawi się wkrótce. Nasza strona integracji pokazuje, z czym można się obecnie połączyć.

Wiadomości i przypomnienia

Jeśli potrzebują Państwo przypomnień, należy określić, jak mają docierać do odbiorców: e-mailem, w aplikacji czy w inny sposób. Jeśli specyfikacja nie wymienia danego kanału, należy przyjąć, że nie będzie dostępny.

Państwa dotychczasowe dane

Dane z arkuszy kalkulacyjnych i starych rejestrów często trzeba przenieść do nowej aplikacji. Proszę zapytać, czy ich import wchodzi w zakres specyfikacji, czy znajduje się na liście poza zakresem.

Urządzenia i języki

Czy aplikacja będzie używana na telefonie, komputerze przy ladzie sklepowej, czy na obu urządzeniach? Czy oprócz angielskiego ma być dostępna także po hiszpańsku, arabsku, francusku lub w innym języku? Ma to wpływ na wygląd ekranów, dlatego trzeba ustalić te kwestie przed rozpoczęciem tworzenia. Deployflix przygotowuje teksty w aplikacji w wybranym przez Państwa języku, a sam serwis działa w 41 językach.

Dlaczego należy zatwierdzić specyfikację przed rozpoczęciem tworzenia?

Ponieważ zmiana zdania jest tańsza niż zmiana aplikacji. Przed rozpoczęciem tworzenia dodanie roli rodzica lub raty opłaty wymaga jedynie edycji strony. Po zakończeniu tworzenia ta sama zmiana może dotyczyć gotowych już ekranów, danych i uprawnień.

Zatwierdzenie daje również punkt odniesienia do sprawdzenia gotowej aplikacji. Po zakończeniu procesu tworzenia można otworzyć specyfikację i kolejno sprawdzić każdą rolę, każdy ekran i każdy rodzaj danych. Każdy brak jest uzasadnioną kwestią do zgłoszenia.

Specyfikacja określa też koszt, zanim podejmą Państwo zobowiązanie. Gdy maksymalny koszt tworzenia jest zapisany w specyfikacji, podejmują Państwo decyzję, znając konkretną kwotę. W Deployflix ten limit jest widoczny przed zatwierdzeniem, a płacą Państwo tylko za kredyty rzeczywiście zużyte podczas tworzenia, zgodnie z wyjaśnieniem w cenniku.

Jak planuje się zmiany po stworzeniu aplikacji?

Praca nad aplikacją rzadko kończy się na pierwszej wersji. Nowy kurs, druga lokalizacja czy nowy sposób pobierania opłat — każda taka zmiana wymaga równie starannego podejścia jak pierwszy proces tworzenia.

Zmianę należy zaplanować w formie osobnej, krótkiej specyfikacji: co się zmienia, których ról i ekranów dotyczy, jakie dane zostaną dodane lub zmodyfikowane, co pozostanie bez zmian i ile może to kosztować. Trzeba ją przeczytać z taką samą uwagą i zatwierdzić przed rozpoczęciem pracy. Warto zachować wcześniejszą wersję, aby w razie problemów móc wrócić do tej, która działała.

Tak Deployflix obsługuje zmiany: mówią Państwo, co należy zmienić, Deployflix planuje tę zmianę jako kolejną wersję, a tworzenie rozpoczyna się dopiero po jej zatwierdzeniu. Wszystkie wcześniejsze wersje są zachowywane. W organizacji zatwierdzać mogą tylko osoby, których rola na to pozwala, zgodnie z opisem na stronie o bezpieczeństwie.

Szablon specyfikacji aplikacji do wykorzystania

Jeśli przygotowują Państwo własną specyfikację, można skopiować poniższe nagłówki i uzupełnić każdy z nich prostymi zdaniami:

  • Aplikacja w jednym zdaniu: dla kogo jest przeznaczona i jakie zadanie wykonuje.
  • Role: każdy rodzaj użytkownika oraz to, co może zobaczyć i zrobić.
  • Ekrany według ról: ekrany dostępne dla każdej roli i działania wykonywane na każdym z nich.
  • Przechowywane dane: każdy rodzaj rekordu i zawarte w nim informacje.
  • Integracje: płatności, Państwa domena, sklepy z aplikacjami, miejsce przechowywania kodu i wszystkie inne połączenia.
  • Zasady: opłaty, limity, terminy, anulowanie i zwroty pieniędzy.
  • Na razie poza zakresem: czego ta wersja nie będzie robić.
  • Maksymalny koszt i zatwierdzenie: najwyższy możliwy koszt oraz osoba zatwierdzająca.

Praktyczne przykłady ról, ekranów i danych można znaleźć w opisie systemu zarządzania grupami w centrum korepetycjiEN lub aplikacji do umawiania wizyt w przychodniEN. Założyciel testujący pomysł może przygotować jeszcze krótszą specyfikację: z jedną rolą, kilkoma ekranami i konkretną listą elementów pozostających poza zakresem, tak jak w przypadku internetowej aplikacji MVP dla startupuEN.

Pytania

Czym różni się specyfikacja aplikacji od dokumentu wymagań?

Głównie długością i stopniem formalności. Dokument wymagań dla dużego projektu może mieć wiele stron ponumerowanych wymagań. Specyfikacja aplikacji dla małej firmy obejmuje te same zagadnienia — kto z niej korzysta, co ona robi i jakie dane przechowuje — ale mieści je na jednej stronie i opisuje prostym językiem.

Kto powinien napisać specyfikację aplikacji?

Treść dostarcza osoba znająca firmę: role, codzienną pracę i obowiązujące zasady. Wykonawca może przekształcić te informacje w uporządkowaną specyfikację, ale tylko Państwo mogą ocenić, czy jest prawidłowa.

Czy po zatwierdzeniu mogę zmienić specyfikację?

Tak. Należy potraktować to jako zmianę: opisać różnice, przeczytać zaktualizowany plan i ponownie go zatwierdzić. Warto zachować wcześniejszą wersję, aby móc je porównać lub do niej wrócić.

Jak długa powinna być specyfikacja aplikacji?

Na tyle długa, aby żadnej ważnej kwestii nie pozostawić domysłom, i na tyle krótka, aby przeczytali ją Państwo w całości. Dla większości aplikacji dla małych firm odpowiednia jest jedna strona. Jeśli specyfikacja jest znacznie dłuższa, warto rozważyć tworzenie aplikacji etapami.

Opisz swoją aplikację

Proszę własnymi słowami opisać swoje potrzeby. Deployflix przygotuje jednostronicowy plan z kosztem i rozpocznie tworzenie dopiero po jego zatwierdzeniu.