Vývojová dokumentace - záložka Detail

Položky zadávané k dokumentaci jsou standardně rozděleny do subzáložek dle svého významu:

Obsažené subzáložky: Hlavička Obsah Plán Formuláře

V horní části záložky Detail může být variantně zobrazen některý z Panelů definovatelných údajů detailu pro tuto agendu. Zobrazení panelu definovatelných údajů detailu závisí na aktuálním nastavení v menu Nastavení pro danou agendu a přihlášeného uživatele.

Popis položek, které jsou k dispozici v horní části záložky Detail, je-li zobrazena základní definice Panelu definovatelných údajů detailu:

Název Popis
Doklad Číslo dokladu. Nově vytvářený doklad má uvedeno "bez čísla". Číslo mu je přiděleno po uložení.
Stav Hodnota položky stav z hlavičky dokladu, viz dále.
Vytvořil Uživatel, který daný doklad vytvořil.
Tester Hodnota položky Tester z hlavičky dokladu, viz dále.

Subzáložka Hlavička

Jak bylo uvedeno u popisu funkce Nový v záložce Seznam, pokud zadáváte novou vývojovou dokumentaci v agendě dokumentace vyvolané z agendy požadavků jakožto následnou dokumentaci k aktuálnímu požadavku, pak se některé položky hlavičky dokladu předvyplňují z údajů aktuálního požadavku. Daná dokumentace bude po uložení rovnou svázána s aktuálním požadavkem jako jeho dokumentace následná.

Položky zadávané v hlavičce dokladu:

Název Popis
Řada Zkratka označující řadu dokladů odpovídajícího typu, tj. typu vývojová dokumentace. Povinná položka.
Období Zkratka označující období, do kterého je resp. bude doklad zařazen, tj. do kterého věcně patří. (Který údaj se má v položce zadávat resp. zobrazovat, lze nastavit.) Povinná položka. Předvyplňuje se a kontroluje se dle pravidel uvedených v kap. Předvyplňování datumů.
Datum Datum vystavení dokladu, musí ležet ve vybraném období. Povinná položka.
Firma Firma, se kterou chcete záznam dokumentace svázat. Nepovinná položka.
Produkt Jedná se o vazbu na produkt, tj. k jakému produktu dokumentace náleží. Zadáte zkratku produktu nebo vyberete z číselníku vývojových produktů. (Který údaj se má v položce zadávat resp. zobrazovat, lze nastavit.) Povinná položka.
Část Zkratka části produktu. Jedná se o vazbu na část vybraného produktu, tj. k jaké části vybraného produktu dokumentace náleží. Povinná položka.
Verze

Zkratka verze. Jedná se o vazbu na verzi vybraného produktu, tj. k jaké verzi vybraného produktu dokumentace náleží. Povinná položka.

Číselník se zde nabízí defaultně programově omezený jen za plánované verze s nezatrženým příznakem Generováno (viz též popis omezovacího panelu v záložce Seznam plánovaných verzí).

Při vytváření dokumentace na základě zdrojového požadavku se záměrně nepředvyplňuje číslem plánované verze zadané u zdrojového požadavku, jelikož se v praxi může stát, že plánovaná verze zadaná u požadavku není shodná s verzí, do které se oprava nakonec zrealizovala a pokud by byla položka automaticky přebírána, pak by zadavatel mohl rozpor snadno přehlédnout.
Stav

Stav záznamu dokumentace. Každý záznam může nabývat několika stavů, podle úrovně otestování záznamu. Povinná položka, předvyplňuje se první hodnota skrytého seznamu, tj. Netestováno.

Záznam nelze převést do stavu OK, Chyba a Od testů upuštěno, pokud je nenulový Zbývající čas na subzáložce Plán. Jedná se totiž o konečné stavy, ve kterých by neměl zůstávat žádný zbývající plánovaný čas.

Hodnoty stavu dokumentace lze přepínat pouze ručně ve funkci Oprava. Zaevidování nového následného požadavku k dané dokumentaci, tj. požadavku s odkazem na tuto dokumentaci jakožto zdrojovou, nijak stav dokumentace automaticky nemění.
Ověřeno dne Datum otestování správnosti dané dokumentace. Má-li předchozí položka Stav hodnotu Netestováno, pak je datum ověření nevyplněné a položka není k dispozici k editaci. Je-li stav změněn na jiný než Netestováno, datum ověření se zpřístupní a předvyplní se aktuálním datumem.
Priorita

K zobrazované zde needitovatelné Prioritě verze lze zadat ještě prioritu, s jakou je třeba záznam zpracovat. Nižší číslo znamená vyšší prioritu.

Podrobněji viz popis u položky Priorita verze.
Nadpis Stručný popis charakterizující obsah dokumentace. Objevuje se v seznamu záznamů dokumentace, čili pro snazší orientaci by měl být co nejvýstižnější. Nepovinná položka.
Témata

Zkratka tématu, ke kterému patří záznam dokumentace. Může jich být i více, v tom případě jsou odděleny čárkou (bez mezery). Nepovinná položka.

Pro jednodušší editaci je možné přidávat a odebírat témata hromadně pomocí funkce hromadné opravy.
Tester Pracovník, kterému je přidělena dokumentace k otestování. Vybírá se ze seznamu uživatelů. Nepovinná položka.
Vazba na help Označení, zda daná dokumentace má vazbu na help či nikoliv, tj. zda je třeba ji promítnout do stávajícího helpu.
Autor helpu Pracovník, kterému je přidělen záznam k zapracování do helpu.
Zdrojový požadavek

Funkční tlačítko pro nastavení odkazu na zdrojový požadavek. Jde o tlačítko s volbou: Přidat odkaz na nějaký zdrojový požadavek nebo tento odpojit, tj. zrušit odkaz na dosud svázaný zdr. požadavek. K dohledání odkazovaného požadavku se nabídne Průvodce výběrem dokladu. Přidání vazby na požadavek ovlivní stav tohoto požadavku, tj. způsobí automatickou změnu stavu požadavku na hodnotu Hotovo bez ohledu na jeho stav předchozí (pokud to lze z hlediska zbývajícího plánovaného času). Nepovinná položka.

Odpojení požadavku od příslušné dokumentace již stav požadavku nemění. Tj. pozor na opravy: Pokud např. omylem připojíte požadavek CH1, jeho stav se může automaticky přepnout do stavu Hotovo. Potom opravíte dokumentaci a připojíte správný požadavek CH2. Po uložení se požadavek Ch1 osamostatní, ale jeho stav zůstává neměnný, tj. stále ve stavu Hotovo. Pokud tento stav není oprávněný, tj. požadavek CH1 již nemá žádnou jinou následnou dokumentaci, měli byste jej opravit a jeho stav změnit na původní hodnotu.
Zdrojová dokumentace Funkční tlačítko pro nastavení odkazu na zdrojovou dokumentaci. Jde o tlačítko s volbou: Přidat odkaz na nějakou zdrojovou dokumentaci nebo tuto odpojit, tj. zrušit odkaz na dosud svázanou zdr. dokumentaci. K dohledání odkazované dokumentace se nabídne Průvodce výběrem dokladu. Přidání vazby na jinou dokumentaci či zrušení této vazby nijak neovlivňuje stav odkazované dokumentace. Nepovinná položka.
Automaticky aktualizovat zdrojový požadavek Je-li zatrženo, pak se po uložení dokumentace, která je tvořena ke zdrojovému požadavku, nastaví stav požadavku automaticky na Hotovo, pokud to lze s ohledem na plánované časy - viz popis položky stav u záznamů požadavků. Nastavení se pamatuje na uživatele.

Opravy:

Opravovat lze bez omezení všechny položky, kromě řady dokladů a období.

Subzáložka Obsah

Na subzáložce je uveden vlastní obsah vývojové dokumentace. V horní části je v položce Nadpis uveden nadpis z hlavičky dokladu. K dispozici jsou posuvníky pro listování v delších popisech.

Název Popis
Popis Vlastní obsah dokumentace, tj. její podrobný popis. Nepovinná položka.
Ke zveřejnění Stručné shrnutí úpravy provedené danou dokumentací. Je-li vyplněna, použije se jako text informace ke zveřejnění uživatelům.
Souvisí s Další specifikace obsahu dokumentace. Nepovinná položka.

Subzáložka Plán

Subzáložka obsahuje položky pro evidenci času potřebného ke zpracování daného úkolu. Zmíněné položky slouží k lepším odhadům časové náročnosti potřebné k dokončení vybrané skupiny záznamů a následnému vyhodnocování plnění plánů. Položky jsou na sobě časově závislé.

V horní části subzáložky jsou evidovány položky:

Název Popis
Odhadovaný čas Čas, který řešitel odhaduje na zpracování dané dokumentace. Pokud už byla zadána nenulová hodnota, nelze položku při opravě záznamu editovat (aby nedocházelo ke zpětným zkreslováním plánů).
Strávený čas Čas, který řešitel zpracováním skutečně strávil. Zde needitovatelná položka. Plní se automaticky součtem strávených časů ze záznamů evidence časů zadaných k dané dokumentaci požadavku. Viz možnosti zadání nového záznamu evidence času.
Zbývající čas Automaticky se počítá podle odhadovaného a stráveného času. Je-li daný úkol dokončen, zadejte do položky nulu, čímž se nastaví stav dokončení na 100%. Nulu zadejte i v případě, že daný úkol nebude vůbec realizován (byl zamítnut apod.), aby nenulový zbývají čas nepříznivě nezkresloval časové odhady. Editovatelná položka. Zbývající čas může být aktualizován také prostřednictvím položky Zbývající čas záznamů evidence času.
Stav dokončení Procentuální vyjádření stavu dokončení vypočtené z předchozích položek.
Spotřeba času Procentuální vyjádření spotřebovaného času vypočtené z předchozích položek.
Data jsou platná k Zobrazuje datum, k němuž naposledy byla provedena automatická aktualizace zobrazovaných hodnot (nebere v potaz datum případných oprav provedených ručně v rámci funkce Opravit). Jedná se vlastně o datum datumově nejmladšího záznamu evidence času.

Ve spodní části subzáložky je zobrazen needitovatelný seznam dosud zadaných záznamů evidence času k aktuálnímu požadavku. Význam jednotlivých položek vyplývá z jejich názvu nebo z jejich popisu v záložce Detail agendy Evidence času.

Subzáložka Formuláře

Subzáložka je k dispozici pouze, je-li v menu Nastavení aktuálně zatržena volba pro zobrazení uživatelských formulářů. Umožňuje vybírat si z nadefinovaných uživatelských vstupních formulářů a zobrazovat a zadávat si skrz ně potom jednotlivé údaje.

Pravidla pro použití této záložky jsou pro všechny agendy, ve kterých se může vyskytnout, společná a byla podrobně popsána v kap. Záložka Formuláře - obecně.

Zobrazení seznamu v Detailu

V některé části této záložky může být zobrazen Seznam (Panel pro zobrazení seznamu na jiných záložkách), tedy záznamy ze záložky seznam (podrobněji viz Společné prvky v dokladových agendách - záložka Detail).

Zobrazení seznamu závisí na aktuálním nastavení v menu Nastavení pro danou agendu a přihlášeného uživatele.

Funkce k záložce Detail v této agendě:

Podmnožina funkcí obsažených v záložce Seznam.

V editačním režimu platí zásady platné pro editaci záznamů v knihách. K dispozici jsou standardní funkce pro režim editace plus další funkce, přičemž po uložení záznamu v závislosti na jeho údajích může dojít k vyvolání nějaké další automatické akce, viz akce volané po uložení záznamu.

Další obsažené funkce:

Název Kl. Doplňující popis:
Zdr. požadavek -

Zobrazí zdrojový požadavek k aktuálnímu záznamu dokumentace.

Jedná se o funkční tlačítko s volbou:

  • otevřít zde - otevře agendu požadavků a to "přes" právě otevřenou agendu dokumentace
  • otevřít samostatně - otevře agendu požadavků a to samostatně.

Podle této volby funkce vyvolá agendu Požadavky a otevře ji "přes" právě otevřenou agendu Vývojové dokumentace anebo samostatně, ale s tím, že takto odtud vyvolaná agenda Požadavky se otevře rovnou s přednastaveným omezením, tzv. červeným omezením, a to za zdrojový požadavek jen k aktuálnímu záznamu dokumentace.

Svázaný zdrojový požadavek k aktuálnímu záznamu dokumentace může existovat maximálně jeden.

Toto červené omezení však můžete v záložce Omezení standardně zrušit (vyčistit) a získat záznamy podle libovolného jiného omezení, nebo zcela bez omezení.

Zdrojový požadavek k aktuální dokumentaci můžete též prohlížet v záložce Zdrojový požadavek.
Zdr. dokum. -

Zobrazí zdrojovou dokumentaci k aktuálnímu záznamu dokumentace.

Jedná se o funkční tlačítko s volbou:

  • otevřít zde - otevře znovu agendu Vývojové dokumentace a to "přes" právě otevřenou agendu dokumentace
  • otevřít samostatně - otevře znovu agendu Vývojové dokumentace a to samostatně.

Podle této volby funkce vyvolá znovu agendu Vývojové dokumentace a otevře ji "přes" právě otevřenou agendu Vývojové dokumentace anebo samostatně, ale s tím, že takto odtud vyvolaná agenda Vývojové dokumentace se otevře rovnou s přednastaveným omezením, tzv. červeným omezením, a to za zdrojovou dokumentaci jen k aktuálnímu záznamu dokumentace.

Svázaná zdrojová dokumentace k aktuálnímu záznamu dokumentace může existovat maximálně jedna.

Toto červené omezení však můžete v záložce Omezení standardně zrušit (vyčistit) a získat záznamy podle libovolného jiného omezení, nebo zcela bez omezení.

Zdrojovou dokumentaci k aktuální dokumentaci můžete též prohlížet v záložce Zdrojová dokumentace.
Vlož datum/uživatele

ctrl+Q

Vloží do textu zadávaného záznamu aktuální datum, čas a identifikaci aktuálně přihlášeného uživatele. Funkce je k dispozici pouze tehdy, stojí-li fokus aktuálně v položce Popis nebo Souvisí s, viz výše. Je k dispozici pouze v editačním režimu.