Případová studie: Verzovaná dokumentace - Požadavky

V této kapitole si popíšeme požadavky na Verzovanou dokumentaci, tedy aplikaci, kterou chceme v ObjectGears vytvořit.

S Verzovanou dokumentací by měly pracovat tři typy uživatelů:

1. Čtenář (neautentizovaný uživatel) - vyhledává články, zobrazuje si je a hodnotí.
2. Editor - píše články dokumentace a aktualizuje je.
3. Administrátor - Udržuje číselníky jako je seznam verzí či jazyků a provádí hromadné změny, pokud jsou třeba.

Čtenář článků bude mít možnost:

1. vyhledávat články
   1. pomocí textů, které mají obsahovat
   2. pomocí klíčových slov (tagů)
   3. procházením struktury článků (strom nadřízených a podřízených článků)
   4. pomocí identifikátoru článku
2. přecházet mezi články pomocí odkazů, jimiž jsou vzájemně propojeny
3. hodnotit články

Editor článků bude moci:

1. Vytvářet nové články.
2. Editovat stávající články.
3. Vytvářet nová klíčová slova (tagy).
4. Postupně připravovat novou verzi textu, zatímco se zobrazuje stávající verze textu.
5. Indikovat, že článek má být přeložen nebo zkontrolován z pohledu obsahu či gramatiky.
6. Zobrazit přehled všech článků, které vyžadují jeho pozornost.

Administrátor bude moci:

1. Spravovat základní číselníky (jazyky, verze, témata).
2. Provádět hromadné operace s daty.

U článku bude možné:

1. Zadat různé verze textu článku pro různé verze produktu a pro různé jazyky.
2. Pro každou verzi textu článku bude možné stanovit, pro jaké verze produktu se má zobrazit.
3. Ve článku budou moci být zobrazeny formátované texty, tabulky, odkazy na jiné články nebo na obsah mimo Verzovanou dokumentaci, soubory, videa, související články, tagy.
4. Protože článek bude zobrazován na webu, bude možné v článku definovat html tagy a url.
5. Každý článek bude mít svůj unikátní kód, pomocí nějž ho bude možné vyhledat.