Page tree
Skip to end of metadata
Go to start of metadata

Katalog Aplikacji umożliwia edytowanie dokumentacji użytkownika dla aplikacji, wersji i instancji w formie wiki. Prawo do tworzenia nowych wersji dokumentacji ma każdy zalogowany użytkownik KA. Edycje wykonywane przez użytkowników posiadających uprawnienia administracyjne do danej aplikacji są automatycznie zatwierdzane i ustawiane jako aktualne wersje. Pozostałe edycje muszą zostać zweryfikowane przez odpowiedniego administratora. Przejście do widoku zarządzania dokumentacją następuje poprzez wybranie opcji "Zarządzanie dokumentacją" z menu "Zarządzaj" na prawo od nazwy aplikacji.

Lista wersji dokumentacji

Prezentuje wszyskie utworzone przez użytkowników wersje dokumentacji, ich daty powstania, autorów edycji oraz aktualny stan. Wersja dokumentacji może znajdować się w jednym z trzech stanów:

  • oczekująca - nie została jeszcze oceniona przez administratora, oczekuje na weryfikację i zatwierdzenie bądź odrzucenie,
  • zatwierdzona - została zaakceptowana przez administratora. Najnowsza zatwierdzona wersja jest wersją aktualną - wyświetlaną na stronie aplikacji,
  • odrzucona - administrator uznał, że zmiany wprowadzone w tej wersji nie zostaną opublikowane. Taka wersja nie będzie widoczna również w ekranie edycji (tam wyświetlana jest najnowsza oczekująca bądź zatwierdzona wersja).

Administrator ma możliwość odrzucenia najnowszej nieodrzuconej wersji dokumentacji. Każda edycja jest oparta o bezpośrednio poprzedzającą ją wersję, więc jeśli administrator uzna, że starsza edycja powinna zostać odrzucona, to musi odrzucić również wszystkie późniejsze wersje, albo ręcznie usunąć niechciane zmiany (opis tej operacji znajduje się w kolejnym rozdziale). Podobnie zatwierdzać można tylko najnowszą nieodrzuconą wersję. W przypadku omyłkowego odrzucenia wersji możliwe jest jej zatwierdzenie, o ile nie istnieje nowsza nieodrzucona wersja. Podobnie zatwierdzoną wersję można odrzucić.

Kliknięcie daty edycji spowoduje otworzenie strony z daną wersją dokumentacji, na której również znajdują się linki umożliwiające zmianę jej stanu.

Strona wersji dokumentacji

Prezentuje treść zapisanej przez użytkownika wersji oraz jej szczegóły (datę edycji, autora, aktualny status). Ponadto prezentowane są zmiany w stosunku do poprzednich wersji - kolorem zielonym oznaczono elementy dodane w ramach edycji, czerwonym - elementy usunięte. Możliwe jest wybranie jednego z trzech trybów prezentacji tych zmian:

  • zmiany od zatwierdzonej wersji - różnice w stosunku do aktualnej zatwierdzonej wersji (wyświetlanej na stronie aplikacji),
  • zmiany od poprzedniej wersji - różnice w stosunku do bezpośrednio poprzedniej wersji, niezależnie od jej stanu,
  • ukryj zmiany - wyświetlenie wersji zapisanej przez użytkownika bez prezentowania zmian.

Pod tekstem dokumentacji znajdują się linki umożliwiające przechodzenie do późniejszych i wcześniejszych wersji (o ile takie istnieją). Dostępne są też przyciski:

  • "Edytuj i zatwierdź" - przejście do trybu zatwierdzania wersji, opisane poniżej,
  • "Zatwierdź" - zatwierdzenie wersji bez wprowadzania dodatkowych zmian,
  • "Odrzuć" - odrzucenie zmian wprowadzonych w tej wersji.

Zatwierdzanie dokumentacji

Widok zatwierdzania dokumentacji umożliwia wybranie, które ze zmian wprowadzonych przez użytkownika mają pojawić się w dokumentacji wyświetlanej na stronie aplikacji. Prezentowany jest tekst wersji z zaznaczonymi zmianami w stosunku do aktualnej wersji dokumentacji. Każdy z fragmentów oznaczonych na zielono lub czerwono można zatwierdzić lub odrzucić - w tym celu należy na nim kliknąć i wybrać opcję "Zatwierdź" lub "Odrzuć". Zatwierdzenie fragmentu dodanego przez użytkownika (a więc zaznaczonego na zielono) będzie oznaczać umieszczenie go w docelowej wersji, odrzucenie - usunięcie tego fragmentu. Zatwierdzenie fragmentu usuniętego (kolor czerwony) oznacza, że nie znajdzie się on w docelowej wersji, odrzucenie - pozostawienie go. Fragmenty, które w wyniku decyzji administratora NIE pojawią się w docelowej dokumentacji są wyszarzone, niemniej w każdej chwili możliwa jest zmiana decycji i ponowne oznaczenie zmiany jako zatwierdzona lub odrzucona.

Po zatwierdzeniu lub odrzuceniu poszczególnych zmian możliwe jest zatwierdzenie wersji (przycisk "Zapisz i zatwierdź") - spowoduje to utworzenie nowej wersji dokumentacji, która automatycznie zostanie oznaczona jako zatwierdzona. Administrator może też przejść do trybu edycji ręcznej - tekst dokumentacji (z uwzględnieniem dotychczasowych decyzji administratora odnoście poszczególnych fragmentów) można wtedy zmienić za pomocą standardowego edytora. Jest to ostatni etap wprowadzania zmian - po zakończeniu edycji należy kliknąć przycisk "Zapisz i zatwierdź".

  • No labels