1. Případová studie: Verzovaná dokumentace - Návrh řešení

    Článek: AN0002334Aktualizováno:: 02.12.2018

    Požadavky uvedené v předchozí kapitole nejprve reflektujeme v datovém modelu. Nakreslíme si Entity-Relationship diagram a níže vysvětlíme funkci jednotlivých entit a jejich atributů. Pak navrhneme také stránku, na které budeme data zobrazovat.

    Datový model

     

    Entita/atribut Popis
    Třída Language (Jazyk) Číselník jazyků, do kterých uživatel může přepnout dokumentaci.
    Třída Article (Článek) Třída článků - obsahuje vlastnosti společné pro všechny verze článku lišící se v jazyku a verzi.
       Number Unikátní identifikátor článku - automaticky generovaná sekvence.
       Name Interní název článku. Nezobrazuje se uživatelům, ale pouze editorovi článku při vybírání nadřízeného článku nebo souvisejících článků. 
       Comment Podrobnější popis potřebných úprav v článku.
       Check content Indikuje potřebu zkontrolovat článek z pohledu správnosti a přesnosti jeho obsahu.
       Solver Řešitel, který má pracovat na článku.
       Active Indikuje, že se má článek zobrazovat.
       Last version Poslední verze, pro kterou je článek releventní. Pro vyšší verze se již nezobrazuje. 
       Topic Zařazení článku do tématu (článek je zařazen buď k tématu nebo k nadřízenému článku).
       Parent article Zařazení článku k nadřízenému článku (článek je zařazen buď k tématu nebo k nadřízenému článku).
       Also Související články nabízené u článku.
       Dashboard order Pořadí článku na hlavní straně (zobrazují se tam pouze články se zde vyplněným pořadím). 
       Order Pořadí článku ve stromu pod nadřízeným článkem. Nejprve se zobrazují články s vyplněným pořadím. Následně články bez vyplněného pořadí dle názvu Textu článku.
       Tag Tagy vybrané u článku.
       Rating Průměrné hodnocení článku vypočítané z dosavadních hodnocení.
    Třída Article text Třída jednotlivých verzí článku (texty se liší v jazyku a verzi).
       Article Článek, ke kterému Text patří.
       Language Jazyk Textu článku.
       From version Verze, od které se má text zobrazovat. U dřívějších verzí se článek nebude zobrazovat.
       Name Název článku. Pro optimalizaci pro vyhledávače (SEO) je uveden ve stránce jako součást html tagu Title a tagu H1.
       URL URL textu  článku.
       Comment Podrobnější popis úprav, které je třeba s textem provést.
       Published text Text článku, který má být zobrazován. Tento text bude kopírován z New text ve chvíli, kdy se editor New text rozhodne publikovat. Článek, který nemá tento sloupec vyplněn, nebude zobrazován.
       New text Připravovaná nová verze textu. Po publikování bude zkopírován do sloupce Published text.
       Files Soubory přiložené k textu článku.
       Files in page Soubory dle volby editora zobrazitelné kdekoli ve stránce s textem.
       Last published Datum poslední aktualizace sloupce Published text.
       Name in menu Název textu článku zobrazovaný v menu. Pokud není vyplněn, je zobrazována hodnota ze sloupce Name.
       Meta description Text uvedený ve stránce v meta tagu Description. Google uvádí obsah tohoto meta tagu jako popis pod výsledky vyhledávání. Text by měl motivovat uživatele kliknout na odkaz ve výsledcích vyhledávání Google. 
       Meta keywords Text uvedený ve stránce v meta tagu Keywords.
       Display count Počet zobrazení Článku.
       Solver Řešitel, který má pracovat na textu článku.
       Grammar check Indikuje potřebu gramatické kontroly Textu článku.
       Translate Indikuje potřebu přeložit Text článku do dalších jazyků.
    Třída Topic Třída témat uváděných na stránce s dokumentací - nejvyšší úroveň kategorizace článků. Témata budou zobrazena v hlavním menu dokumentace.
       Name Název tématu.
       Active Indikuje, že má být téma zobrazováno.
       URL URL stránky s tématem.
       Order Pořadí tématu na stránce.
    Třída Tag Třída tagů.
       Name Název tagu.
       Description Lokalizovaný popis tagu.
       Active Indikuje, zda se má tag nabízet k použití.
    Třída Version Třída verzí.
       Name Název verze.
       Display Indikuje, zda se má verze nabízet ve vyhledávání. Verze, která se teprve připravuje, nebude zobrazována, i když pro ni relevantní články již mohou vznikat.
       Order Pořadí verze v comboboxu pro volbu verze.
    Třída Article display count Počet zobrazení určitého článku v určitém dni.
       Article Článek
       Day Den
       Show count Počet zobrazení daného článku v daném dni.
    Třída Article evaluation Třída obsahující hodnocení uživatelů.
       Article Hodnocený článek.
       Evaluator Hodnotitel (uživatel ObjectGears) - loguje se, pokud je zvolen ve webpartu Hodnocení a uživatel je ověřen.
       IP Hash IP adresy, z níž přistupoval Hodnotitel - loguje se, pokud je zvolena ve webpartu Hodnocení. Lze použít i pro neověřeného/anonymního uživatele.
       Rating Hodnocení

    Zobrazení dat

    Pro zobrazení dat budeme potřebovat tři obrazovky. První zobrazí jednotlivý článek s textem příslušným zvolené verzi a jazyku. Na stránce bude v levé části zobrazena hierarchie, ve které se článek nachází. V horní části bude menu sestávající ze zvolených témat, textbox pro zadání hledaného textu, odkazy na sociální sítě a webpart pro volbu jazyka.

     

    Na druhé obrazovce budou zobrazeny výsledky hledání. Pro každý nalezený článek bude zobrazen jeho název, tagy, meta description (pokud je vyplněno), kód a datum poslední aktualizace článku.

     

    Třetí obrazovka nabídne uživateli seznam dostupných tagů s jejich krátkým popisem.

    Verze produktu

    Řešení musí reflektovat potřebu zobrazovat příslušnou dokumentaci pro jednotlivé verze produktu. Článek může být relevantní jen pro určité verze produktu. Navíc pro určité verze se texty mohou lišit. Mohli bychom pro každou verzi produktu nechat editora vytvořit novou verzi každého článku. To by však nebylo pohodlné, zvláště pokud by se většina článků mezi verzemi nelišila.

    Proto jsme definovali informaci o verzi na dvou místech. U Článku je uvedena Poslední verze, pro kterou se má článek jako takový zobrazit. U Textu článku je uvedeno, od které verze se má text článku zobrazit. Uživateli bude zobrazen vždy text článku s nejvyšší existující verzí reflektující uživatelem zvolenou verzi.

×